symcalc 0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab527844085471beb0057a27b9538997e055c41331a4d72791a3017ab3b0babb
-  data.tar.gz: 81d11403ccf1a3ebb81cc4af3ac952161f11d7213dbf9be1f0368db48f1380ba
+  metadata.gz: e57698a5da7f300ef21e41ecc27fe2e0be86186213daa9b3736c8603b005b9fa
+  data.tar.gz: b108fddfb4a9ad62327f2b1161e2557b9c4c0fc132403e5bea08658470bc903c
 SHA512:
-  metadata.gz: eea3871f2af7102b5c7718153d681efaf6ddc8761afdcacb1e65946f236f23e57e86994937c6937d9a773bc3bd6c701dcd7ecf36b0835a5446b39d7f0ec8dbab
-  data.tar.gz: a75450e788eebba783db6057055f8b2142df9e6a6663c2d97f6ce5b79267efde188d081b8f09d0c3b538758811aff6a4a638f66fd99e8f2d7487a94e62f1a799
+  metadata.gz: d811d18c96abea729176dd8b918c9c75de4e183706c7b7912d049efd2cfd028321d923cda9149ba443772ef21073aba693476a824b777c758b65f89c9128adf5
+  data.tar.gz: d56da69a5f839a0dd2c7efba40f85f4ca78980219109fad8228182b3cab2db48f7515a1be49910c19d9c4785ab187ad95618c1aaa15e8fa64560dade60b234a3

data/lib/symcalc.rb

@@ -1,12 +1,25 @@
-#
-#
-# Copyright (c) 2023 Kyryl Shyshko
+# Copyright (c) 2024 Kyryl Shyshko
 # 
-# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License
-# To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/legalcode.en, or read LICENSE.txt
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# SymCalc auto simplify option
+if !$SYMCALC_AUTO_SIMPLIFY
+	$SYMCALC_AUTO_SIMPLIFY = true
+end
 
+# The SymCalc module
+module SymCalc
 
 class Equation
 	
@@ -14,8 +27,12 @@ class Equation
 		self.display()
 	end
 	
-	def inspect
-		self.display()
+	# def inspect
+	# 	self.display()
+	# end
+	
+	def display
+		""
 	end
 	
 	def coerce(other)
@@ -23,23 +40,43 @@ class Equation
 	end
 
 	def *(eq)
-		return Multiplication.new(self, to_equation(eq))
+		eq = Multiplication.new([self, to_equation(eq)])
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
 	end
 	
 	def /(eq)
-		return Division.new(self, to_equation(eq))
+		eq = Division.new(self, to_equation(eq))
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
 	end
 	
 	def +(eq)
-		return Sum.new(self, to_equation(eq))
+		eq = Sum.new([self, to_equation(eq)])
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
+	end
+	
+	def -@()
+		eq = Negate.new(self)
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
 	end
 	
 	def -(eq)
-		return Subtraction.new(self, to_equation(eq))
+		eq = Sum.new([self, Negate.new(to_equation(eq))])
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
 	end
 	
 	def **(eq)
-		return Power.new(self, to_equation(eq))
+		eq = Power.new(self, to_equation(eq))
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
+	end
+	
+	def __derivative__(variable: nil)
+		raise "No derivative function implemented for this object"
 	end
 	
 	# Calculate the derivative of the given function
@@ -57,17 +94,19 @@ class Equation
 	#
 	def derivative(order: 1, variable: nil)
 		if variable == nil && self.all_variables.size < 2
-			fx = self
+			fx = self.simplify
 			order.times do
-				fx = fx.simplify.__derivative__.simplify
+				fx = fx.__derivative__
+				fx = fx.simplify if $SYMCALC_AUTO_SIMPLIFY
 			end
 			return fx
 		elsif variable == nil && self.all_variables.size > 1
 			raise "Expected a variable as input for a #{self.all_variables.size}-dimensional function"
 		else
