binomial 0.1.1 → 0.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Rakefile

@@ -54,8 +54,8 @@ end
 
 desc "Generate SimpleCov test coverage and open in your browser"
 task :coverage do
-  sh "rm -fr coverage"
-  sh "ruby -e \"require 'simplecov'\; SimpleCov.start\" "
+  ENV['COVERAGE'] = 'true'
+  Rake::Task["spec"].execute
   sh "open coverage/index.html"
 end
 
@@ -83,7 +83,25 @@ end
 #
 #############################################################################
 
+namespace :clean do
+  desc "Deletes the files generated by SimpleCov"
+  task :coverage do
+    sh "rm -rf coverage"
+  end
+
+  desc "Remove RDoc HTML files"
+  task :docs do
+    Rake::Task["clobber_rdoc"].invoke
+  end
+
+  desc "Delete all built versions of the gem"
+  task :built do
+    sh "rm -rf pkg"
+  end
+end
 
+desc "Delete SimpleCov reports, RDoc HTML and built versions"
+task :clean => ["clean:coverage", "clean:docs", "clean:built"]
 
 #############################################################################
 #

data/binomial.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'binomial'
-  s.version           = '0.1.1'
-  s.date              = '2012-12-01'
+  s.version           = '0.1.2'
+  s.date              = '2012-12-04'
   s.rubyforge_project = 'binomial'
 
   ## Make sure your summary is short. The description may be as long
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    Gemfile
     LICENSE
     README.md
     Rakefile
@@ -63,10 +64,16 @@ Gem::Specification.new do |s|
     lib/binomial/cumulative_calculator.rb
     lib/binomial/integer.rb
     spec/calculator_spec.rb
+    spec/cumulative_calculator_spec.rb
+    spec/integer_spec.rb
+    spec/spec_helper.rb
   ]
   # = MANIFEST =
 
   ## Test files will be grabbed from the file list. Make sure the path glob
   ## matches what you actually use.
   s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
 end

data/lib/binomial.rb

@@ -1,5 +1,5 @@
 require 'binomial/cumulative_calculator'
 
 module Binomial
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/binomial/calculator.rb

@@ -12,25 +12,20 @@ module Binomial
       @probability = params[:probability]
       @target = params[:target]
 
-      if @trials <= 0
-        raise "Error: trials[#{@trials}] must be > 0"
-      end
+      check_positive(:@trials)
+      check_positive(:@target)
+      check_positive(:@probability)
 
-      if @target <= 0
-        raise "Error: target[#{@target}] must be > 0"
-      end
-
-      if @probability <= 0
-        raise "Error: probability[#{@probability}] must be > 0"
-      end
-
-      if @probability > 1
-        raise "Error: probability[#{@probability}] must be <= 1"
-      end
+      @probability <= 1  or raise "Error: probability[#{@probability}] must be <= 1"
+      @trials >= @target or raise "Error: target[#{@target}] must be < trials[#{@trials}]"
+    end
 
-      if @trials < @target
-        raise "Error: target[#{@target}] must be < trials[#{@trials}]"
-      end
+    # param: name of instance variable WITH leading @
+    def check_positive(inst_var)
+      value = instance_variable_get(inst_var)
+      var_name = inst_var.to_s.delete('@')
+      value > 0 or
+        raise "Error: '#{var_name}' must be > 0, but was: #{value}"
     end
 
     def model
@@ -39,8 +34,7 @@ module Binomial
 
     # A representation of the equation performed
     def equation
-      "P(X=#{@target}) = #{@trials}C#{@target} * #{@probability}^#{@target} *"
-      + " #{1 - @probability}^#{@trials - @target} = #{calculate().to_s}"
+      "P(X=#{@target}) = #{@trials}C#{@target} * #{@probability}^#{@target} * #{1 - @probability}^#{@trials - @target} = #{calculate}"
     end
 
     # Calculates the result

data/lib/binomial/cumulative_calculator.rb

@@ -26,13 +26,13 @@ module Binomial
       when :greater_than_or_equal_to
         1 - calc_cumulative(@target - 1)
       else
-        p "Case not handled?!"
+        raise "Error: invalid sign '#{@sign.to_s}' supplied"
       end
     end
 
     def calc_cumulative(up_to)
       total = 0.0
-      while up_to >= 0 do
+      while up_to > 0 do
         calc = Calculator.new trials: @trials, probability: @probability, target: up_to
         total += calc.calculate
         up_to -= 1

data/spec/calculator_spec.rb

@@ -1,48 +1,39 @@
+require 'spec_helper'
 require 'binomial'
 
 describe "Binomial::Calculator" do
   describe "calculate" do
+    def binom_calc(trials,prob,target)
+      Binomial::Calculator.new(
+        :trials => trials,
+        :probability => prob,
+        :target => target
+      )
+    end
+
     it "should validate probability is > 0" do
-      expect {
-        Binomial::Calculator.new(
-          :trials       => 10,
-          :probability  => 0,
-          :target       => 3
-        ).calculate
-      }.to raise_error
+      expect { binom_calc(10,0,3).calculate }.to raise_error
     end
 
     it "should validate probability is < 1" do
-      expect {
-        Binomial::Calculator.new(
-          :trials       => 10,
-          :probability  => 1.1,
-          :target       => 3
-        ).calculate
-      }.to raise_error
+      expect { binom_calc(10,1.1,3).calculate }.to raise_error
     end
 
     it "should succeed if probability is >0 and <1" do
-      expect {
-        Binomial::Calculator.new(
-          :trials       => 10,
-          :probability  => 0.2,
-          :target       => 3
-        ).calculate
-      }.to_not raise_error
+      expect { binom_calc(10, 0.2, 3).calculate }.to_not raise_error
     end
 
-    it "should validate target < trials" do
+    it "should validate trial > 0" do
       expect {
         Binomial::Calculator.new(
-          :trials       => 10,
+          :trials       => 0,
           :probability  => 0.2,
-          :target       => 11
+          :target       => 1
         ).calculate
       }.to raise_error
     end
 
-    it "should succeed if target < trials" do
+    it "should succeed if trial > 0" do
       expect {
         Binomial::Calculator.new(
           :trials       => 10,
@@ -52,24 +43,45 @@ describe "Binomial::Calculator" do
       }.to_not raise_error
     end
 
+    it "should validate target < trials" do
+      expect { binom_calc(10, 0.2, 11).calculate }.to raise_error
+    end
+
+    it "should succeed if target < trials" do
+      expect { binom_calc(10, 0.2, 3).calculate }.to_not raise_error
+    end
+
     it "should validate target > 0" do
+      expect { binom_calc(10, 0.2, 0).calculate }.to raise_error
+    end
+
+    it "should succeed if target > 0" do
+      expect { binom_calc(10, 0.2, 3).calculate }.to_not raise_error
+    end
+
+    it "should print out a representation of the equation performed" do
       expect {
         Binomial::Calculator.new(
-          :trials       => 10,
-          :probability  => 0.2,
-          :target       => 0
-        ).calculate
-      }.to raise_error
+          :trials       => 2,
+          :probability  => 0.5,
+          :target       => 2
+        ).equation
+      }.to_not raise_error
     end
 
-    it "should succeed if target > 0" do
+    it "should print out a representation of the model" do
       expect {
         Binomial::Calculator.new(
-          :trials       => 10,
-          :probability  => 0.2,
-          :target       => 3
-        ).calculate
+          :trials       => 2,
+          :probability  => 0.5,
+          :target       => 2
+        ).model
       }.to_not raise_error
     end
+
+    it "should produce the correct results" do
+      binom_calc(2,0.5,2).calculate.should == 0.25
+      binom_calc(2,0.5,1).calculate.should == 0.5
+    end
   end
 end

