mathviz 1.0.2 → 1.1.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 1.1.0 2012-05-03
+
+* Streamlined syntax for unit/operation extension
+  * Replace MathViz::Unit#binop with MathViz::Unit#binary_operator, or use the new shorthand syntax MathViz#binop
+* When/Given/Then comment methods can set up default-to-input mode
+* Collpase anonymous nodes with the same operation
+* Print output filename
+* Collapsed most of Binary/Unary into n-ary Operation
+* Namespaced modules for extensions to core classes
+* Tax example
+
 === 1.0.2 2010-09-04
 
 * Set variable names as strings intead of symbols

data/Manifest.txt

@@ -6,6 +6,7 @@ examples/E_mc2.png
 examples/E_mc2.rb
 examples/dc.rb
 examples/first.rb
+examples/tax.rb
 lib/mathviz.rb
 spec/measurable_spec.rb
 spec/measured_spec.rb

data/README.rdoc

@@ -10,7 +10,7 @@ Turn simple equations (a = b * c) into GraphViz dot files showing relationships,
 
 == FEATURES/PROBLEMS:
 
-* Adds one method to Object and several to Numeric (some direct, some by Measurable and Unit.)  If you use units of measure, each unit will appear on Numeric via module Unit.
+* Adds one method to Object (by way of Graphable) and several to Numeric (by way Measurable, Unit, and NumericExtensions)  If you use units of measure, each unit will appear on Numeric via module Unit.
 * MathViz produces textual .dot files.  You will need a viewer which supports dot files directly, or Graphviz to convert them to images yourself.
 
 == SYNOPSIS:

data/examples/tax.rb

@@ -0,0 +1,78 @@
+require 'mathviz'
+
+class Numeric
+  def between(range)
+    [[self.to_f, range.max].min - range.min, 0].max
+  end
+end
+
+class Range
+  include MathViz::Measurable
+end
+
+MathViz.new {
+  new_units :usd
+  binop :between
+
+  def pos(n)
+    n.max(0.usd)
+  end
+
+  When "I earn"
+  income = 39_527.usd
+
+  And "spend"
+  medical = 6_153.usd
+  contributions = 2_189.usd
+  property_tax = 3_830.usd
+  interest_paid = 9_055.usd
+  us_tax_paid = 7000.usd
+  il_tax_paid = 1800.usd
+
+  Given "IL tax rates (2012)"
+  il = const 0.05
+  il_deduction = 2000.usd
+
+  Then "IL tax"
+  il_deductions = (il_deduction + property_tax)
+
+  il_taxable = pos(income - il_deductions)
+  il_tax = il_taxable * il
+  il_tax_due = il_tax - il_tax_paid
+
+  Given "US tax rates (2012)"
+  ss = const 0.104
+  medicare = const 0.029
+  tax_brackets = {
+    0.10 => (0..8_700).usd,
+    0.15 => (8_700..35_350).usd,
+    0.25 => (35_350..85_650).usd,
+    0.28 => (85_650..178_650).usd,
+    0.33 => (178_650..388_350).usd,
+  }
+  standard_deduction = 5_950.usd
+  exception = 3_800.usd
+
+  Then "US tax"
+  ss_tax = income * ss
+  medicare_tax = income * medicare
+  welfare_tax = ss_tax + medicare_tax
+
+  itemized_deduction = property_tax + il_tax_paid + interest_paid + contributions
+  deduction = itemized_deduction.max(standard_deduction)
+  us_deductions = deduction + exception
+  us_taxable = pos(income - ss_tax/2 - medical - us_deductions)
+
+  # this removes some noise from the graph
+  applicable_brackets = tax_brackets.select do |rate, bracket|
+    bracket.to_value.min <= us_taxable.to_value
+  end
+  us_income_tax = applicable_brackets.map do |rate, bracket|
+    us_taxable.between(bracket) * rate
+  end.reduce(&:+)
+
+  us_tax = us_income_tax + welfare_tax
+  us_tax_due = us_tax - us_tax_paid
+
+  binding
+}.dot

data/lib/mathviz.rb

@@ -3,7 +3,7 @@ require 'graphviz_r'
 # Top level object.
 class MathViz
   # RubyGem version
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 
   # Something to return instead of dividing by zero, etc.
   Infinity = 1.0/0
@@ -30,18 +30,68 @@ class MathViz
     MathViz::Input.new(x)
   end
 
+  # Define new units (instance methods) on module MathViz::Units (where they will be picked up by everything including the module)
+  # Defined methods are essentialy aliases for #unit(name); see MathViz::Measurable / MathViz::Measured
+  def new_units(*units)
+    MathViz::Units.new_units(*units)
+  end
+
+  # Define op as a binary operator
+  def binop(op)
+    MathViz::Term.binop op
+    MathViz::Unit.binop op
+  end
+
+  # Define op as unary operator
+  def unop(op)
+    MathViz::Term.unop op
+  end
+
   # Save a Graphviz .dot file in the current directory, with name specified in the constructor.  Triggers most of the actual processsing.
   def dot
     MathViz::Term.name_terms!(@env)
     #puts MathViz::Term.list_terms(@env).map {|t| t.long}
     graph = GraphvizR.new @name
-    graph = MathViz::Term.list_terms(@env).inject(graph) {|g, t|
-      t.to_dot(g)
-      g
+    MathViz::Term.list_terms(@env).flat_map(&:collapse).each {|t|
+      t.to_dot(graph)
     }
 
-    #puts graph.to_dot
-    graph.output(@name + '.dot', 'dot')
+    filename = @name + '.dot'
+    graph.output(filename, 'dot')
+    puts "Wrote #{filename}"
+  end
+
+  # Comment that identifies a set of inputs.  Subsequent measured values will be marked as #input
+  def When(desc)
+    @@default_term = Input
+  end
+
+  # Comment that identifies a set of constants.  Subsequent measured values will be marked as #const
+  def Given(desc)
+    @@default_term = Constant
+  end
+
+  # Comment that identifies a section of calculations on the inputs and constants.
+  def Then(desc)
+    @@default_term = Constant
+  end
+
+  # Comment which reads a little better than repetition.
+  def And(desc)
+  end
+
+  # internal method
+  def self.default_term
+    @@default_term ||= Constant
+  end
+
+  # Turn the object into a MathViz::Term (MathViz::Constant) if isn't already a MathViz::Term.  This allows for operator parameters to be primitive values without needing MathViz#const, MathViz#input, or units.
+  def self.term(x)
+    if (x.kind_of?(MathViz::Term))
+      x
+    else
+      MathViz::Constant.new(x)
+    end
   end
 end
 
@@ -66,7 +116,7 @@ class MathViz::Unit
   end
 
   # Implement a simple binary operation.  It verifies that the units match and returns the unit ERROR if not.
-  def binop(other)
+  def binary_operator(other)
     if (unit != other.unit)
       #p "#{to_s} !+- #{other.to_s}"
       return MathViz::Unit.new(:ERROR)
@@ -74,15 +124,19 @@ class MathViz::Unit
     return self
   end
 
-  alias_method :+, :binop
-  alias_method :-, :binop
-  alias_method :<, :binop
-  alias_method :>, :binop
-  alias_method :==, :binop
-  alias_method :max, :binop
-  alias_method :min, :binop
-  alias_method :&, :binop
-  alias_method :|, :binop
+  def self.binop(other)
+    alias_method other, :binary_operator
+  end
+
+  alias_method :+, :binary_operator
+  alias_method :-, :binary_operator
+  alias_method :<, :binary_operator
+  alias_method :>, :binary_operator
+  alias_method :==, :binary_operator
+  alias_method :max, :binary_operator
+  alias_method :min, :binary_operator
+  alias_method :&, :binary_operator
+  alias_method :|, :binary_operator
 
   def *(other)
     x = @unit.dup
@@ -120,7 +174,7 @@ class MathViz::Unit
 
   # Produce a string of multiplied terms
   def stream(units)
-    x = units.map {|u,power| [u] * power.abs }.flatten.join('*')
+    x = units.flat_map {|u,power| [u] * power.abs }.join('*')
     if (x.empty?)
       return nil
     else
@@ -164,14 +218,23 @@ end
 module MathViz::Measurable
   include MathViz::Units
 
-  # return constant wrapping self with the specified units; see also MathViz::Units::Class#new_units
+  # return term wrapping self with the specified units; see also MathViz::Units::Class#new_units
   def unit(x)
-    MathViz::Constant.new(self).unit(x)
+    MathViz.default_term.new(self).unit(x)
   end
 
-  # return constant wrapping self with new units assigned to the denominator
+  # return term wrapping self with new units assigned to the denominator
   def per
-    MathViz::Constant.new(self).per
+    MathViz.default_term.new(self).per
+  end
+
+  # api method for unwrapping terms
+  def to_value
+    if kind_of? Numeric
+      to_f
+    else
+      self
+    end
   end
 end
 
@@ -212,11 +275,15 @@ module MathViz::Measured
   def units
     @unit || MathViz::Unit.new
   end
-end
 
-class Numeric
-  include MathViz::Measurable
+  # api method for unwrapping terms
+  def to_value
+    to_f
+  end
+end
 
+# Namespaced extensions
+module MathViz::NumericOperations
   # Provide in operator form
   def max(b)
     [self, b].max
@@ -233,13 +300,23 @@ class Numeric
   end
 end
 
-class Object
-  # Representation used for graphviz node names
+class Numeric
+  include MathViz::Measurable
+  include MathViz::NumericOperations
+end
+
+# Namespaced extensions
+module MathViz::Graphable
+  # graph node title
   def node
     to_s
   end
 end
 
+class Object
+  include MathViz::Graphable
+end
+
 # Base class for graphable objects.  It also contain the operators, which return MathViz::Operation subclasses.
 class MathViz::Term
   include MathViz::Measured
@@ -269,14 +346,14 @@ class MathViz::Term
   # Define op as a binary operator
   def self.binop(op)
     define_method(op) do |c|
-      MathViz::Operation::Binary.new(self, op, c)
+      MathViz::Operation.new(op, self, c)
     end
   end
 
   # Define op as an unary operator
   def self.unop(op)
     define_method(op) do
-      MathViz::Operation::Unary.new(self, op)
+      MathViz::Operation::Unary.new(op, self)
     end
   end
 
@@ -289,7 +366,7 @@ class MathViz::Term
 
   # A string representation of the node's data, typically calculated value with units.
   def data
-    f = to_f
+    f = to_value
     if (f.kind_of?(TrueClass) || f.kind_of?(FalseClass))
       f.to_s
     elsif (!f.respond_to? :finite?)
@@ -304,7 +381,7 @@ class MathViz::Term
   end
 
   def to_i
-    f = to_f
+    f = to_value
     return MathViz::Infinity unless f.finite?
     f.to_i
   end
@@ -344,6 +421,21 @@ class MathViz::Term
     g[node] [:label => label, :shape => shape, :color => color, :style => style]
   end
 
+  # Helper to avoid duplicate nodes
+  def generated?
+    !name.nil?
+  end
+
+  # Only valid after names have been assigned, which means not during graph construction
+  def anonymous?
+    !@name
+  end
+
+  # Stub
+  def collapse(parentop = nil)
+    [self]
+  end
+
   private
   @@anon_master = 'A'
 
@@ -359,10 +451,6 @@ class MathViz::Term
     end
   end
 
-  def anonymous?
-    !@name
-  end
-
   public
 
   ##
@@ -425,12 +513,12 @@ class MathViz::Constant < MathViz::Term
   # Debugging method; string with both name and value
   def long
     n = @name && (@name + " = ")
-    "(#{n}#{to_f})"
+    "(#{n}#{to_value})"
   end
 
   # Forward to contained object
-  def to_f
-    @a.to_f
+  def to_value
+    @a.to_value
   end
 
   # Returns the units of the contained object (if any) or else it's own.
@@ -453,7 +541,7 @@ class MathViz::Constant < MathViz::Term
 
   # Forward to contained object
   def finite?
-    @a.finite?
+    @a.respond_to?(:finite?) ? @a.finite? : true
   end
 end
 
@@ -472,79 +560,18 @@ class MathViz::Input < MathViz::Constant
   end
 end
 
-# Base class for MathViz::Operation::Binary and MathViz::Operation::Unary
+# n-ary operators
 class MathViz::Operation < MathViz::Term
-  # Turn the object into a MathViz::Term (MathViz::Constant) if isn't already a MathViz::Term.  This allows for operator parameters to be primitive values without needing MathViz#const, MathViz#input, or units.
-  def term(x)
-    if (x.kind_of?(MathViz::Term))
-      x
-    else
-      MathViz::Constant.new(x)
-    end
-  end
-
-  # Graphviz node shape
-  def shape
-    :box
-  end
-
-  # Default Graphviz node color.
-  def color
-    :red
-  end
-end
-
-# Display and processing for single-value operators
-class MathViz::Operation::Unary < MathViz::Operation
-  def initialize(a, op)
-    super()
-    @a = term(a)
-    @op = op
-  end
-
-  # Debugging method; return string of name and value.
-  def long
-    n = @name && (@name + " = ")
-    "(#{n}#{@a} #{@op} = #{to_f})"
-  end
-
-  # Extend Graphviz g with a representation of this object, and incoming connections
-  def to_dot(g)
-    super
-    (g[@a.node] >> g[node]) [:arrowhead => :normal, :headlabel => @op.to_s, :labeldistance => '2']
-    @a.to_dot(g) if (@a.respond_to?(:name) && @a.name.nil?)
-  end
-
-  # Apply the operator to create the derived value.
-  def to_f
-    return MathViz::Infinity unless @a.to_f.finite?
-    @a.to_f.__send__(@op)
-  end
-
-  # Forward to contained value
-  def units
-    @a.units
-  end
-
-  # Forward to contained value
-  def constant?
-    @a.constant?
-  end
-end
-
-# Display and processing for two-value operators
-class MathViz::Operation::Binary < MathViz::Operation
-  def initialize(a, op, b)
+  def initialize(op, *operands)
     super()
-    @a = term(a)
     @op = op
-    @b = term(b)
+    @operands = operands.map{|x| MathViz.term(x)}
   end
 
   # Debugging method; returns string of names and values
   def long
     n = @name && (@name + " = ")
-    "(#{n}#{@a} #{@op} #{@b} = #{to_f})"
+    "(#{n}#{@op} #{@operands.join(',')} = #{to_value})"
   end
 
   # Graphviz node shape; differentiates comparison operators
@@ -567,27 +594,64 @@ class MathViz::Operation::Binary < MathViz::Operation
     end
   end
 
+  # Draws edges, and ensure the from nodes is drawn
+  def link_from(g, other, style, label)
+    if label
+      (g[other.to_s] >> g[node]) [:arrowhead => style, :headlabel => @op.to_s, :labeldistance => '2']
+    else
+      (g[other.to_s] >> g[node]) [:arrowhead => style]
+    end
+    other.to_dot(g) unless other.generated?
+  end
+
   # Extend Graphviz g with a representation of this object, and incoming connections
   def to_dot(g)
     super
-    (g[@a.node] >> g[node]) [:arrowhead => :normal, :headlabel => @op.to_s, :labeldistance => '2']
-    (g[@b.node] >> g[node]) [:arrowhead => :onormal]
-    @a.to_dot(g) if (@a.respond_to?(:name) && @a.name.nil?)
-    @b.to_dot(g) if (@b.respond_to?(:name) && @b.name.nil?)
+    link_from(g, @operands.first, :normal, false)
+    @operands.slice(1..-1).each {|x| link_from(g, x, :onormal, true)}
   end
 
   # Apply the operator to create the derived value.
-  def to_f
-    @a.to_f.__send__(@op, @b.to_f)
+  def to_value
+    return MathViz::Infinity unless finite?
+    @operands.map(&:to_value).reduce(&@op)
   end
 
   # Apply the operator to create the derived units.
   def units
-    @a.units.__send__(@op, @b.units)
+    @operands.map(&:units).reduce(&@op)
   end
 
-  # True only if both operands are #constant?
   def constant?
-    @a.constant? && @b.constant?
+    @operands.all?(&:constant?)
+  end
+
+  def finite?
+    @operands.all?(&:finite?)
+  end
+
+  # Combine anonymous nodes with the same operator to simply graph
+  def collapse(parentop = nil)
+    @operands = @operands.flat_map {|x| x.collapse(@op)}
+    if anonymous? && parentop == @op
+      @operands
+    else
+      [self]
+    end
+  end
+end
+
+# Special cases for unary operators
+class MathViz::Operation::Unary < MathViz::Operation
+  # Apply the operator to create the derived value.
+  def to_value
+    return MathViz::Infinity unless finite?
+    @operands.map(&:to_value).map(&@op).first
+  end
+
+  # Extend Graphviz g with a representation of this object, and incoming connections
+  def to_dot(g)
+    super
+    @operands.each {|x| link_from(g, x, :normal, true)}
   end
 end

data/spec/operation_spec.rb

@@ -5,7 +5,11 @@ module MathViz::Units
 end
 
 describe MathViz::Operation do
-  describe MathViz::Operation::Unary do
+  describe 'unary' do
+    it "does something" do
+      (MathViz::Constant.new(0.5).floor).data.should == "0"
+    end
+
     it "can floor infinity" do
       (MathViz::Constant.new(1.0/0).floor).data.should == "Infinity"
     end
@@ -15,7 +19,7 @@ describe MathViz::Operation do
     end
   end
 
-  describe MathViz::Operation::Binary do
+  describe 'binary' do
     it "reports ints as ints" do
       (MathViz::Constant.new(1) * 2).data.should == "2"
     end

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 begin
-  require 'spec'
+  require 'rspec'
 rescue LoadError
   require 'rubygems' unless ENV['NO_RUBYGEMS']
   gem 'rspec'
-  require 'spec'
+  require 'rspec'
 end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')

data/tasks/idocs.rake

@@ -1,4 +1,9 @@
-task :idocs => [:redocs, 'README.rdoc', 'examples/E_mc2.png']  do |t|
-  mkdir 'doc/examples'
+task :idocs => [:redocs, 'README.rdoc', 'examples/E_mc2.png', 'doc/examples']  do |t|
   cp 'examples/E_mc2.png', 'doc/examples/'
 end
+
+directory 'doc/examples'
+
+task :redocs => [:clobber_docs] do |t|
+  sh 'rdoc lib README.rdoc'
+end

metadata

@@ -1,79 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mathviz
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Justin Love
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-04 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: GraphvizR
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.5.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: newgem
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        - 2
-        version: 2.6.2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
   type: :development
-  version_requirements: *id003
-description: Turn simple equations (a = b * c) into GraphViz dot files showing relationships, values, and units.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Turn simple equations (a = b * c) into GraphViz dot files showing relationships,
+  values, and units.
+email:
 - git@JustinLove.name
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.rdoc
-files: 
+files:
 - History.txt
 - Manifest.txt
 - README.rdoc
@@ -82,6 +94,7 @@ files:
 - examples/E_mc2.rb
 - examples/dc.rb
 - examples/first.rb
+- examples/tax.rb
 - lib/mathviz.rb
 - spec/measurable_spec.rb
 - spec/measured_spec.rb
@@ -89,38 +102,32 @@ files:
 - spec/spec_helper.rb
 - spec/unit_spec.rb
 - tasks/idocs.rake
-has_rdoc: true
+- .gemtest
 homepage: http://github.com/JustinLove/mathviz
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mathviz
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Turn simple equations (a = b * c) into GraphViz dot files showing relationships, values, and units.
+summary: Turn simple equations (a = b * c) into GraphViz dot files showing relationships,
+  values, and units.
 test_files: []
-