symbolic-math 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Javier Goizueta
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,51 @@
+= symbolic
+
+This is a proof-of-concept experiment to handle symbolic expressions in Ruby, inspired by Sage.
+
+Symbolic expressions can be built with Ruby syntax in a +symbolic+ block, by declaring variables with +var+:
+
+  symbolic do
+    var :x
+    expr = 2+x                         # now expr contains a symbolic expression
+    puts expr                          # -> (2 + x)
+    puts eval(expr)                    # -> (2 + x)
+    self.x = 1.5
+    puts eval(expr)                    # -> 3.5
+    puts eval(expr/7)                  # -> 0.5
+    var :y
+    poly = 3*x**3 - x**2 - y*x + 7
+    puts eval(poly)                    # -> ((7.875 - (y * 1.5)) + 7)
+    puts eval(poly, :y=>5.0)           # -> 7.375
+  end
+
+Functions can be defined with +fun+:
+
+  symbolic do
+    fun(:sqr){|x| x*x}
+    var :x
+    expr = sqr(sin(x))
+    puts expr             # -> sqr(sin(x))
+    self.x = 1.5
+    puts eval(expr)       # -> 0.994996248300223
+  end
+  
+== Similar project
+  
+http://github.com/brainopia/symbolic is a similar, more complete project. Because of this the gem released
+by this project has been renamed to symbolic-math. Note that this project's pretensions are more limited than
+brainopia's; I only intend to play with syntax to do symbolic Math in Ruby, not to implement any relevant
+symbolic math functionality.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Javier Goizueta. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "symbolic-math"
+    gem.summary = %Q{Symbolic math expression in Ruby}
+    gem.description = %Q{This is a proof-of-concept experiment inspired by Sage}
+    gem.email = "jgoizueta@gmail.com"
+    gem.homepage = "http://github.com/jgoizueta/symbolic"
+    gem.authors = ["Javier Goizueta"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "symbolic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/symbolic-math.rb

@@ -0,0 +1,209 @@
+# Proof-of-concept: symbolic expressions in Ruby (inspired by Sage)
+
+class Symbolic
+
+  INFIX_OPERATORS = {
+    :+ => lambda{|x,y| x+y},
+    :- => lambda{|x,y| x-y},
+    :* => lambda{|x,y| x*y},
+    :/ => lambda{|x,y| x/y},
+    :^ => lambda{|x,y| x**y}, # nice, but wrong precedence!
+    :** => lambda{|x,y| x**y}
+  }
+
+  PREFIX_OPERATORS = {
+    :+ => lambda{|x| +x},
+    :- => lambda{|x| -x}
+  }
+
+  FUNCTIONS = {
+    :sin=>lambda{|x| Math.sin(x)},
+    :cos=>lambda{|x| Math.cos(x)},
+    :tan=>lambda{|x| Math.tan(x)},
+    :asin=>lambda{|x| Math.asin(x)},
+    :acos=>lambda{|x| Math.acos(x)},
+    :atan=>lambda{|x| Math.atan(x)},
+    :atan2=>lambda{|y,x| Math.atan2(y,x)},
+    :sqrt=>lambda{|x| Math.sqrt(x)},
+    :abs=>lambda{|x| x.abs}
+  }
+
+  class Expression
+
+    def initialize(*tree)
+      @tree = tree
+    end
+
+    attr_reader :tree
+
+    INFIX_OPERATORS.each_key do |operator|
+      define_method operator do |other|
+        other = Expression.new(other) unless other.is_a?(Expression)
+        #Expression.new(operator, self.tree, other.tree)
+        Expression.new(operator, self, other)
+      end
+    end
+
+    PREFIX_OPERATORS.each_key do |operator|
+      define_method :"#{operator}@" do
+        Expression.new(operator, self)
+      end
+    end
+
+    def vars
+      vars = []
+      if @tree.size==1
+        if @tree.first.is_a?(Symbol)
+          unless f=FUNCTIONS[@tree.first] && f.arity==0
+            vars << @tree.first if @tree.first.is_a?(Symbol)
+          end
+        end
+        # TODO: allow an Expression here?
+      else
+        @tree[1..-1].each do |subexpr|
+          case subexpr
+          when Expression
+            vars += subexpr.vars
+          when Symbol
+            vars << subexpr
+          end
+        end
+      end
+      vars.uniq
+    end
+
+    def to_s
+      arity = tree.size - 1
+      case tree.first
+        when Symbol
+          if arity==2 && INFIX_OPERATORS.has_key?(tree.first)
+            "(#{tree[1].to_s} #{tree.first} #{tree[2].to_s})"
+          elsif arity==1 && PREFIX_OPERATORS.has_key?(tree.first)
+            "(#{tree.first} #{tree[1].to_s})"
+          elsif (f = FUNCTIONS[tree.first]) && f.arity==arity
+            "#{tree.first}(#{tree[1..-1].map{|x| x.to_s}.join(',')})"
+          else
+            tree.first
+          end
+        else
+         tree.first
+      end
+    end
+
+    def eval(values={})
+      arity = tree.size - 1
+      case tree.first
+        when Symbol
+          if arity==2 && op = INFIX_OPERATORS[tree.first]
+            op[Expression.eval(tree[1],values), Expression.eval(tree[2],values)]
+          elsif arity==1 && op = PREFIX_OPERATORS[tree.first]
+            op[Expression.eval(tree[1],values)]
+          elsif (f = FUNCTIONS[tree.first]) && f.arity==arity
+            f[*tree[1..-1].map{|x| Expression.eval(x,values)}]
+          else
+            # assume variable
+            values[tree.first] || self
+          end
+        else
+         tree.first
+      end
+    end
+
+    def self.eval(item, values)
+      case item
+        when Expression
+          item.eval(values)
+        else
+          item
+      end
+    end
+
+    def coerce(other)
+      [Expression.new(other), self]
+    end
+
+  end
+
+  def self.fun(name, mthd=nil, &blk)
+    raise ArgumentError,"Invalid function definition" unless (mthd || blk) && (!mthd || !blk)
+    blk ||= mthd
+    name = name.to_sym
+    arity = blk.arity
+    FUNCTIONS[name] = blk # TODO: local functions (per Symbolic object)
+    define_method name do |*args|
+    if arity != args.size
+      raise ArgumentError,"Invalid number of arguments for  #{name} (#{args.size} for #{arity})"
+    end
+      Expression.new(name, *args)
+    end
+  end
+
+  FUNCTIONS.each_pair do |f, mth|
+    Symbolic.fun f, mth
+  end
+
+  def initialize
+    @vars = {}
+  end
+
+  attr_reader :vars
+
+  def var(*names)
+    names.each do |name|
+      name = name.to_sym
+      @vars[name] = nil
+      instance_variable_set "@#{name}", Expression.new(name)
+      self.class.class_eval{
+        attr_reader name
+        # can't decide on assignment syntax:
+        # 1. assignment operator (requires self) self.x = 1.0;
+        define_method :"#{name}=" do |value|
+          assign name, value
+        end
+        # 2. method assign_x 1.0;
+        define_method :"assign_#{name}" do |value|
+          assign name, value
+        end
+        # 3. or use assing :x, 1.0;
+        # More indecision: rename 'assign' to 'set' ? 'let' ?
+      }
+    end
+  end
+
+  def assign(name, value)
+    @vars[name.to_sym] = value
+  end
+
+  def execute(blk)
+    if blk.arity==1
+      blk.call(self)
+    else
+      self.instance_eval(&blk)
+    end
+  end
+
+  def eval(expr, values={})
+    expr.eval(@vars.merge(values))
+  end
+
+  def fun(name, mthd=nil, &blk)
+    self.class.fun name, mthd, &blk
+  end
+
+  def macro(name, &blk)
+    self.class.class_eval{define_method name, blk}
+  end
+
+end
+
+def symbolic(*args, &blk)
+  s = Symbolic.new(*args)
+  s.execute blk
+end
+
+
+# TODO:
+# consider this: add reference to Symbolic object in Expression;
+# use it to access local functions defined for a Symbolic (not
+# globally in FUNCTIONS as now) and to access variables, so
+# expr.eval can be used instead of eval(expr)

data/symbolic-math.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{symbolic-math}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Javier Goizueta"]
+  s.date = %q{2009-12-10}
+  s.description = %q{This is a proof-of-concept experiment inspired by Sage}
+  s.email = %q{jgoizueta@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/symbolic-math.rb",
+     "symbolic-math.gemspec",
+     "test/helper.rb",
+     "test/test_symbolic.rb"
+  ]
+  s.homepage = %q{http://github.com/jgoizueta/symbolic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Symbolic math expression in Ruby}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_symbolic.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'symbolic-math'
+
+class Test::Unit::TestCase
+end

data/test/test_symbolic.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestSymbolic < Test::Unit::TestCase
+
+  should "obtain symbolic objects from expressions involving declared variables" do
+    assert_equal Symbolic::Expression, symbolic{var :x; x*3}.class
+    assert_equal Symbolic::Expression, symbolic{var :x; 3*x}.class
+    assert_equal Symbolic::Expression, symbolic{var :x; x+7}.class
+    assert_equal Symbolic::Expression, symbolic{var :x; sin(x)}.class
+  end
+
+  should "evaluate symbolic expressions correctly" do
+    assert_equal 3.0, symbolic{var :x; self.x=1.5; eval(x*2)}
+    assert_equal 3.0, symbolic{var :x; self.x=1.5; eval(2*x)}
+    assert_equal -1.5, symbolic{var :x; self.x=1.5; eval(-x)}
+    assert_in_delta 0.997494986604054, symbolic{var :x; self.x=1.5; eval(sin(x))}, 1E-10
+    assert_in_delta -0.676873339089758, symbolic{var :x; self.x=1.5; eval(2*sin(x**3)-x/7)}, 1E-10
+  end
+
+  should "evaluate symbolic expressions correctly with hash parameters" do
+    assert_equal 3.0, symbolic{var :x; eval(x*2, :x=>1.5)}
+    assert_equal 3.0, symbolic{var :x; eval(2*x, :x=>1.5)}
+  end
+
+  should "evaluate partially expression with free variables" do
+    assert_equal "(4.0 - (2.0 * (y ** 2)))", symbolic{var :x, :y; eval(x*2-x*y**2, :x=>2.0).to_s}
+  end
+
+  should "allow definition of functions" do
+    assert_equal "sqr(7)", symbolic{fun(:sqr){|x| x*x}; sqr(7).to_s}
+    assert_equal 49, symbolic{fun(:sqr){|x| x*x}; eval(sqr(7))}
+  end
+
+  should "detect variables used in expressions" do
+    assert_equal [:x], symbolic{var :x, :y; (sin(x*3.5)+2-x).vars}
+    assert_equal [:x,:y], symbolic{var :x, :y; (sin(x*3.5)+2-y).vars}
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: symbolic-math
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Javier Goizueta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This is a proof-of-concept experiment inspired by Sage
+email: jgoizueta@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/symbolic-math.rb
+- symbolic-math.gemspec
+- test/helper.rb
+- test/test_symbolic.rb
+has_rdoc: true
+homepage: http://github.com/jgoizueta/symbolic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Symbolic math expression in Ruby
+test_files: 
+- test/helper.rb
+- test/test_symbolic.rb