symbolic 0.0.5 → 0.0.6

data/README.rdoc

@@ -1,21 +1,18 @@
 Symbolic math for ruby.
 
-Installation: gem install symbolic
+Installation:
+gem install symbolic
 
+Introduction:
 Symbolic math can be really helpful if you want to simplify some giant equation or if you don't want to get a performance hit re-evaluating big math expressions every time when few variables change.
 
 Currently I've implemented only naive optimizations to simplify math expressions, but it's pretty simple to add your own - see Symbolic::Optimizations module for examples.
 
-Simple example:
-  require 'rubygems'
-  require 'symbolic'
-
-  Symbolic.enabled = true
-
+Examples:
   x = var :name => 'x'
   y = var :name => 'y'
 
-  f = (4 - 2*(-x) + y*(-1.0))*x - 0*y + 0 - 2
+  f = symbolic { (4 - 2*(-x) + y*(-1.0))*x - 0*y + 0 - 2 }
   puts f # => (4+2*x-y)*x-2
 
   p f.undefined_variables.map &:name # => ["x", "y"]
@@ -25,7 +22,7 @@ Simple example:
   puts f.value # => 6
 
 
-  g = Math.cos(y)
+  g = symbolic { Math.cos(y) }
   puts g # => cos(y)
   y.value = 0
   puts g.value # => 1.0

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "symbolic"
-    gem.version = '0.0.5'
+    gem.version = '0.0.6'
     gem.summary = 'Symbolic math for ruby'
     gem.description = %Q{Symbolic math can be really helpful if you want to simplify some giant equation or if you don't want to get a performance hit re-evaluating big math expressions every time when few variables change.}
     gem.email = "ravwar@gmail.com"

data/lib/extensions/kernel.rb

@@ -4,8 +4,9 @@ module Kernel
   end
 
   def symbolic
-    Symbolic.enabled = true
-    yield
-    Symbolic.enabled = false
+    Symbolic::Core.enable
+    result = yield
+    Symbolic::Core.disable
+    return result
   end
 end

data/lib/symbolic.rb

@@ -1,111 +1,21 @@
+module Symbolic
+  def self.operations
+    { :* => :multiplication,
+      :+ => :addition,
+      :- => :subtraction,
+      :/ => :division }
+  end
+
+  def self.math_operations
+    [:cos, :sin]
+  end
+end
+
+require 'symbolic/core'
 require 'symbolic/operatable'
 require 'symbolic/optimizations'
 require 'symbolic/variable'
 require 'symbolic/expression'
 require 'symbolic/method'
 require 'symbolic/unary_minus'
-require 'extensions/kernel'
-
-module Symbolic
-  @enabled = false
-  class << self
-    def enabled?
-      @enabled
-    end
-
-    def enabled=(enable_flag)
-      if enable_flag && !@enabled
-        enable
-      elsif !enable_flag && @enabled
-        disable
-      end
-    end
-
-    def aliases
-      { :* => :non_symbolic_multiplication,
-        :+ => :non_symbolic_addition,
-        :- => :non_symbolic_substraction }
-    end
-
-    def math_operations
-      [:cos, :sin]
-    end
-
-    private
-
-    def numerical_context(&proc)
-      [Fixnum, Bignum, Float].each do |klass|
-        klass.class_eval &proc
-      end
-    end
-
-    def enable
-      @enabled = true
-      numerical_context do
-        Symbolic.aliases.each do |standard_operation, non_symbolic_operation|
-          alias_method non_symbolic_operation, standard_operation
-        end
-
-        def *(value)
-          if value.is_a?(Operatable)
-            Optimizations.multiply value, self, :reverse
-          else
-            non_symbolic_multiplication(value)
-          end
-        end
-
-        def +(value)
-          if value.is_a? Operatable
-            Optimizations.plus value, self, :reverse
-          else
-            non_symbolic_addition value
-          end
-        end
-
-        def -(value)
-          if value.is_a? Operatable
-            Optimizations.minus value, self, :reverse
-          else
-            non_symbolic_substraction value
-          end
-        end
-      end # numerical_context
-
-      math_operations.each do |operation|
-        Math.module_eval <<-CODE
-          class << self
-            alias non_symbolic_#{operation} #{operation}
-
-            def #{operation}(value)
-              if value.is_a? Operatable
-                Symbolic::Method.new value, :#{operation}
-              else
-                non_symbolic_#{operation} value
-              end
-            end
-          end
-        CODE
-      end
-    end # enable
-
-    def disable
-      @enabled = false
-      numerical_context do
-        Symbolic.aliases.each do |standard_operation, non_symbolic_operation|
-          alias_method standard_operation, non_symbolic_operation
-          remove_method non_symbolic_operation
-        end
-      end
-
-      Math.module_eval do
-        class << self
-          Symbolic.math_operations.each do |operation|
-            non_symbolic_operation = "non_symbolic_#{operation}"
-            alias_method operation, non_symbolic_operation
-            remove_method non_symbolic_operation
-          end
-        end
-      end
-    end # disable
-  end # class << self
-end
+require 'extensions/kernel'

data/lib/symbolic/core.rb

@@ -0,0 +1,89 @@
+module Symbolic
+  module Core
+    @enabled = false
+
+    class << self
+      def enable
+        if !@enabled
+          @enabled = true
+          redefine_numerical_methods
+          redefine_math_methods
+        end
+      end
+
+      def disable
+        if @enabled
+          @enabled = false
+          restore_numerical_methods
+          restore_math_methods
+        end
+      end
+
+      private
+
+      def numerical_context(&proc)
+        [Fixnum, Bignum, Float].each do |klass|
+          klass.class_eval &proc
+        end
+      end
+
+      def redefine_numerical_methods
+        numerical_context do
+          Symbolic.operations.each do |operation_sign, operation_name|
+            alias_method "non_symbolic_#{operation_name}", operation_sign
+
+            method = <<-CODE
+              def #{operation_sign}(value)
+                if value.is_a?(Operatable)
+                  Optimizations.#{operation_name} value, self, :reverse
+                else
+                  non_symbolic_#{operation_name}(value)
+                end
+              end
+            CODE
+
+            class_eval method, __FILE__, __LINE__
+          end
+        end # numerical_context
+      end # redefine_numerical_methods
+
+      def redefine_math_methods
+        Symbolic.math_operations.each do |operation|
+          code = <<-CODE
+            alias non_symbolic_#{operation} #{operation}
+
+            def #{operation}(value)
+              if value.is_a? Operatable
+                Symbolic::Method.new value, :#{operation}
+              else
+                non_symbolic_#{operation} value
+              end
+            end
+          CODE
+          Math.instance_eval code, __FILE__, __LINE__
+        end
+      end # redefine_math_methods
+
+      def restore_numerical_methods
+        numerical_context do
+          Symbolic.operations.each do |operation_sign, operation_name|
+            alias_method operation_sign, "non_symbolic_#{operation_name}"
+            remove_method "non_symbolic_#{operation_name}"
+          end
+        end
+      end
+
+      def restore_math_methods
+        Math.module_eval do
+          class << self
+            Symbolic.math_operations.each do |operation|
+              non_symbolic_operation = "non_symbolic_#{operation}"
+              alias_method operation, non_symbolic_operation
+              remove_method non_symbolic_operation
+            end
+          end
+        end
+      end
+    end # class << self
+  end # Core
+end # Symbolic

data/lib/symbolic/expression.rb

@@ -8,9 +8,9 @@ module Symbolic
     def to_s
       var1 = "#{@var1}"
       var2 = "#{@var2}"
-      if @operation == '*'
-        var1 = "(#{@var1})" if @var1.is_a?(Expression) && (@var1.plus? || @var1.minus?)
-        var2 = "(#{@var2})" if @var2.is_a?(Expression) && (@var2.plus? || @var2.minus?)
+      if ['*', '/'].include? @operation
+        var1 = "(#{@var1})" if @var1.is_a?(Expression) && (@var1.plus? || @var1.minus?) || @var1.is_a?(UnaryMinus)
+        var2 = "(#{@var2})" if @var2.is_a?(Expression) && (@var2.plus? || @var2.minus?) || @var2.is_a?(UnaryMinus)
       end
       "#{var1}#{@operation}#{var2}"
     end

data/lib/symbolic/operatable.rb

@@ -4,16 +4,17 @@ module Symbolic
       UnaryMinus.create self
     end
 
-    def *(value)
-      Optimizations.multiply self, value
+    def +@
+      self
     end
 
-    def +(value)
-      Optimizations.plus self, value
-    end
-
-    def -(value)
-      Optimizations.minus self, value
+    Symbolic.operations.each do |operation_sign, operation_name|
+      method = <<-CODE
+        def #{operation_sign}(value)
+          Optimizations.#{operation_name} self, value
+        end
+      CODE
+      class_eval method, __FILE__, __LINE__
     end
   end
 end

data/lib/symbolic/optimizations.rb

@@ -1,6 +1,6 @@
 module Symbolic
   module Optimizations
-    def self.plus(symbolic_var, var, reverse=false)
+    def self.addition(symbolic_var, var, reverse=false)
       if var == 0
         symbolic_var
       elsif var.is_a? UnaryMinus
@@ -16,7 +16,7 @@ module Symbolic
       end
     end
 
-    def self.minus(symbolic_var, var, reverse=false)
+    def self.subtraction(symbolic_var, var, reverse=false)
       if var == 0
         symbolic_var
       elsif var.is_a? UnaryMinus
@@ -32,7 +32,7 @@ module Symbolic
       end
     end
 
-    def self.multiply(symbolic_var, var, reverse=false)
+    def self.multiplication(symbolic_var, var, reverse=false)
       if var == 0
         var
       elsif var == 1
@@ -53,5 +53,17 @@ module Symbolic
         end
       end
     end
+
+    def self.division(symbolic_var, var, reverse=false)
+      if var == 1
+        symbolic_var
+      else
+        if reverse
+          Expression.new var, symbolic_var, '/'
+        else
+          Expression.new symbolic_var, var, '/'
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,7 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'symbolic'
+require 'rubygems'
 require 'spec'
 require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
-end
+Symbolic::Core.enable

data/spec/symbolic_spec.rb

@@ -1,7 +1,43 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) +'/spec_helper')
 
 describe "Symbolic" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  def self.x