-			fx = self
+			fx = self.simplify
 			order.times do 
-				fx = fx.simplify.__derivative__(variable: variable).simplify
+				fx = fx.__derivative__(variable: variable)
+				fx = fx.simplify if $SYMCALC_AUTO_SIMPLIFY
 			end
 			return fx
 		end
@@ -81,100 +120,12 @@ class Equation
 	# Accepts no arguments
 	#
 	def simplify
-		
-		simplified = self.__simplify__
-		
-		if [Multiplication, Division].include? simplified.class
-			m_els = simplified.__get_m_elements__(Hash.new)
-			
-			if m_els.keys.size == 0
-				return EquationValue.new(0)
-			elsif m_els.keys.size == 1
-				part = m_els.keys[0]
-				power = to_equation(m_els.values[0])
-				if part == "exp"
-					part = (power == to_equation(1)) ? BasicVars::E : Exp.new(power)
-				else
-					part = part ** power if power != to_equation(1)
-				end
-				return part
-			else			
-				els_index = 0
-				eq = nil
-				
-				coeff = to_equation(1)
-					
-				m_els.size.times do |els_index|
-					base = m_els.keys[els_index]
-					power = m_els[base]
-					
-					base = base.simplify if base.is_a? Equation
-					power = power.simplify if power.is_a? Equation
-					
-					base = to_equation base if base != "exp"
-					power = to_equation power
-					
-					if power == to_equation(0)
-						next
-					end
-					
-					if base.is_a?(EquationValue) && power.is_a?(EquationValue)
-						case power
-						when EquationValue.new(1)
-							coeff *= base
-						else
-							coeff *= base ** power
-						end
-						next
-					end
-					
-					if base == "exp"
-						case power
-						when to_equation(1)
-							part = BasicVars::E
-						else
-							part = Exp.new(power)
-						end
-					else
-						case power
-						when to_equation(1)
-							part = base
-						else
-							part = base ** power
-						end
-					end
-					
-					if eq == nil
-						eq = part
-					else
-						eq *= part
-					end
-					
-				end
-				
-				# coeff = to_equation(coeff.eval({}))
-				coeff = coeff.__simplify__
-				
-	
-				if coeff == to_equation(1)
-					eq = eq
-				elsif coeff == to_equation(0)
-					eq = to_equation(0)
-				elsif eq == nil
-					eq = coeff
-				else
-					eq = coeff * eq
-				end
-				
-				return eq
-			end
-			
-		else
-			return simplified
-		end
-		
+		self.__simplify__
 	end
 	
+	def __eval__(var_hash)
+		raise "__eval__ method not implemented for this class"
+	end
 	
 	# Evaluates the function at given variable values
 	# Accepts the hash of variables and their values to evalualte the function
@@ -184,28 +135,42 @@ class Equation
 	# fx = x ** 2
 	# puts fx.eval(x: 3)
 	#
-	def eval(var_hash)
-		# begin
-			if var_hash.values.size == 0
-				return self.__eval__(Hash.new)
-			elsif !var_hash.values[0].is_a?(Array)
-				return self.__eval__ var_hash
-			elsif var_hash.values[0].is_a? Array
-				computed = []
-				var_hash.values[0].size.times do |i|
-					hash = var_hash.map {|k, v| [k, v[i]]}.to_h
-					computed << self.__eval__(hash)
-				end
-				return computed
+	def eval(var_hash = nil)
+		var_hash = Hash.new if !var_hash
+		if var_hash.values.size == 0
+			result = self.__eval__(var_hash)
+		elsif !var_hash.values[0].is_a?(Array)
+			result = self.__eval__ var_hash
+		elsif var_hash.values[0].is_a? Array
+			result = []
+			var_hash.values[0].size.times do |i|
+				hash = var_hash.map {|k, v| [k, v[i]]}.to_h
+				result << self.__eval__(hash)
 			end
-		# rescue
-		# 	puts "Could not compute the value. Skipping"
-		# 	return nil
-		# end
+		end
+		result
 	end
 	
 	
 	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return self
+	end
+	
+	# Returns an equation with an expression substituted for the replacement
+	#
+	# Example:
+	# a = SymCalc.var("a")
+	# f = a ** 2
+	# x = SymCalc.var("x")
+	# puts f.sub(a, 3 * x) # => (3 * x) ** 2
+	# 
+	def sub original, replacement
+		eq = self.__sub__(original, replacement)
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
+	end
 	
 end
 
@@ -232,7 +197,11 @@ class EquationValue < Equation
 	end
 	
 	def __eval__ var_hash
-		return @value.to_f
+		if @value.is_a? Integer
+			return @value.to_f
+		else
+			return @value
+		end
 	end
 	
 	def __derivative__ variable: nil
@@ -240,38 +209,52 @@ class EquationValue < Equation
 	end
 	
 	def ==(value)
-		if value.is_a? EquationValue
-			return @value == value.value
-		else
-			return false
-		end
+		@value == value
 	end
 	
-	def hash
-		1111000 + @value
+	def all_variables
+		[]
 	end
 	
-	def eql? obj
-		return false if !obj.is_a? EquationValue
-		return obj.value == @value
+end
+
+# Implements the Constant class. Behaves like EquationValue when evaluating and like Variable when printing
+class Constant < Equation
+
+	attr_accessor :value, :name
+	
+	def initialize(name, value)
+		@value = value
+		@name = name
+	end
+	
+	def display
+		return @name
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? self
-			var_hash[self] = var_hash[self] + 1
+	def __eval__ var_hash
+		if @value.is_a? Integer
+			return @value.to_f
 		else
-			var_hash[self] = 1
+			return @value
 		end
-		return var_hash
 	end
 	
+	def __derivative__ variable: nil
+		return EquationValue.new 0
+	end
+	
+	def ==(value)
+		@value == value
+	end
 	
 	def all_variables
 		[]
 	end
-	
+
 end
 
+
 # Implements the Variable class
 class Variable < Equation
 	
@@ -284,20 +267,16 @@ class Variable < Equation
 	# fx = x ** 2
 	# fx.eval  # => 25
 	#
-	def initialize name, fixed_value = nil
+	def initialize name
 		@name = name
-		@fixed_value = fixed_value
 	end
 	
 	def display
 		return @name
 	end
 	
-	
 	def __eval__ var_hash
-		if @fixed_value
-			return @fixed_value
-		elsif var_hash.keys.include?(@name.to_sym) or var_hash.keys.include?(@name.to_s)
+		if var_hash.keys.include?(@name.to_sym) or var_hash.keys.include?(@name.to_s)
 			return (var_hash[@name.to_sym] or var_hash[@name.to_s])
 		else
 			raise "No value provided for #{@name.to_s} in eval"
@@ -313,13 +292,8 @@ class Variable < Equation
 		end
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? self
-			var_hash[self] += 1
-		else
-			var_hash[self] = 1
-		end
-		return var_hash
+	def __simplify__
+		self
 	end
 	
 	def all_variables
@@ -327,160 +301,183 @@ class Variable < Equation
 	end
 end
 
-# Basic variables that are already implemented in SymCalc and have fixed values
-module BasicVars
-	
-	E = Variable.new "e", Math::E
-
-end
 
 # Implements sum operations in SymCalc
 class Sum < Equation
-	def initialize lside, rside
-		@lside = lside
-		@rside = rside
+	def initialize elements
+		@elements = []
+		elements.each do |eq|
+			if eq.is_a? Sum
+				@elements += eq.instance_variable_get(:@elements)
+			else
+				@elements << eq
+			end
+		end
 	end
 	
 	def display
-		return "(#{@lside.display}) + (#{@rside.display})"
+		return @elements.map{|eq| "(#{eq.display})"}.join(" + ")
 	end
 	
 	def __eval__ var_hash
