binomial 0.1.0 → 0.1.1

data/README.md

@@ -1,5 +1,6 @@
 # Binomial   
-Binomial is a ruby gem for quickly calculating probabilities that are modelled by the [Binomial Theorem](http://en.wikipedia.org/wiki/Binomial_theorem).   
+Binomial is a ruby gem for quickly calculating probabilities that are modeled by the [Binomial Theorem](http://en.wikipedia.org/wiki/Binomial_theorem).   
+The master branch of this repo may be rather buggy at times. For a stable version, use `gem install binomial` or download a tagged version.   
 ## Usage
 
 ```ruby
@@ -13,6 +14,5 @@ calc.calculate
 ```
 
 ## Todo   
--   Add support for cumulative binomial probabilities (X > 5, X ≤ 7, etc)   
--   TESTING!
--   Documentation
+Check the [Issue Tracker](https://github.com/loddy1234/binomial/issues) for an idea of what I think needs doing. 
+Feel free to add your own improvements! :smile:   

data/Rakefile

@@ -69,12 +69,7 @@ end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-desc "Open an irb session preloaded with this library"
-task :irb do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
+  sh "irb -Ilib -r ./lib/#{name}.rb"
 end
 
 desc "Open an pry session preloaded with this library"

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.0'
-  s.date              = '2012-11-12'
+  s.version           = '0.1.1'
+  s.date              = '2012-12-01'
   s.rubyforge_project = 'binomial'
 
   ## Make sure your summary is short. The description may be as long
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   ## Specify any RDoc options here. You'll want to add your README and
   ## LICENSE files to the extra_rdoc_files list.
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.md]
+  s.extra_rdoc_files = %w[README.md LICENSE]
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
@@ -60,7 +60,9 @@ Gem::Specification.new do |s|
     binomial.gemspec
     lib/binomial.rb
     lib/binomial/calculator.rb
+    lib/binomial/cumulative_calculator.rb
     lib/binomial/integer.rb
+    spec/calculator_spec.rb
   ]
   # = MANIFEST =
 

data/lib/binomial/calculator.rb

@@ -1,17 +1,35 @@
+require 'binomial/integer'
 module Binomial
   # Params:
   #   - trials:         Total number of trials conducted
   #   - probability:    The probability of one success
   #   - target:         The desired amount of successes
   class Calculator
-    ATTRS = [:trials, :probability, :target]
-    ATTRS.each do |attribute|
-      self.send(:attr_accessor, attribute)
-    end
+    attr_accessor :trials, :probability, :target
 
     def initialize(params = {})
-      ATTRS.each do |attribute|
-        instance_eval "@#{attribute.to_s} = params[:#{attribute.to_s}]"
+      @trials = params[:trials]
+      @probability = params[:probability]
+      @target = params[:target]
+
+      if @trials <= 0
+        raise "Error: trials[#{@trials}] must be > 0"
+      end
+
+      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
+
+      if @trials < @target
+        raise "Error: target[#{@target}] must be < trials[#{@trials}]"
       end
     end
 

data/lib/binomial/cumulative_calculator.rb

@@ -0,0 +1,43 @@
+require 'binomial/calculator'
+
+module Binomial
+  class CumulativeCalculator < Calculator
+    attr_accessor :sign
+
+    # sign: P(X {{sign}} {{target}}) 
+    #       The probability X is [equal to, less than, greater than, etc] the 
+    #       target when X = number of successes
+    def initialize(params = {})
+      super
+      @sign = params[:sign]
+    end
+
+    def calculate
+      total = 0
+      case @sign
+      when :equals
+        super
+      when :less_than
+        calc_cumulative @target - 1
+      when :less_than_or_equal_to
+        calc_cumulative @target
+      when :greater_than
+        1 - calc_cumulative(@target)
+      when :greater_than_or_equal_to
+        1 - calc_cumulative(@target - 1)
+      else
+        p "Case not handled?!"
+      end
+    end
+
+    def calc_cumulative(up_to)
+      total = 0.0
+      while up_to >= 0 do
+        calc = Calculator.new trials: @trials, probability: @probability, target: up_to
+        total += calc.calculate
+        up_to -= 1
+      end
+      total
+    end
+  end
+end

data/lib/binomial.rb

@@ -1,6 +1,5 @@
-require 'binomial/integer'
-require 'binomial/calculator'
+require 'binomial/cumulative_calculator'
 
 module Binomial
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/calculator_spec.rb

@@ -0,0 +1,75 @@
+require 'binomial'
+
+describe "Binomial::Calculator" do
+  describe "calculate" do
+    it "should validate probability is > 0" do
+      expect {
+        Binomial::Calculator.new(
+          :trials       => 10,
+          :probability  => 0,
+          :target       => 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
+    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
+    end
+
+    it "should validate target < trials" do
+      expect {
+        Binomial::Calculator.new(
+          :trials       => 10,
+          :probability  => 0.2,
+          :target       => 11
+        ).calculate
+      }.to raise_error
+    end
+
+    it "should succeed if target < trials" do
+      expect {
+        Binomial::Calculator.new(
+          :trials       => 10,
+          :probability  => 0.2,
+          :target       => 3
+        ).calculate
+      }.to_not raise_error
+    end
+
+    it "should validate target > 0" do
+      expect {
+        Binomial::Calculator.new(
+          :trials       => 10,
+          :probability  => 0.2,
+          :target       => 0
+        ).calculate
+      }.to raise_error
+    end
+
+    it "should succeed if target > 0" do
+      expect {
+        Binomial::Calculator.new(
+          :trials       => 10,
+          :probability  => 0.2,
+          :target       => 3
+        ).calculate
+      }.to_not raise_error
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binomial
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies: []
 description: A gem for calculating probabilities modelled by the binomial theorem.
 email: lewis.odriscoll@gmail.com
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- LICENSE
 files:
 - LICENSE
 - README.md
@@ -24,7 +25,9 @@ files:
 - binomial.gemspec
 - lib/binomial.rb
 - lib/binomial/calculator.rb
+- lib/binomial/cumulative_calculator.rb
 - lib/binomial/integer.rb
+- spec/calculator_spec.rb
 homepage: ''
 licenses: []
 post_install_message: