rucas 0.0.1

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,2 @@
+=== 0.0.1 2009-12-03
+* initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+README.txt.erb
+Rakefile
+bin/rucas
+lib/rucas.rb
+lib/rucas/extensions.rb
+lib/rucas/rewrite.rb
+lib/rucas/simplify.rb
+lib/rucas/symbolic.rb
+lib/rucas/utility.rb
+test/test_rucas.rb

data/README.txt

@@ -0,0 +1,108 @@
+
+= rucas
+
+http://github.com/jdleesmiller/rucas
+
+== DESCRIPTION
+
+The beginnings of a Computer Algebra System in ruby.
+Supports basic simplification of symbolic expressions over the real numbers.
+Expressions can be entered and manipulated using standard ruby.
+
+This is at a very early stage; many things may change.
+
+== SYNOPSIS
+
+  require 'rubygems'
+  require 'rucas'
+
+  include Rucas
+
+  # basic algebraic simplification
+  with_rucas {
+    var :x
+    var :y
+    ((x + 1 - x)**y).simplify
+  }.to_s                  #=> "1"
+
+  # manipulate symbols using standard ruby code
+  with_rucas {
+    var :x
+    var :y
+    var :z
+    foo = [x,y,z].inject {|s,e| s + e}
+    foo ** 2
+  }.to_s                  #=> "(x + y + z)**2"
+
+  # build symbolics into ruby objects
+  class Foo
+    include Rucas::Symbolic
+    def initialize
+      var :p
+      var :q
+    end
+
+    def bar
+      (p + 1) / (q - p)
+    end
+  end
+  Foo.new.bar.to_s        #=> "(p + 1) / (q - p)"
+
+  # build expression trees
+  with_rucas {
+    var :p
+    1 + p
+  }                       #=> #<struct Rucas::Symbolic::AddExpr op=:+,
+                              lhs=#<struct Rucas::Symbolic::ConstExpr value=1>,
+                              rhs=#<struct Rucas::Symbolic::VarExpr name=:p>>
+
+== NOTES
+
+* Run an interactive session with the +rucas+ command; the interactive rucas is built on irb.
+* The implementation is based on the source code for Norvig's Paradigms of AI Programming (PAIP), but rucas is not yet as complete as the macsyma in Norvig's book.
+
+== PROBLEMS
+
+* Simplification is quite dumb, because it doesn't understand much about commutativity and associativity.
+* Doesn't do differentiation or integration (but could in the future).
+* Doesn't support special functions (but could in the future).
+* Doesn't integrate with other CAS systems (e.g. maxima) (but could in the future).
+* Doesn't do anything with logical conditions on variables (e.g. x > 0).
+
+== INSTALL
+
+On *nix systems,
+
+  sudo gem install rucas
+
+should do it.
+
+To run the interactive rucas, you should just be able to type +rucas+. If it doesn't work, you may need to change your PATH settings. The procedure for this is currently to run
+  gem env
+and look at the EXECUTABLE DIRECTORY; then run
+  echo $PATH
+and make sure that the executable directory is on your path. If it's not, you will have to add it (search for "add directory to path").
+
+== LICENSE
+
+Copyright (c) 2009 John Lees-Miller
+
+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.txt.erb

@@ -0,0 +1,157 @@
+<%
+  # This is intended to run against the development version.
+  for d in %w(lib bin)
+    $: << File.join(File.expand_path(File.dirname(__FILE__)), d)
+  end
+%>
+= rucas
+
+http://github.com/jdleesmiller/rucas
+
+== DESCRIPTION
+
+The beginnings of a Computer Algebra System in ruby.
+Supports basic simplification of symbolic expressions over the real numbers.
+Expressions can be entered and manipulated using standard ruby.
+
+This is at a very early stage; many things may change.
+
+== SYNOPSIS
+
+  require 'rubygems'
+  require 'rucas'
+
+  include Rucas
+<%
+  require 'rubygems'
+  require 'rucas'
+  require 'facets/string/word_wrap'
+  include Rucas
+
+  #
+  # Return code (as string) and the resulting output (as string).
+  # Make some effort to format nicely.
+  #
+  def x code
+    # It's nice to put the erb line noise on its own line.
+    code.sub! /^\n/, ''
+    code.rstrip!
+    return "" if code == ""
+
+    output = eval(code).inspect
+
+    # Try to be smart about respecting line widths.
+    code_lines = code.lines.to_a
+    indent = code_lines.map {|l| l =~ /^(\s+)/; $1}.min_by {|s| s.length}
+
+    arrow = "#=> "
+    output_col = 25
+    max_width  = 80
+    code_len = code_lines.last.length
+
+    output_width = max_width - output_col - arrow.length - 1
+    wrapped_output = output.word_wrap(output_width)
+    wrapped_output = wrapped_output.take(1) +
+      wrapped_output.drop(1).map {|l| " "*(arrow.length+1+output_col) + l}
+    wrapped_output = wrapped_output.join.rstrip!
+    start = code_lines.reverse.drop(1).reverse.join
+    "#{start}%-#{output_col}s #{arrow}#{wrapped_output}" % code_lines.last
+  end
+
+  #  puts ((x + 1 - x)**y).simplify  # ==> 1
+  #  puts (x + 1).with(x => 2).value # ==> 3
+%>
+  # basic algebraic simplification
+<%=x %q{
+  with_rucas {
+    var :x
+    var :y
+    ((x + 1 - x)**y).simplify
+  }.to_s
+}%>
+
+  # manipulate symbols using standard ruby code
+<%=x %q{
+  with_rucas {
+    var :x
+    var :y
+    var :z
+    foo = [x,y,z].inject {|s,e| s + e}
+    foo ** 2
+  }.to_s
+}%>
+
+  # build symbolics into ruby objects
+<%=x %q{
+  class Foo
+    include Rucas::Symbolic
+    def initialize
+      var :p
+      var :q
+    end
+
+    def bar
+      (p + 1) / (q - p)
+    end
+  end
+  Foo.new.bar.to_s
+}%>
+
+  # build expression trees
+<%=x %q{
+  with_rucas {
+    var :p
+    1 + p
+  }
+}%>
+
+== NOTES
+
+* Run an interactive session with the +rucas+ command; the interactive rucas is built on irb.
+* The implementation is based on the source code for Norvig's Paradigms of AI Programming (PAIP), but rucas is not yet as complete as the macsyma in Norvig's book.
+
+== PROBLEMS
+
+* Simplification is quite dumb, because it doesn't understand much about commutativity and associativity.
+* Doesn't do differentiation or integration (but could in the future).
+* Doesn't support special functions (but could in the future).
+* Doesn't integrate with other CAS systems (e.g. maxima) (but could in the future).
+* Doesn't do anything with logical conditions on variables (e.g. x > 0).
+
+== INSTALL
+
+On *nix systems,
+
+  sudo gem install rucas
+
+should do it.
+
+To run the interactive rucas, you should just be able to type +rucas+. If it doesn't work, you may need to change your PATH settings. The procedure for this is currently to run
+  gem env
+and look at the EXECUTABLE DIRECTORY; then run
+  echo $PATH
+and make sure that the executable directory is on your path. If it's not, you will have to add it (search for "add directory to path").
+
+== LICENSE
+
+Copyright (c) 2009 John Lees-Miller
+
+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/Rakefile

@@ -0,0 +1,35 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'erb'
+
+Hoe.spec 'rucas' do |spec|
+  developer('John Lees-Miller', 'jdleesmiller@gmail.com')
+  spec.description = 'The beginnings of a computer algebra system in ruby.'
+  extra_deps << ['facets']
+
+  # self.rubyforge_name = 'rucasx' # if different than 'rucas'
+end
+
+desc "run bin/rucas"
+task :run do
+  system "/usr/bin/ruby1.8 -w -Ilib:ext:bin:test -rubygems bin/rucas"
+end
+
+desc "patch manifest"
+task :patch_manifest do
+  system "rake check_manifest | grep -v \"^(in \" | patch"
+end
+
+file "README.txt" => "README.txt.erb" do |t|
+  for d in %w(lib bin)
+    $: << File.join(File.expand_path(File.dirname(__FILE__)), d)
+  end
+  File.open(t.name, 'w') do |f|
+    f.puts(ERB.new(File.read(t.prerequisites.first)).result)
+  end
+end 
+task :docs => "README.txt"
+
+# vim: syntax=ruby

data/bin/rucas

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+#
+# Interactive rucas shell based on the standard Interactive Ruby Shell (irb). 
+#
+
+require 'rucas'
+require 'irb'
+
+# Now everything understands symbols.
+include Rucas::Symbolic
+include Rucas
+
+# Helper to print example code.
+def rucas_help_example code
+  puts "> #{code}"
+  puts "   #=> #{$rucas_help_scope.rucas{ Kernel::eval(code) }.inspect}"
+end
+
+# A short help message.
+def rucas_help
+  puts "Interactive rucas is based on the standard Interactive Ruby (irb)."
+  puts "Declare symbolic variables using var."
+  puts "Then you can manipulate them using standard Ruby code."
+  puts ""
+  puts "Examples:"
+  # Run examples in their own scope to avoid clobbering user's stuff.
+  # I was using XMP for this, but it seems to interfere with irb.
+  # The only problem with this approach is that it doesn't allow local
+  # variables, so we can't demo those; we'd have to use @vars.
+  $rucas_help_scope = Scope.new
+  rucas_help_example "var :x"
+  rucas_help_example "var :y"
+  rucas_help_example "var :z"
+  rucas_help_example "(x + 1 - x).simplify.to_s"
+  rucas_help_example "[x, y, z].inject{|s, x| s + x}.to_s"
+  puts ""
+  puts "You can use underscore (_) to get the result of the last command."
+end
+
+puts "-- interactive rucas --"
+puts "To exit, type exit or quit."
+puts "For help, type rucas_help."
+
+#
+# Custom prompt. The best way I've found to do this is to install the RUCAS
+# prompt as the default in irb's initialization routine. Clearly this is not an
+# ideal solution.
+#
+module IRB
+  def IRB.init_config_with_rucas ap_path
+    init_config_without_rucas(ap_path)
+    IRB.conf[:PROMPT][:RUCAS] = {
+          :PROMPT_I => "rucas:%03n:%i> ",
+          :PROMPT_S => "rucas:%03n:%i%l ",
+          :PROMPT_C => "rucas:%03n:%i* ",
+          :RETURN => "%s\n"
+    }
+    IRB.conf[:PROMPT_MODE] = :RUCAS
+  end
+
+  class <<self
+    alias_method :init_config_without_rucas, :init_config
+    alias_method :init_config, :init_config_with_rucas
+  end
+end
+
+IRB.start(__FILE__)
+

data/lib/rucas.rb

@@ -0,0 +1,48 @@
+require 'rucas/utility'
+require 'rucas/symbolic'
+require 'rucas/extensions'
+
+module Rucas
+  VERSION = '0.0.1'
+
+  #
+  # Open classes to make constants work.
+  #
+  Extensions.apply
+
+  #
+  # Scope storing currently declared variables.
+  #
+  # Note: You can do this using any class; just include the Symbolic module.
+  #
+  class Scope
+    include Symbolic
+
+    #
+    # Create a subscope; this is just a clone of the current scope, so it
+    # includes all of the symbols of this scope.
+    #
+    def subscope
+      self.clone
+    end
+
+    #
+    # Evaluate given block in this scope.
+    #
+    def rucas &block
+      self.instance_eval(&block)
+    end
+  end
+
+  #
+  # Interpret code in the block as Rucas code and return the result of the
+  # block. 
+  #
+  def with_rucas scope=Scope.new, &block
+    scope.rucas(&block)
+  end
+end
+
+require 'rucas/rewrite'
+require 'rucas/simplify'
+