data/spec/cumulative_calculator_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'binomial'
+
+describe "Binomial::CumulativeCalculator" do
+  describe "calculate" do
+    def binom_calc(sign, trials, prob, target)
+      Binomial::CumulativeCalculator.new(
+        :sign => sign,
+        :trials => trials,
+        :probability => prob,
+        :target => target
+      )
+    end
+
+    it "should validate probability is > 0" do
+      expect {
+        binom_calc(:equals, 10, 0, 3).calculate
+      }.to raise_error
+    end
+
+    it "should validate probability is < 1" do
+      expect {
+        binom_calc(:equals, 10, 1.1, 3).calculate
+      }.to raise_error
+    end
+
+    it "should succeed if probability is >0 and <1" do
+      expect {
+        binom_calc(:equals, 10, 0.2, 3).calculate
+      }.to_not raise_error
+    end
+
+    it "should validate trial > 0" do
+      expect {
+        binom_calc(:equals, 0, 0.2, 1).calculate
+      }.to raise_error
+    end
+
+    it "should succeed if trial > 0" do
+      expect {
+        binom_calc(:equals, 10, 0.2, 3).calculate
+      }.to_not raise_error
+    end
+
+    it "should validate target < trials" do
+      expect {
+        binom_calc(:equals, 10, 0.2, 11).calculate
+      }.to raise_error
+    end
+
+    it "should succeed if target < trials" do
+      expect {
+        binom_calc(:equals, 10, 0.2, 3).calculate
+      }.to_not raise_error
+    end
+
+    it "should validate target > 0" do
+      expect {
+        binom_calc(:equals, 10, 0.2, 0).calculate
+      }.to raise_error
+    end
+
+    it "should succeed if target > 0" do
+      expect {
+        binom_calc(:equals, 10, 0.2, 3).calculate
+      }.to_not raise_error
+    end
+
+    it "should print out a representation of the equation performed" do
+      expect {
+        binom_calc(:equals, 2, 0.5, 2).equation
+      }.to_not raise_error
+    end
+
+    it "should print out a representation of the model" do
+      expect {
+        binom_calc(:equals, 2, 0.5, 2).model
+      }.to_not raise_error
+    end
+
+    it "should raise an exception when sign not recognized" do
+      expect {
+        binom_calc('=', 2, 0.5, 2).calculate
+      }.to raise_error
+    end
+
+    it "should produce the correct cumulative results" do
+      binom_calc(:equals, 2, 0.5, 2).calculate.should == 0.25
+    end
+
+    it "should produce the correct cumulative results with less_than" do
+      binom_calc(:less_than, 5, 0.5, 5).calculate.should == 0.9375
+    end
+
+    it "should produce the correct cumulative results with less_than_or_equal" do
+      binom_calc(:less_than_or_equal_to, 5, 0.5, 5).calculate.should == 0.96875
+    end
+
+    it "should produce the correct cumulative results with greater_than" do
+      binom_calc(:greater_than, 5, 0.5, 5).calculate.should == 0.03125
+    end
+
+    it "should produce the correct cumulative results with greater_than_or_equal" do
+      binom_calc(:greater_than_or_equal_to, 5, 0.5, 5).calculate.should == 0.0625
+    end
+  end
+end

data/spec/integer_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'binomial'
+
+describe "Integer" do
+  describe "#choose" do
+
+    it("should be correct when n is 0") { 0.choose(13).should == 0 }
+    it("should be correct when k is 0") { 5.choose(0).should == 1 }
+    it("should be correct when n and k are 0") { 0.choose(0).should == 1 }
+
+    it("should be correct when n is large") do
+      59922092947261214857303164514091691.choose(7).should ==
+        550399817117861542559553374183305880444453789686940825844792654274423774740226138320805430744153144877776025703863504009266563916236130288377323887215902973940458468633181977032752322590578526112480717050575426228710841090337272655324460690
+    end
+
+    it("should be correct when k is large") do
+      pending "algorithm is too slow"
+      11.choose(314159)
+        .should == 0
+    end
+
+    it("should be correct when n and k are equal") do
+      314.choose(314).should == 1
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start if ENV["COVERAGE"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binomial
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
-dependencies: []
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem for calculating probabilities modelled by the binomial theorem.
 email: lewis.odriscoll@gmail.com
 executables: []
@@ -19,6 +51,7 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -28,6 +61,9 @@ files:
 - lib/binomial/cumulative_calculator.rb
 - lib/binomial/integer.rb
 - spec/calculator_spec.rb
+- spec/cumulative_calculator_spec.rb
+- spec/integer_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: