fathom 0.2.2 → 0.2.3

data/spec/fathom/enforced_name_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Fathom::Distributions
+
+class DemoEnforcedNameNode < Node
+  include EnforcedName
+end
+
+describe EnforcedName do
+  
+  it "should ensure that we have a name as a UID if one is not provided" do
+    n = DemoEnforcedNameNode.new
+    n.name.should_not be_nil
+  end
+end

data/spec/fathom/monte_carlo_set_spec.rb

@@ -17,7 +17,7 @@ describe MonteCarloSet do
     end
     
     @fields = [:commissions_paid, :gross_margins, :revenue]
-    @summary_fields = [:coefficient_of_variation, :max, :mean, :min, :sd]
+    @summary_fields = [:coefficient_of_variation, :lower_bound, :max, :mean, :min, :sd, :upper_bound]
   end
   
   before do
@@ -90,6 +90,17 @@ describe MonteCarloSet do
     @mcs.process(2)
     @mcs.revenue_summary.should eql(@mcs.summary(:revenue))
   end
+  
+  it "should allow the model to be able to produce non-array values" do
+    margin_description = ValueDescription.new(@q1_sales) do |s|
+      {
+        :description => {:first_quarter_sales => s.first_quarter_sales, :first_quarter_prices => s.first_quarter_prices}
+      }
+    end
+    mcs = MonteCarloSet.new(margin_description)
+    lambda{mcs.process(2)}.should_not raise_error
+    lambda{mcs.summary}.should_not raise_error
+  end
 end
 
 def sort_array_of_symbols(array)

data/spec/fathom/node_spec.rb

@@ -0,0 +1,129 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Fathom
+
+describe Node do
+  it "should take an options hash to instantiate" do
+    lambda{Node.new(:any_value => true)}.should_not raise_error
+  end
+  
+  it "should take an optional name parameter" do
+    node = Node.new(:name => "My Name")
+    node.name.should eql("My Name")
+  end
+  
+  it "should take an optional distribution parameter" do
+    node = Node.new(:distribution => Fathom::Distributions::Gaussian)
+    node.distribution.should eql(Fathom::Distributions::Gaussian)
+  end
+  
+  it "should default to the standard distribution" do
+    node = Node.new
+    node.distribution.should eql(Fathom::Distributions::Gaussian)
+  end
+  
+  it "should be able to take a symbol and find the appropriate distribution" do
+    node = Node.new(:distribution => :gaussian)
+    node.distribution.should eql(Fathom::Distributions::Gaussian)
+  end
+  
+  it "should take an optional description" do
+    node = Node.new(:description => "some description")
+    node.description.should eql('some description')
+  end
+  
+  it "should take an optional values parameter" do
+    node = Node.new(:values => [1,2,3])
+    node.values.should eql([1,2,3])
+  end
+  
+  it "should provide name_sym, if a name is defined" do
+    node = Node.new(:name => "Some name")
+    node.name_sym.should eql(:some_name)
+  end
+  
+  it "should change dashes to underscores for name_sym" do
+    node = Node.new(:name => "Some-name")
+    node.name_sym.should eql(:some_name)
+  end
+  
+  it "should take an optional parents list" do
+    n1 = Node.new
+    n2 = Node.new(:parents => [n1])
+    n2.parents.should eql([n1])
+  end
+  
+  it "should allow a single node as a parent or parents and turn it into an array" do
+    n1 = Node.new
+    n2 = Node.new(:parents => n1)
+    n2.parents.should eql([n1])
+    n2 = Node.new(:parent => n1)
+    n2.parents.should eql([n1])
+  end
+  
+  it "should create an empty list of parents by default" do
+    n1 = Node.new
+    n1.parents.should eql([])
+  end
+  
+  it "should be able to add a parent" do
+    n1, n2 = Node.new, Node.new
+    n3 = Node.new(:parent => n2)
+    n3.add_parent(n1)
+    n3.parents.should eql([n2, n1])
+  end
+  
+  it "should register the receiving node when adding a parent" do
+    n1 = Node.new
+    n1.should_receive(:register_child).and_return(true)
+    n2 = Node.new(:parent => n1)
+
+    n1 = Node.new
+    n1.should_receive(:register_child).and_return(true)
+    n2 = Node.new
+    n2.add_parent(n1)
+  end
+
+  it "should not allow a parent to be registered if it is not a child of the other node" do
+    n1 = Node.new
+    n2 = Node.new
+    lambda{n2.register_parent(n1)}.should raise_error
+  end
+
+  it "should take an optional children list" do
+    n1 = Node.new
+    n2 = Node.new(:children => [n1])
+    n2.children.should eql([n1])
+  end
+  
+  it "should allow a single node as a child or children and turn it into an array" do
+    n1 = Node.new
+    n2 = Node.new(:children => n1)
+    n2.children.should eql([n1])
+    n2 = Node.new(:child => n1)
+    n2.children.should eql([n1])
+  end
+  
+  it "should create an empty list of children by default" do
+    n1 = Node.new
+    n1.children.should eql([])
+  end
+  
+  it "should register the receiving node when adding a child" do
+    n1 = Node.new
+    n1.should_receive(:register_parent).and_return(true)
+    n2 = Node.new(:child => n1)
+
+    n1 = Node.new
+    n1.should_receive(:register_parent).and_return(true)
+    n2 = Node.new
+    n2.add_child(n1)
+  end
+  
+  it "should not allow a child to be registered if it is not a parent of the other node" do
+    n1 = Node.new
+    n2 = Node.new
+    lambda{n2.register_child(n1)}.should raise_error
+  end
+
+end

data/spec/fathom/numeric_methods_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Fathom
+
+describe NumericMethods do
+  
+  before(:all) do
+    @values = [1,2,3]
+    @vector = GSL::Vector.ary_to_gv(@values)
+    @opts = {:values => @values}
+  end
+  
+  before do
+    @n = DummyNumericNode.new(@opts)
+  end
+  
+  it "should respond to a rand method" do
+    @n = DummyNumericNode.new
+    @n.should be_respond_to(:rand)
+  end
+  
+  it "should be able to construct a vector from the values" do
+    @n.vector.should ==(@vector)
+  end
+  
+  it "should have a standard deviation if it has a vector" do
+    @n.standard_deviation.should eql(@vector.sd)
+  end
+  
+  it "should have std and sd aliases for standard deviation" do
+    @n.sd.should eql(@n.standard_deviation)
+    @n.std.should eql(@n.standard_deviation)
+  end
+  
+  it "should not raise an error when looking for a standard deviation and there is no vector" do
+    @n = DummyNumericNode.new
+    @n.vector.should be_nil
+    @n.sd.should be_nil
+  end
+  
+  it "should have a mean if it has a vector" do
+    @n.mean.should eql(@vector.mean)
+  end
+  
+  it "should return nil for mean if it doesn't have a vector" do
+    @n = DummyNumericNode.new
+    @n.mean.should be_nil
+  end
+  
+  it "should provide rand, if it has a vector" do
+    Gaussian.should_receive(:rand).and_return(0.5)
+    @n.rand
+  end
+  
+  it "should return nil for rand if it doesn't have a vector" do
+    @n = DummyNumericNode.new
+    @n.mean.should be_nil
+  end
+  
+  it "should be able to calculate the inverse_cdf, lower_bound, upper_bound and interval_values" do
+    lambda{@n.inverse_cdf}.should_not raise_error
+    lambda{@n.lower_bound}.should_not raise_error
+    lambda{@n.upper_bound}.should_not raise_error
+    lambda{@n.interval_values}.should_not raise_error
+  end
+  
+  it "should pass the mean and standard deviation to the distribution when calculating an inverse_cdf" do
+    @n.inverse_cdf.should eql(Gaussian.inverse_cdf(:mean => @n.mean, :sd => @n.sd))
+  end
+
+  it "should pass the mean and standard deviation to the distribution when calculating an lower_bound" do
+    @n.lower_bound.should eql(Gaussian.lower_bound(:mean => @n.mean, :sd => @n.sd))
+  end
+
+  it "should pass the mean and standard deviation to the distribution when calculating an upper_bound" do
+    @n.upper_bound.should eql(Gaussian.upper_bound(:mean => @n.mean, :sd => @n.sd))
+  end
+
+  it "should pass the mean and standard deviation to the distribution when calculating an interval_values" do
+    @n.interval_values.should eql(Gaussian.interval_values(:mean => @n.mean, :sd => @n.sd))
+  end
+end

data/spec/fathom/plausible_range_spec.rb

@@ -67,9 +67,8 @@ describe PlausibleRange do
     @pr.midpoint.should eql(5.5)
   end
   
-  # TODO: Make this more accurate when we start using the GSL stuff more
   it "should be able to calculate the standard deviation" do
-    @pr.standard_deviation.should be_close(2.73556231003039, 0.00000001)
+    @pr.standard_deviation.should be_close( 2.7358, 0.0001)
   end
   
   it "should be able to use std instead of standard_deviation" do

data/spec/support/dummy_numeric_node.rb

@@ -0,0 +1,8 @@
+module Fathom
+  module Distributions
+    class DummyNumericNode < Node
+      include NumericMethods
+    end
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fathom
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - David
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 -07:00
+date: 2010-11-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODO.md
 - VERSION
 - autotest/discover.rb
 - lib/fathom.rb