-		return @lside.eval(var_hash) + @rside.eval(var_hash)
+		return @elements.map{|eq| eq.eval(var_hash)}.sum
 	end
 	
 	def __derivative__ variable: nil
-		return @lside.derivative(variable: variable) + @rside.derivative(variable: variable)
+		return Sum.new(@elements.map{|eq| eq.__derivative__(variable: variable)})
 	end
 	
 	def __simplify__
-		@lside = @lside.__simplify__
-		@rside = @rside.__simplify__
-		if (@lside.is_a? EquationValue) && (@rside.is_a? EquationValue)
-			return EquationValue.new((@lside + @rside).eval({}))
-		elsif @lside == EquationValue.new(0)
-			return @rside
-		elsif @rside == EquationValue.new(0)
-			return @lside
-		else
-			return self
+		simplified = @elements.map{|eq| eq.__simplify__}		
+		
+		simplified.filter! do |el|
+			if el.is_a? EquationValue
+				next if el.value == 0
+			end
+			true
 		end
-	end
-	
-	def __get_m_elements__ el_hash
-		if el_hash.keys.include? self
-			el_hash[self] += 1
-		else
-			el_hash[self] = 1
+
+		if simplified.size == 1
+			return simplified[0]
 		end
-		return el_hash
+		
+		return Sum.new(simplified)
 	end
 	
 	def all_variables
-		return (@lside.all_variables + @rside.all_variables).uniq
+		return @elements.map{|eq| eq.all_variables }.flatten.uniq
 	end
 	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		
+		return Sum.new(@elements.map{|eq| eq.__sub__(original, replacement)})
+	end
 end
 
 # Implements the subtraction operation in SymCalc
-class Subtraction < Equation
-	def initialize lside, rside
-		@lside = lside
-		@rside = rside
+class Negate < Equation
+	def initialize eq
+		@eq = eq
 	end
 	
 	def display
-		return "(#{@lside.display}) - (#{@rside.display})"
+		return "-(#{@eq.display})"
 	end
 	
 	def __eval__ var_hash
-		return @lside.eval(var_hash) - @rside.eval(var_hash)
+		return -@eq.eval(var_hash)
 	end
 	
 	def __derivative__ variable: nil
-		return @lside.derivative(variable: variable) - @rside.derivative(variable: variable)
-	end
-
-	def __get_m_elements__ el_hash
-		if el_hash.keys.include? self
-			el_hash[self] += 1
-		else
-			el_hash[self] = 1
-		end
-		return el_hash
+		return -@eq.__derivative__(variable: variable)
 	end
 	
 	def __simplify__
-		@lside = @lside.__simplify__
-		@rside = @rside.__simplify__
-		
-		if (@lside.is_a? EquationValue) && (@rside.is_a? EquationValue)
-			return EquationValue.new((@lside - @rside).eval(Hash.new))
-		elsif @rside == EquationValue.new(0)
-			return @lside
-		elsif @lside == EquationValue.new(0)
-			return -1 * @rside
-		elsif @lside == @rside
-			return EquationValue.new(0)
-		else
-			return self
-		end
+		return Negate.new(@eq.__simplify__)
 	end
 
 	def all_variables
-		return (@lside.all_variables + @rside.all_variables).uniq
+		return @eq.all_variables
+	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Negate.new(@eq.__sub__(original, replacement))
 	end
 end
 
 # Implements the multiplication operation in SymCalc
 class Multiplication < Equation
-	def initialize lside, rside
-		@lside = lside
-		@rside = rside
+	def initialize elements
+		@elements = []
+		elements.each do |el|
+			if el.is_a? Multiplication
+				@elements += el.instance_variable_get(:@elements)
+			else
+				@elements << el
+			end
+		end
 	end
 	
 	def display
-		return "(#{@lside.display}) * (#{@rside.display})"
+		return @elements.map{|el| "(#{el.display})"}.join(" * ")
 	end
 	
 	def __eval__ var_hash
-		return @lside.eval(var_hash) * @rside.eval(var_hash)
+		result = 1
+		@elements.each do |el|
+			result *= el.__eval__(var_hash)
+		end
+		result
 	end
 	
 	def __derivative__ variable: nil
-		return @lside.derivative(variable: variable) * @rside + @lside * @rside.derivative(variable: variable)
+		
+		sum_of_mults_arr = []
+		
+		@elements.size.times do |element_index|
+			mult_arr = []
+			
+			
+			mult_arr << @elements[element_index].__derivative__(variable: variable)
+			
+			@elements.size.times do |mult_el_index|
+				if element_index == mult_el_index
+					next
+				end
+				mult_arr << @elements[mult_el_index]
+			end
+			
+			sum_of_mults_arr << Multiplication.new(mult_arr)
+		end
+		
+		return Sum.new(sum_of_mults_arr)
 	end
 	
 	def __simplify__
-		@lside = @lside.__simplify__
-		@rside = @rside.__simplify__
 		
-		if (@lside == EquationValue.new(0)) || (@rside == EquationValue.new(0))
-			return EquationValue.new 0
-		elsif @lside == EquationValue.new(1)
-			return @rside
-		elsif @rside == EquationValue.new(1)
-			return @lside
-		elsif @rside.is_a? EquationValue and @lside.is_a? EquationValue
-			calculated = @rside.value * @lside.value
-			if calculated.to_s.size <= 6
-				return to_equation(calculated)
+		numbers = []
+		simplified = []
+		
+		@elements.each do |eq|
+			s_eq = eq.__simplify__()
+			
+			if s_eq.is_a? EquationValue
+				if s_eq.value == 0
+					return EquationValue.new(0)
+				elsif s_eq.value == 1
+					next
+				else
+					numbers << s_eq.value
+				end
 			else
-				return self
-			end
-		else 
-			return self
+				simplified << s_eq
+			end			
+		end
+		
+
+		coeff = 1
+		numbers.each {|n| coeff *= n}
+		
+		if coeff != 1
+			simplified.insert 0, EquationValue.new(coeff)
+		end
+		
+		if simplified.size == 1
+			return simplified[0]
 		end
+		
+		return Multiplication.new(simplified)
 	end
 	
-	def __get_m_elements__ el_hash
-		el_hash = @lside.__get_m_elements__(el_hash)
-		el_hash = @rside.__get_m_elements__(el_hash)
-		return el_hash
+	def all_variables
+		return @elements.map{|el| el.all_variables}.flatten.uniq
 	end
 	
-	def all_variables
-		return (@lside.all_variables + @rside.all_variables).uniq
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Multiplication.new(@elements.map{|el| el.__sub__(original, replacement)})
 	end
 end
 
@@ -503,8 +500,8 @@ class Division < Equation
 	end
 	
 	def __derivative__ variable: nil
-		return (@lside * @rside ** (-1)).derivative(variable: variable)
-		# return (@lside.derivative * @rside - @lside * @rside.derivative) / (@rside ** 2)
+		# return (@lside * @rside ** (-1)).derivative(variable: variable)
+		return (@lside.derivative * @rside - @lside * @rside.derivative) / (@rside ** 2)
 	end
 	
 	def __simplify__
@@ -525,23 +522,15 @@ class Division < Equation
 		end
 	end
 	
-	def __get_m_elements__ el_hash
-		mult = @lside.__get_m_elements__(el_hash)
-		div = @rside.__get_m_elements__({})
-		div.each do |k, v|
-			if mult.keys.include? k
-				mult[k] -= v
-			else
-				mult[k] = -v
-			end
-		end
-		return mult
-	end
-	
 	
 	def all_variables
 		return (@lside.all_variables + @rside.all_variables).uniq
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return @lside.__sub__(original, replacement) / @rside.__sub__(original, replacement)
+	end
 end
 
 
@@ -584,18 +573,14 @@ class Exp < Equation
 		end
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? "exp"
-			var_hash["exp"] += @power
-		else
-			var_hash["exp"] = @power
-		end
-		return var_hash
-	end
-	
 	def all_variables
 		return @power.all_variables
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Exp.new(@power.__sub__(original, replacement))
+	end
 end
 
 
@@ -631,37 +616,29 @@ class Power < Equation
 			return false
 		end
 	end
-	
-	def __get_m_elements__ var_hash
-		elms = @base.__get_m_elements__({})
-		elms.each do |k, v|
-			if var_hash.keys.include? k
-				var_hash[k] += v * @power
-			else
-				var_hash[k] = @power
-			end
-		end
-		return var_hash
-	end
-	
+		
 	def __simplify__
 		
-		base = @base.simplify
-		power = @power.simplify
+		s_base = @base.__simplify__
+		s_power = @power.__simplify__
 		
-		if power == EquationValue.new(0)
+		if s_power == EquationValue.new(0)
 			return EquationValue.new(1)
-		elsif power == EquationValue.new(1)
-			return base
-		elsif base.is_a?(EquationValue) && power.is_a?(EquationValue)
-			computed = base.value ** power.value
+		elsif s_power == EquationValue.new(1)
+			return s_base
+		elsif s_base.is_a?(EquationValue) && s_power.is_a?(EquationValue)
+			computed = s_base.value ** s_power.value
 			if computed.to_s.size <= 6
 				return to_equation(computed)
 			else
-				return base ** power
+				return s_base ** power
 			end
+		elsif s_base.is_a?(Power)
+			new_base = s_base.base
+			new_power = s_base.power * s_power
+			return (new_base ** new_power).__simplify__
 		else
-			return base ** power
+			return Power.new(s_base, s_power)
 		end
 		
 	end
@@ -669,6 +646,11 @@ class Power < Equation
 	def all_variables
 		return (@base.all_variables + @power.all_variables).uniq
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return @base.__sub__(original, replacement) ** @power.__sub__(original, replacement)
+	end
 end
 
 # Implements the sin operation in SymCalc
@@ -689,18 +671,18 @@ class Sin < Equation
 		return Cos.new(@eq) * @eq.derivative(variable: variable)
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? self
-			var_hash[self] += 1
-		else
-			var_hash[self] = 1
-		end
-		return var_hash
+	def __simplify__
+		return Sin.new(@eq.__simplify__)
 	end
 	
 	def all_variables
 		return @eq.all_variables
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Sin.new(@eq.__sub__(original, replacement))
+	end
 end
 
 # Implements the cos operation in SymCalc
@@ -721,18 +703,18 @@ class Cos < Equation
 		return -1 * Sin.new(@eq) * @eq.derivative(variable: variable)
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? self
-			var_hash[self] += 1
-		else
-			var_hash[self] = 1
-		end
-		return var_hash
+	def __simplify__
+		return Cos.new(@eq.__simplify__)
 	end
 	
 	def all_variables
 		return @eq.all_variables
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Cos.new(@eq.__sub__(original, replacement))
+	end
 end
 
 
@@ -757,18 +739,18 @@ class Ln < Equation
 		return 1 / @eq * @eq.derivative(variable: variable)
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? self
-			var_hash[self] += 1
-		else
-			var_hash[self] = 1
-		end
-		return var_hash
+	def __simplify__
+		return Ln.new(@eq.__simplify__)
 	end
-	
+		
 	def all_variables
 		return @eq.all_variables
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Ln.new(@eq.__sub__(original, replacement))
+	end
 end
 
 # Implements the logarithm operation in SymCalc
@@ -776,7 +758,7 @@ class Log < Equation
 	
 	attr_accessor :eq, :base
 	
-	# Implements the subtraction operation in SymCalc
+	# Implements the logarithm operation in SymCalc
 	# Accepts the base and equation arguments
 	#
 	# Example:
@@ -801,53 +783,109 @@ class Log < Equation
 		return 1 / (Ln.new(@base) * @eq) * @eq.derivative(variable: variable)
 	end
 	
-	def __get_m_elements__ var_hash
-		if var_hash.keys.include? self
-			var_hash[self] += 1
-		else
-			var_hash[self] = 1
-		end
-		return var_hash
+	def __simplify__
+		return Log.new(@base.__simplify__, @eq.__simplify__)
 	end
 	
 	def all_variables
 		return (@base.all_variables + @eq.all_variables).uniq
 	end
+	
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Log.new(@base.__sub__(original, replacement), @eq.__sub__(original, replacement))
+	end
 end
 
-# The SymCalc module implemenets the standard function class creations shorter
-module SymCalc
-
-	# sin(equation) is the same as Sin.new(equation), just shorter
-	def sin(eq)
-		return Sin.new(to_equation(eq))
+# Implements the absolute value operation in SymCalc
+class Abs < Equation
+	
+	attr_accessor :eq
+	
+	def initialize eq
+		@eq = to_equation(eq)
 	end
 	
-	# cos(equation) is the same as Cos.new(equation), just shorter
-	def cos(eq)
-		return Cos.new(to_equation(eq))
+	def display
+		return "|#{@eq.display}|"
 	end
 	
-	# ln(equation) is the same as Ln.new(equation), just shorter
-	def ln(eq)
-		return Ln.new(to_equation(eq))
+	def __eval__ var_hash
+		return @eq.eval(var_hash).abs
+	end
+	
+	def __derivative__ variable: nil
+		return @eq / Abs.new(@eq) * @eq.derivative(variable: variable)
 	end
 	
-	# log(base, equation) is the same as Log.new(base, equation), just shorter
-	def log(base, eq)
-		return Log.new(to_equation(base), to_equation(eq))
+	def __simplify__
+		if @eq.is_a?(Power) && @eq.power.is_a?(EquationValue) && @eq.power.value.is_a?(Numeric) && (@eq.power.value % 2 == 0)
+			return @eq
+		end
+		self
 	end
 	
-	# exp(equation) is the same as Exp.new(equation), just shorter
-	def exp(power)
-		return Exp.new(to_equation(power))
+	def all_variables
+		return @eq.all_variables
 	end
 	
-	# var(name) is the same as Variable.new(name), just shorter
-	def var(name, fixed_value=nil)
-		Variable.new name, fixed_value
+	def __sub__ original, replacement
+		return to_equation(replacement) if self == to_equation(original)
+		return Abs.new(@eq.__sub__(original, replacement))
 	end
+end
+
+
+# Basic variables that are already implemented in SymCalc and have fixed values
+module Constants
 	
-	module_function :sin, :cos, :ln, :log, :exp, :var
+	Pi = Constant.new "pi", Math::PI
+	E = Constant.new "e", Math::E
+
+end
+
+
+
+
+# sin(equation) is the same as Sin.new(equation), just shorter
+def sin(eq)
+	return Sin.new(to_equation(eq))
+end
+
+# cos(equation) is the same as Cos.new(equation), just shorter
+def cos(eq)
+	return Cos.new(to_equation(eq))
+end
+
+# ln(equation) is the same as Ln.new(equation), just shorter
+def ln(eq)
+	return Ln.new(to_equation(eq))
+end
+
+# log(base, equation) is the same as Log.new(base, equation), just shorter
+def log(base, eq)
+	return Log.new(to_equation(base), to_equation(eq))
+end
+
+# exp(equation) is the same as Exp.new(equation), just shorter
+def exp(power)
+	return Exp.new(to_equation(power))
+end
+
+# var(name) is the same as Variable.new(name), just shorter
+def var(name)
+	Variable.new name
+end
+
+def const(name, value)
+	Constant.new name, value
+end
+
+# abs(equation) is the same as Abs.new(equation), just shorter
+def abs eq
+	return Abs.new(to_equation(eq))
+end
+
+module_function :sin, :cos, :ln, :log, :exp, :var, :abs, :const
 	
 end

metadata

@@ -1,28 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: symcalc
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 1.0.0
 platform: ruby
 authors:
 - Kyryl Shyshko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies: []
-description: SymCalc empowers developers with the ability of creating symbolic functions,
-  deriving them and evaluating them, substituting variables for numbers.
+description: 'SymCalc adds symbolic mathematics and calculus to your code. Create,
+  evaluate and differentiate mathematical functions with a single method call.
+
+  '
 email: kyryloshy@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/LICENSE.txt
 - lib/symcalc.rb
-homepage: https://rubygems.org/gems/symcalc
+homepage: https://symcalc.site/ruby
 licenses:
-- CC BY-SA 4.0
-metadata: {}
+- Apache-2.0
+metadata:
+  changelog_uri: https://symcalc.site/ruby/changelog
+  documentation_uri: https://symcalc.site/ruby/docs
+  homepage_uri: https://symcalc.site/ruby
+  source_code_uri: https://github.com/symcalc/symcalc-ruby
+  bug_tracker_uri: https://github.com/symcalc/symcalc-ruby/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -31,16 +37,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
-summary: SymCalc is a Ruby gem for symbolic mathematics that implements basic calculus
-  in code.
+summary: Symbolic mathematics and calculus in Ruby
 test_files: []

data/lib/LICENSE.txt

@@ -1,95 +0,0 @@
-Attribution-ShareAlike 4.0 International
-
-By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
-
-Section 1 – Definitions.
-
-Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
-Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
-BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses , approved by Creative Commons as essentially the equivalent of this Public License.
-Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
-Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
-Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
-License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
-Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
-Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
-Licensor means the individual(s) or entity(ies) granting rights under this Public License.
-Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
-Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
-You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
-Section 2 – Scope.
-
-License grant .
-Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
-reproduce and Share the Licensed Material, in whole or in part; and
-produce, reproduce, and Share Adapted Material.
-Exceptions and Limitations . For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
-Term . The term of this Public License is specified in Section 6(a) .
-Media and formats; technical modifications allowed . The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
-Downstream recipients .
-Offer from the Licensor – Licensed Material . Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
-Additional offer from the Licensor – Adapted Material . Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
-No downstream restrictions . You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
-No endorsement . Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i) .
-Other rights .
-Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
-Patent and trademark rights are not licensed under this Public License.
-To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
-Section 3 – License Conditions.
-
-Your exercise of the Licensed Rights is expressly made subject to the following conditions.
-
-Attribution .
-If You Share the Licensed Material (including in modified form), You must:
-
-retain the following if it is supplied by the Licensor with the Licensed Material:
-identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
-a copyright notice;
-a notice that refers to this Public License;
-a notice that refers to the disclaimer of warranties;
-a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
-indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
-indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
-You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
-If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
-ShareAlike .
-In addition to the conditions in Section 3(a) , if You Share Adapted Material You produce, the following conditions also apply.
-
-The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
-You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
-You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
-Section 4 – Sui Generis Database Rights.
-
-Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
-
-for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
-if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b) ; and
-You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
-For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
-
-Section 5 – Disclaimer of Warranties and Limitation of Liability.
-
-Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
-To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
-The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
-Section 6 – Term and Termination.
-
-This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
-Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
-
-automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
-upon express reinstatement by the Licensor.
-For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
-
-For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
-Sections 1 , 5 , 6 , 7 , and 8 survive termination of this Public License.
-Section 7 – Other Terms and Conditions.
-
-The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
-Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
-Section 8 – Interpretation.
-
-For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
-To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
-No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
-Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.