croupier 1.3.0 → 1.4.0

data/README.md

@@ -34,6 +34,8 @@ where:
 
 Current version implements the following distributions: 
 
+* Bernoulli
+* Binomial
 * Cauchy
 * Exponential
 * Geometric
@@ -65,6 +67,18 @@ And then use the the distribution you want to generate the sample. You can get j
     dist.generate_sample(100) #=> returns an array of 100 random numbers following an exponential with rate 1.7
     dist.generate_number #=> returns one random number following an exponential with rate 1.7
 
+It's posible to instantiate each Distribution class directly:
+
+    dist = Croupier::Distributions::Exponential.new(:lambda => 1.7)
+
+or calling Distributions methods:
+
+    dist = Croupier::Distributions.exponential :lambda => 1.7
+
+To get a list of all available distributions/methods in Distributions module call ```list```
+
+    Croupier::Distributions.list
+
 ## How to generate a distribution.
 
 There are several ways. The easiest one is to override ```generate_number``` or ```generate_sample``` (one is enough).

data/lib/croupier.rb

@@ -1,6 +1,8 @@
+require 'croupier/version'
 require 'croupier/cli/trollop'
 require 'croupier/exceptions'
 require 'croupier/distribution'
+require 'croupier/distributions'
 Dir[File.join(File.dirname(__FILE__), "./croupier/distributions/*.rb")].each {|f| require f}
 require 'croupier/cli/application'
 #####################################################################

data/lib/croupier/cli/application.rb

@@ -13,13 +13,10 @@ module Croupier
       # It Checks and loads the available distributions.
       def initialize
         @distribution_list, @distributions_options = {}, {}
-        ::Croupier::Distributions.constants.each{|distrib|
-          d = ::Croupier::Distributions.const_get(distrib)
-          if d.is_a?(Class) && d.superclass == Croupier::Distribution
-            @distribution_list[d.cli_name] = d
-            @distributions_options[d.cli_name] = d.cli_options
-          end
-        }
+        ::Croupier::Distributions.all.each do |d|
+          @distribution_list[d.cli_name] = d
+          @distributions_options[d.cli_name] = d.cli_options
+        end
       end
 
       # Run the Croupier application. The run method performs the following steps:
@@ -39,6 +36,7 @@ module Croupier
         #Trollop needs this vars locally
         available_distribution_list     = @distribution_list.keys
         available_distributions_options = @distributions_options
+        version = ::Croupier::VERSION
 
         opts = Trollop::options do
           banner <<-EOS
@@ -54,6 +52,7 @@ Usage:
 Get options list for any distribution with: croupier <distrib> --help
 
           EOS
+          version "Croupier version #{version}"
           stop_on available_distribution_list
         end
 

data/lib/croupier/distribution.rb

@@ -70,6 +70,4 @@ module Croupier
     end
   end
 
-  module Distributions
-  end
 end

data/lib/croupier/distributions.rb

@@ -0,0 +1,29 @@
+module Croupier
+
+  module Distributions
+    class << self
+      # An array containing all available Distribution classes
+      def all
+        ::Croupier::Distributions.constants(false).inject([]){|list, distrib|
+          d = ::Croupier::Distributions.const_get(distrib)
+          (d.is_a?(Class) && d.superclass == Croupier::Distribution) ? list << d : list
+        }.uniq.compact
+      end
+
+      # list of all available distribution names (and methods on Distributions module)
+      def list
+        self.all.map(&:cli_name).sort
+      end
+
+      def method_missing(method, *args, &block) # :nodoc:
+        return super unless self.respond_to?(method)
+        self.all.select{|d| d.cli_name == method.to_s}.first.new *args
+      end
+
+      def respond_to?(method, include_private = false) # :nodoc:
+        self.list.include?(method.to_s) || super(method, include_private)
+      end
+    end
+  end
+
+end

data/lib/croupier/distributions/bernoulli.rb

@@ -0,0 +1,44 @@
+module Croupier
+  module Distributions
+
+    #####################################################################
+    # Bernoulli Distribution
+    # Discrete probability distribution taking value 1 with success
+    # probability p and value 0 with failure probability 1-p
+    # Equivalent to a Binomial(1,p)
+    class Bernoulli < ::Croupier::Distribution
+
+      def initialize(options={})
+        @name = "Bernoulli distribution"
+        @description = "Discrete probability distribution taking value 1 with success probability p and value 0 with failure probability 1-p."
+        configure(options)
+        raise Croupier::InputParamsError, "Probability of success must be in the interval [0,1]" if params[:success] > 1 || params[:success] < 0
+      end
+
+      def generate_number
+        binomial_1_p.generate_number
+      end
+
+      def default_parameters
+        {:success => 0.5}
+      end
+
+      def self.cli_name
+        "bernoulli"
+      end
+
+      def self.cli_options
+        {:options => [
+           [:success, 'success probability', {:type=>:float, :short => "-p", :default => 0.5}]
+         ],
+         :banner => "Bernoulli distribution. Discrete probability distribution taking value 1 with success probability p and value 0 with failure probability 1-p."
+        }
+      end
+      
+      private
+      def binomial_1_p
+        @binomial_1_p ||= ::Croupier::Distributions::Binomial.new(:success => params[:success], :size => 1)
+      end
+    end
+  end
+end