@@ -63,21 +64,27 @@ files:
 - lib/fathom/archive/node.rb
 - lib/fathom/archive/noodle.rb
 - lib/fathom/archive/scratch.rb
-- lib/fathom/basic_node.rb
 - lib/fathom/causal_graph.rb
-- lib/fathom/combined_plausibilities.rb
 - lib/fathom/concept.rb
 - lib/fathom/data_node.rb
+- lib/fathom/distributions.rb
+- lib/fathom/distributions/discrete_gaussian.rb
+- lib/fathom/distributions/discrete_uniform.rb
+- lib/fathom/distributions/gaussian.rb
+- lib/fathom/distributions/uniform.rb
+- lib/fathom/enforced_name.rb
 - lib/fathom/ext/array.rb
 - lib/fathom/ext/faster_csv.rb
 - lib/fathom/ext/open_struct.rb
+- lib/fathom/ext/string.rb
 - lib/fathom/import.rb
 - lib/fathom/import/csv_import.rb
 - lib/fathom/import/yaml_import.rb
 - lib/fathom/inverter.rb
 - lib/fathom/knowledge_base.rb
 - lib/fathom/monte_carlo_set.rb
-- lib/fathom/node_utilities.rb
+- lib/fathom/node.rb
+- lib/fathom/numeric_methods.rb
 - lib/fathom/plausible_range.rb
 - lib/fathom/simulation.rb
 - lib/fathom/simulation/tick_methods.rb
@@ -89,11 +96,18 @@ files:
 - spec/fathom/agent/agent_cluster_spec.rb
 - spec/fathom/agent_spec.rb
 - spec/fathom/data_node_spec.rb
+- spec/fathom/distributions/discrete_gaussian_spec.rb
+- spec/fathom/distributions/discrete_uniform_spec.rb
+- spec/fathom/distributions/gaussian_spec.rb
+- spec/fathom/distributions/uniform_spec.rb
+- spec/fathom/enforced_name_spec.rb
 - spec/fathom/import/csv_import_spec.rb
 - spec/fathom/import/yaml_import_spec.rb
 - spec/fathom/import_spec.rb
 - spec/fathom/knowledge_base_spec.rb
 - spec/fathom/monte_carlo_set_spec.rb
+- spec/fathom/node_spec.rb
+- spec/fathom/numeric_methods_spec.rb
 - spec/fathom/plausible_range_spec.rb
 - spec/fathom/simulation/tick_simulation_spec.rb
 - spec/fathom/simulation_spec.rb
@@ -102,6 +116,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/demo.yml
 - spec/support/demo_agent.rb
+- spec/support/dummy_numeric_node.rb
 has_rdoc: true
 homepage: http://github.com/davidrichards/fathom
 licenses: []
@@ -140,11 +155,18 @@ test_files:
 - spec/fathom/agent/agent_cluster_spec.rb
 - spec/fathom/agent_spec.rb
 - spec/fathom/data_node_spec.rb
+- spec/fathom/distributions/discrete_gaussian_spec.rb
+- spec/fathom/distributions/discrete_uniform_spec.rb
+- spec/fathom/distributions/gaussian_spec.rb
+- spec/fathom/distributions/uniform_spec.rb
+- spec/fathom/enforced_name_spec.rb
 - spec/fathom/import/csv_import_spec.rb
 - spec/fathom/import/yaml_import_spec.rb
 - spec/fathom/import_spec.rb
 - spec/fathom/knowledge_base_spec.rb
 - spec/fathom/monte_carlo_set_spec.rb
+- spec/fathom/node_spec.rb
+- spec/fathom/numeric_methods_spec.rb
 - spec/fathom/plausible_range_spec.rb
 - spec/fathom/simulation/tick_simulation_spec.rb
 - spec/fathom/simulation_spec.rb
@@ -152,3 +174,4 @@ test_files:
 - spec/fathom_spec.rb
 - spec/spec_helper.rb
 - spec/support/demo_agent.rb
+- spec/support/dummy_numeric_node.rb

data/lib/fathom/combined_plausibilities.rb

@@ -1,12 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'fathom'))
-module Fathom
-  class CombinedPlausibilities
-    
-  end
-end
-
-if __FILE__ == $0
-  include Fathom
-  # TODO: Is there anything you want to do to run this file on its own?
-  # CombinedPlausibilities.new
-end

data/lib/fathom/node_utilities.rb

@@ -1,8 +0,0 @@
-module Fathom
-  module NodeUtilities
-    def name_sym
-      return nil unless self.name
-      @name_sym ||= self.name.to_s.downcase.gsub(/\s+/, '_').to_sym
-    end
-  end
-end