+    var :value => 1, :name => 'x'
+  end
+
+  def self.y
+    var :value => 2, :name => 'y'
+  end
+
+  describe "evaluation (x=1, y=2):" do
+    def self.check_evaluation(conditions)
+      conditions.each do |symbolic_expression, result|
+        it symbolic_expression do
+          symbolic_expression.value.should == result
+        end
+      end
+    end
+
+    check_evaluation \
+    x         => 1,
+    y         => 2,
+    +x        => 1,
+    -x        => -1,
+    x + 4     => 5,
+    3 + x     => 4,
+    x + y     => 3,
+    x - 1     => 0,
+    1 - x     => 0,
+    x - y     => -1,
+    -x + 3    => 2,
+    -y - x    => -3,
+    x*3       => 3,
+    4*y       => 8,
+    (+x)*(-y) => -2,
+    x/2       => 0,
+    y/2       => 1,
+    x/2.0     => 0.5,
+    -2/x      => -2,
+    4/(-y)    => -2
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: symbolic
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - brainopia
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-20 00:00:00 +03:00
+date: 2009-11-24 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,6 +36,7 @@ files:
 - Rakefile
 - lib/extensions/kernel.rb
 - lib/symbolic.rb
+- lib/symbolic/core.rb
 - lib/symbolic/expression.rb
 - lib/symbolic/method.rb
 - lib/symbolic/operatable.rb