symcalc 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfa9e29e383d1a24d3545c1944efac692a2e973861548dafeeaa61b34641147
-  data.tar.gz: 5bca902b27d64a837d3908b1bd835f519f1f8f707e4dc56fd99d5b971e9821c9
+  metadata.gz: e57698a5da7f300ef21e41ecc27fe2e0be86186213daa9b3736c8603b005b9fa
+  data.tar.gz: b108fddfb4a9ad62327f2b1161e2557b9c4c0fc132403e5bea08658470bc903c
 SHA512:
-  metadata.gz: 49729eafc708ea1e59c50ad7f3c5d3a9dfd06ce21d673379e2050cc091b4ade9631d554e0d113db992f64303f5bd1f2c5ea0123a84aa36536a744d8d577d6e64
-  data.tar.gz: 7c84949657233ded9848633861fbd43963379b6fc468ef862cdb48830d2677547a1b7c8931d8e60d21356afef64cb5486229dcf29ff298af836a91b034321fcd
+  metadata.gz: d811d18c96abea729176dd8b918c9c75de4e183706c7b7912d049efd2cfd028321d923cda9149ba443772ef21073aba693476a824b777c758b65f89c9128adf5
+  data.tar.gz: d56da69a5f839a0dd2c7efba40f85f4ca78980219109fad8228182b3cab2db48f7515a1be49910c19d9c4785ab187ad95618c1aaa15e8fa64560dade60b234a3

data/lib/symcalc.rb

@@ -6,10 +6,6 @@
 #
 #     http://www.apache.org/licenses/LICENSE-2.0
 #
-# or
-#
-# read LICENSE.txt in the SymCalc lib folder
-#
 # 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.
@@ -17,14 +13,26 @@
 # limitations under the License.
 
 
+# SymCalc auto simplify option
+if !$SYMCALC_AUTO_SIMPLIFY
+	$SYMCALC_AUTO_SIMPLIFY = true
+end
+
+# The SymCalc module
+module SymCalc
+
 class Equation
 	
 	def to_s
 		self.display()
 	end
 	
-	def inspect
-		self.display()
+	# def inspect
+	# 	self.display()
+	# end
+	
+	def display
+		""
 	end
 	
 	def coerce(other)
@@ -32,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
@@ -66,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
@@ -90,98 +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 = 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
@@ -191,9 +135,10 @@ class Equation
 	# fx = x ** 2
 	# puts fx.eval(x: 3)
 	#
-	def eval(var_hash)
+	def eval(var_hash = nil)
+		var_hash = Hash.new if !var_hash
 		if var_hash.values.size == 0
-			result = self.__eval__(Hash.new)
+			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
@@ -222,8 +167,11 @@ class Equation
 	# puts f.sub(a, 3 * x) # => (3 * x) ** 2
 	# 
 	def sub original, replacement
-		self.__sub__(original, replacement).simplify
+		eq = self.__sub__(original, replacement)
+		eq = eq.simplify if $SYMCALC_AUTO_SIMPLIFY
+		eq
 	end
+	
 end
 
 # Converts the given argument into the equation type, if not already an equation
@@ -264,31 +212,49 @@ class EquationValue < Equation
 		@value == value
 	end
 	
-	def hash
-		1111000 + @value
+	def all_variables
+		[]
+	end
+	
+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 eql? obj
-		return false if !obj.is_a? EquationValue
-		return obj.value == @value
+	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
 	
@@ -301,9 +267,8 @@ 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
@@ -311,9 +276,7 @@ class Variable < Equation
 	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"
@@ -329,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
@@ -343,174 +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 @lside.__sub__(original, replacement) + @rside.__sub__(original, replacement)
+		
+		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 @lside.__sub__(original, replacement) - @rside.__sub__(original, replacement)
+		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
-	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
+		
+
+		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 all_variables
-		return (@lside.all_variables + @rside.all_variables).uniq
+		return @elements.map{|el| el.all_variables}.flatten.uniq
 	end
 	
 	def __sub__ original, replacement
 		return to_equation(replacement) if self == to_equation(original)
-		return @lside.__sub__(original, replacement) * @rside.__sub__(original, replacement)
+		return Multiplication.new(@elements.map{|el| el.__sub__(original, replacement)})
 	end
 end
 
@@ -533,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__
@@ -555,19 +522,6 @@ 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
@@ -619,15 +573,6 @@ 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
@@ -671,41 +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 base.is_a?(Power)
-			new_base = base.base
-			new_power = base.power * power
-			return (new_base ** new_power).simplify
+		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
@@ -742,15 +675,6 @@ class Sin < Equation
 		return Sin.new(@eq.__simplify__)
 	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
-	end
-	
 	def all_variables
 		return @eq.all_variables
 	end
@@ -783,15 +707,6 @@ class Cos < Equation
 		return Cos.new(@eq.__simplify__)
 	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
-	end
-	
 	def all_variables
 		return @eq.all_variables
 	end
@@ -827,16 +742,7 @@ class Ln < Equation
 	def __simplify__
 		return Ln.new(@eq.__simplify__)
 	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
-	end
-	
+		
 	def all_variables
 		return @eq.all_variables
 	end
@@ -881,15 +787,6 @@ class Log < Equation
 		return Log.new(@base.__simplify__, @eq.__simplify__)
 	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
-	end
-	
 	def all_variables
 		return (@base.all_variables + @eq.all_variables).uniq
 	end
@@ -921,19 +818,6 @@ class Abs < Equation
 		return @eq / Abs.new(@eq) * @eq.derivative(variable: variable)
 	end
 	
-	def __simplify__
-		return Abs.new(@eq.__simplify__)
-	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
-	end
-	
 	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
@@ -952,44 +836,56 @@ class Abs < Equation
 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))
-	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, fixed_value=nil)
-		Variable.new name, fixed_value
-	end
-	
-	# abs(equation) is the same as Abs.new(equation), just shorter
-	def abs eq
-		return Abs.new(to_equation(eq))
-	end
+# Basic variables that are already implemented in SymCalc and have fixed values
+module Constants
 	
-	module_function :sin, :cos, :ln, :log, :exp, :var, :abs
+	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.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kyryl Shyshko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-15 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,
-  evaluating them and finding their derivatives in code.
+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:
 - Apache-2.0
-metadata: {}
+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,15 +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: Mathematical symbolic functions, calculus and differentiation in code
+summary: Symbolic mathematics and calculus in Ruby
 test_files: []

data/lib/LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.