data/lib/croupier/distributions/binomial.rb

@@ -0,0 +1,53 @@
+module Croupier
+  module Distributions
+
+    #####################################################################
+    # Binomial Distribution
+    # Discrete probability distribution of the number of successes in a
+    # sequence of Bernoulli trials each of which yields success with
+    # probability p
+    class Binomial < ::Croupier::Distribution
+
+      def initialize(options={})
+        @name = "Binomial distribution"
+        @description = "Discrete probability distribution of the number of successes in a sequence of Bernoulli trials."
+        configure(options)
+        raise Croupier::InputParamsError, "Probability of success must be in the interval [0,1]" if params[:success] > 1 || params[:success] < 0
+      end
+
+      def generate_number
+        x = -1
+        s = 0
+        loop do
+          s += base_geometric.generate_number
+          x += 1
+          break if s > params[:size]
+        end
+        x
+      end
+
+      def default_parameters
+        {:success => 0.5, :size => 1}
+      end
+
+      def self.cli_name
+        "binomial"
+      end
+
+      def self.cli_options
+        {:options => [
+           [:size, 'number of trials', {:type => :integer, :default => 1}],
+           [:success, 'success probability of each trial', {:type=>:float, :short => "-p", :default => 0.5}]
+         ],
+         :banner => "Binomial distribution. Discrete probability distribution of the number of successes in a sequence of Bernoulli trials."
+        }
+      end
+
+      private
+      def base_geometric
+        @base_geometric ||= ::Croupier::Distributions::Geometric.new(success: params[:success])
+      end
+
+    end
+  end
+end

data/lib/croupier/distributions/geometric.rb

@@ -14,7 +14,7 @@ module Croupier
 
       def initialize(options={})
         @name = "Geometric distribution"
-        @description = "Discrete probability distribution that expresses the the number of X Bernoulli trials needed to get one success, supported on the set { 1, 2, 3, ...}"
+        @description = "Discrete probability distribution that expresses the number of X Bernoulli trials needed to get one success, supported on the set { 1, 2, 3, ...}"
         configure(options)
         raise Croupier::InputParamsError, "Probability of success must be in the interval [0,1]" if params[:success] > 1 || params[:success] < 0
       end

data/lib/croupier/distributions/nbinomial.rb

@@ -7,7 +7,6 @@ module Croupier
     # sequence of Bernoulli trials before a specified (non-random)
     # number of failures (denoted size) occur.
     #
-    # The parameter prob expresses the probability of success.
     # Wikipedia -- http://en.wikipedia.org/wiki/Negative_binomial_distribution
     class Nbinomial < ::Croupier::Distribution
 
@@ -28,14 +27,6 @@ module Croupier
         end
       end
 
-      def base_geometric
-        ::Croupier::Distributions::Geometric.new(success: params[:success])
-      end
-
-      def generate_geometrics(n)
-        base_geometric.generate_sample(params[:size]*n)
-      end
-
       def default_parameters
         {:success => 0.5, :size => 1}
       end
@@ -52,6 +43,16 @@ module Croupier
          :banner => "Negative binomial distribution. Discrete probability distribution of the number of successes in a sequence of Bernoulli trials before a specified (non-random) number of failures (denoted size) occur."
         }
       end
+
+      private
+      def base_geometric
+        ::Croupier::Distributions::Geometric.new(success: params[:success])
+      end
+
+      def generate_geometrics(n)
+        base_geometric.generate_sample(params[:size]*n)
+      end
+
     end
   end
 end

data/lib/croupier/version.rb

@@ -0,0 +1,3 @@
+module Croupier
+  VERSION = "1.4.0"
+end

data/test/distributions/R_tests/test_bernoulli.R

@@ -0,0 +1,17 @@
+context('** Bernoulli Distribution **')
+
+context('ChiSquare Goodness of Fit test for default success p = 0.5')
+  croupier_bernoulli <- read.table("../generated_samples/bernoulli_05.data")
+  cs_result<-summary(goodfit(croupier_bernoulli$V1, type="binomial", method="ML", par=list(size=1, prob=0.5)))
+
+  test_that("p-value > 0.05, bernoulli, p = 0.5", {
+    expect_true(cs_result['Pearson',3] > 0.05)
+  })
+
+context('ChiSquare Goodness of Fit test for success p = 0.75')
+  croupier_bernoulli <- read.table("../generated_samples/bernoulli_075.data")
+  cs_result<-summary(goodfit(croupier_bernoulli$V1, type="binomial", method="ML", par=list(size=1, prob=0.75)))
+
+  test_that("p-value > 0.05, bernoulli, p = 0.75", {
+    expect_true(cs_result['Pearson',3] > 0.05)
+  })

data/test/distributions/R_tests/test_binomial.R

@@ -0,0 +1,17 @@
+context('** Binomial Distribution **')
+
+context('ChiSquare Goodness of Fit test for p=0.5, size=5')
+  croupier_binomial <- read.table("../generated_samples/binomial_05_5.data")
+  cs_result<-summary(goodfit(croupier_binomial$V1, type="binomial", method="ML", par=list(size=5, prob=0.5)))
+
+  test_that("p-value > 0.05, binomial, p = 0.5, size=5", {
+    expect_true(cs_result['Pearson',3] > 0.05)
+  })
+
+context('ChiSquare Goodness of Fit test for p = 0.35, size=17')
+  croupier_binomial <- read.table("../generated_samples/binomial_035_17.data")
+  cs_result<-summary(goodfit(croupier_binomial$V1, type="binomial", method="ML", par=list(size=17, prob=0.35)))
+
+  test_that("p-value > 0.05, binomial, p=0.35, size=17", {
+    expect_true(cs_result['Pearson',3] > 0.05)
+  })

data/test/test_distributions_module.rb

@@ -0,0 +1,52 @@
+require "minitest/autorun"
+require "croupier"
+class TestDistributionsModule < MiniTest::Unit::TestCase
+
+  def test_list_of_all_distributions
+    all = Croupier::Distributions.all
+
+    assert all.size > 1
+
+    all.each{|d|
+      assert d.superclass == Croupier::Distribution
+    }
+
+    Croupier::Distributions.constants(false).each do |distrib|
+      d = ::Croupier::Distributions.const_get(distrib)
+      if d.is_a?(Class) && d.superclass == Croupier::Distribution
+        assert all.include?(d), "#{d.name} not included in array of all distributions"
+      end
+    end
+  end
+
+  def test_cli_names_list
+    list = Croupier::Distributions.list
+    Croupier::Distributions.all.each{|d|
+      assert list.include?(d.cli_name), "#{d.cli_name} not included in list"
+    }
+  end
+  
+  def test_all_and_list_have_same_size
+    all = Croupier::Distributions.all
+    list = Croupier::Distributions.list
+    assert list.size == all.size
+  end
+  
+  def test_dynamic_distribution_methods
+    Croupier::Distributions.list.each{|method|
+      assert Croupier::Distributions.respond_to?(method), "No response for #{method} method"
+    }
+  end
+
+  def test_dynamic_method_returns_right_distribution
+    Croupier::Distributions.list.each do |method|
+      distrib = Croupier::Distributions.send method
+      assert_equal distrib.class.cli_name, method
+    end
+
+    example = Croupier::Distributions.normal :mean => 33, :std => 21
+    assert_equal example.parameters[:mean], 33
+    assert_equal example.parameters[:std], 21
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: croupier
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-22 00:00:00.000000000 Z
+date: 2012-06-25 00:00:00.000000000 Z
 dependencies: []
 description: Croupier is a Ruby gem to generate a random sample of numbers with a
   given probability distribution.
@@ -28,6 +28,8 @@ files:
 - lib/croupier/cli/application.rb
 - lib/croupier/cli/trollop.rb
 - lib/croupier/distribution.rb
+- lib/croupier/distributions/bernoulli.rb
+- lib/croupier/distributions/binomial.rb
 - lib/croupier/distributions/cauchy.rb
 - lib/croupier/distributions/exponential.rb
 - lib/croupier/distributions/geometric.rb
@@ -36,8 +38,12 @@ files:
 - lib/croupier/distributions/poisson.rb
 - lib/croupier/distributions/triangular.rb
 - lib/croupier/distributions/uniform.rb
+- lib/croupier/distributions.rb
 - lib/croupier/exceptions.rb
+- lib/croupier/version.rb
 - lib/croupier.rb
+- test/distributions/R_tests/test_bernoulli.R
+- test/distributions/R_tests/test_binomial.R
 - test/distributions/R_tests/test_cauchy.R
 - test/distributions/R_tests/test_exponential.R
 - test/distributions/R_tests/test_geometric.R
@@ -48,6 +54,7 @@ files:
 - test/distributions/R_tests/test_uniform.R
 - test/test_croupier_module.rb
 - test/test_distribution_class.rb
+- test/test_distributions_module.rb
 - test/testsuite.R
 - bin/croupier
 homepage: https://github.com/xuanxu/croupier
@@ -78,6 +85,8 @@ signing_key:
 specification_version: 3
 summary: Samples of random numbers with specific probability distributions
 test_files:
+- test/distributions/R_tests/test_bernoulli.R
+- test/distributions/R_tests/test_binomial.R
 - test/distributions/R_tests/test_cauchy.R
 - test/distributions/R_tests/test_exponential.R
 - test/distributions/R_tests/test_geometric.R
@@ -88,4 +97,5 @@ test_files:
 - test/distributions/R_tests/test_uniform.R
 - test/test_croupier_module.rb
 - test/test_distribution_class.rb
+- test/test_distributions_module.rb
 - test/testsuite.R