croupier 1.4.0 → 1.5.0

data/README.md

@@ -2,6 +2,9 @@
 
 Croupier generates random samples of numbers with specific probability distributions.
 
+[![Gem Version](https://badge.fury.io/rb/croupier.png)](http://badge.fury.io/rb/croupier)
+[![Build Status](https://secure.travis-ci.org/xuanxu/croupier.png?branch=master)](http://travis-ci.org/xuanxu/croupier)
+
 ## Install
 
 You need to have Ruby and Rubygems installed in your system. Then install croupier with:
@@ -32,12 +35,14 @@ where:
 
 ### Available distributions and options
 
-Current version implements the following distributions: 
+Current version implements the following distributions:
 
 * Bernoulli
 * Binomial
 * Cauchy
+* Degenerate
 * Exponential
+* Gamma
 * Geometric
 * Negative binomial
 * Normal
@@ -79,12 +84,13 @@ To get a list of all available distributions/methods in Distributions module cal
 
     Croupier::Distributions.list
 
-## How to generate a distribution.
+## How to generate a new distribution.
 
 There are several ways. The easiest one is to override ```generate_number``` or ```generate_sample``` (one is enough).
 
-Nonetheless there is another cool way to implement a distribution: implementing ```inv_cdf```. ``ìnv_cdf``` receives a
-parameter ```n``` that is a sample of a uniform distribution. It should return the inverse of the cdf applied to ```n```.
+Nonetheless there is another cool way to implement a distribution: implementing ```inv_cdf```:
+
+```ìnv_cdf``` receives a parameter ```n``` that is a sample of a uniform distribution. It should return the inverse of the cdf applied to ```n```.
 
 ## License
 
@@ -93,3 +99,5 @@ Croupier is released under the MIT license.
 ## Credits
 
 Developed by Juanjo Bazán [`@xuanxu`](http://twitter.com/xuanxu) & Sergio Arbeo [`@serabe`](http://twitter.com/serabe)
+
+Follow news and releases on twitter: [`@CroupierGem`](http://twitter.com/CroupierGem)

data/RUNNING_TESTS.md

@@ -34,7 +34,7 @@ Other R packages needed:
     * triangle
     * vcd
 
-The test script will try to intall all dependencies if they are not found in your R installation.
+The test script will try to install all dependencies if they are not found in your R installation.
 You can run the test/testsuite.R file:
 
 Using Rscript:

data/lib/croupier/distribution.rb

@@ -39,7 +39,7 @@ module Croupier
       if self.respond_to? :inv_cdf
         inv_cdf(rand)
       else
-        generate_sample 1
+        generate_sample(1).first
       end
     end
 

data/lib/croupier/distributions/credit_card.rb

@@ -0,0 +1,85 @@
+module Croupier
+  module Distributions
+
+    #####################################################################
+    # CreditCard Distribution
+    # Continuous probability distribution describing resonance behavior.
+    #
+    class CreditCard < ::Croupier::Distribution
+
+      def initialize(options={})
+        @name = "CreditCard distribution"
+        @description = "Generates random credit card numbers."
+        configure(options)
+      end
+
+      def generate_number
+        n = "#{initial_value_by_card_type}#{initial_values}"
+        n += generate_random_string(15 - n.size)
+        n = n[0..14]
+        n + check_digit_for(n).to_s
+      end
+
+      def default_parameters
+        {
+          :master_card => false,
+          :american_express => false,
+          :discover => false,
+          :visa => false,
+          :initial_values => ""
+        }
+      end
+
+      def self.cli_name
+        "credit_card"
+      end
+
+      def check_digit_for(n)
+        # Sum, every odd number should be doubled.
+        # If result has two digits, they should be summed up.
+        # This is equivalent to substracting 9
+        x = n.each_char.map do |x|
+          x.to_i
+        end.each_with_index.map do |x, i|
+          if i.even?
+            x = 2*x
+            (x >= 10) ? x - 9 : x
+          else
+            x
+          end
+        end.inject(&:+) % 10
+
+        return 0 if x == 0
+        10 - x
+      end
+
+      def generate_random_string l
+        (1..l).map{ rand(10).to_s }.join ''
+      end
+
+      def initial_values
+        params[:initial_values].gsub /\D/, ''
+      end
+
+      def initial_value_by_card_type
+        return 3 if params[:american_express]
+        return 4 if params[:visa]
+        return 5 if params[:master_card]
+        return 6 if params[:discover]
+        ""
+      end
+
+      def self.cli_options
+        {:options => [
+           [:master_card, 'master card type', {:type=>:boolean, :default => false}],
+           [:american_express, 'american express card type', {:type=>:boolean, :default => false}],
+           [:visa, 'visa card type', {:type=>:boolean, :default => false}],
+           [:discover, 'discover card type', {:type=>:boolean, :default => false}],
+           [:initial_values, 'initial values for the credit card. They will be place after card type if one is given.', {:type=>:string, :default => ""}]
+         ],
+         :banner => "Credit Card distribution. Generate random card numbers"
+        }
+      end
+    end
+  end
+end

data/lib/croupier/distributions/degenerate.rb

@@ -0,0 +1,36 @@
+module Croupier
+  module Distributions
+
+    #####################################################################
+    # Degenerate Distribution
+    # Discrete probability distribution that returns the same value.
+    class Degenerate < ::Croupier::Distribution
+
+      def initialize(options={})
+        @name = "Degenerate distribution"
+        @description = "Discrete probability distribution that returns the same value each time."
+        configure(options)
+      end
+
+      def generate_number
+        params[:constant]
+      end
+
+      def default_parameters
+        {:constant => 42.0}
+      end
+
+      def self.cli_name
+        "degenerate"
+      end
+
+      def self.cli_options
+        {:options => [
+           [:constant, 'value to be returned', {:type=>:float, :default => 42.0}]
+         ],
+         :banner => "Degenerate distribution. Discrete probability distribution that returns the same value each time."
+        }
+      end
+    end
+  end
+end

data/lib/croupier/distributions/gamma.rb

@@ -0,0 +1,65 @@
+module Croupier
+  module Distributions
+
+    #####################################################################
+    # Gamma Distribution
+    # Family of continuous distributions with two parameters shape
+    # (defaults to 1) and scale (defaults to 1).
+    class Gamma < ::Croupier::Distribution
+
+      def initialize(options={})
+        @name = "Gamma distribution"
+        @description = "Family of continuous distributions with two parameters, shape and scale"
+        configure(options)
+      end
+
+      def generate_number
+        params[:scale] * (gen_xi - (1..params[:shape].floor).map { Math.log(1 - rand) }.inject(&:+) )
+      end
+
+      def default_parameters
+        {:shape => 1.0, :std => 1.0}
+      end
+
+      def self.cli_name
+        "gamma"
+      end
+
+      def self.cli_options
+        {:options => [
+           [:shape, 'shape of the distribution', {:type=>:float, :default => 1.0}],
+           [:scale, 'scale of the distribution', {:type=>:float, :default => 1.0}]
+         ],
+         :banner => "Family of continuous distributions with two parameters, shape and scale."
+        }
+      end
+
+      protected
+      # Based on Ahrens-Dieter acceptance-rejection method
+      # as described on Wikipedia:
+      # http://en.wikipedia.org/wiki/Gamma_distribution#Generating_gamma-distributed_random_variables
+      def gen_xi
+        delta = params[:shape] - params[:shape].floor
+        v_0 = Math::E / ( delta  + Math::E )
+        eta = 1; xi = 0;
+
+        begin
+          # Generate thre independent uniformly distributed
+          # on interval (0,1]random variables
+          v_1 = 1 - rand; v_2 = 1 - rand; v_3 = 1 - rand;
+
+          # Generate a new xi.
+          if v_1 < v_0
+            xi = (v_2 ** (1/delta))
+            eta = v_3 * (xi ** (delta - 1))
+          else
+            xi = 1 - Math.log(v_2)
+            eta = v_3 * (Math::E ** (-xi))
+          end
+        end while eta > (xi ** (delta - 1)) * (Math::E ** -xi)
+
+        xi
+      end
+    end
+  end
+end

data/lib/croupier/version.rb

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

data/test/distributions/R_tests/test_cauchy.R

@@ -7,7 +7,7 @@ context('Kolmogorov-Smirnov test for default (location, scale) = (0,1)')
   croupier_cauchy <- read.table("../generated_samples/cauchy_0_1.data")
   ks_result<-ks.test(croupier_cauchy$V1, "pcauchy")
 
-  test_that("p-value > 0.05", {
+  test_that("p-value > 0.05, cauchy, location=0, scale=1", {
     expect_true(ks_result$p.value > 0.05)
   })
 
@@ -19,7 +19,7 @@ context('Kolmogorov-Smirnov test for given (location, scale) = (12, 3)')
   croupier_cauchy <- read.table("../generated_samples/cauchy_12_3.data")
   ks_result<-ks.test(croupier_cauchy$V1, "pcauchy", location=12, scale=3)
 
-  test_that("p-value > 0.05", {
+  test_that("p-value > 0.05, cauchy, location=12, scale=3", {
     expect_true(ks_result$p.value > 0.05)
   })
 

data/test/distributions/R_tests/test_exponential.R

@@ -7,7 +7,7 @@ context('Kolmogorov-Smirnov test for default lambda = 1')
   croupier_exponential <- read.table("../generated_samples/exponential_1.data")
   ks_result<-ks.test(croupier_exponential$V1, "pexp")
 
-  test_that("p-value > 0.05", {
+  test_that("p-value > 0.05, exponential, lambda=1", {
     expect_true(ks_result$p.value > 0.05)
   })
 
@@ -19,7 +19,7 @@ context('Kolmogorov-Smirnov test for given lambda = 1.6')
   croupier_exponential <- read.table("../generated_samples/exponential_1_6.data")
   ks_result<-ks.test(croupier_exponential$V1, "pexp", rate = 1.6)
 
-  test_that("p-value > 0.05", {
+  test_that("p-value > 0.05, exponential, lambda=1.6", {
     expect_true(ks_result$p.value > 0.05)
   })
 

data/test/distributions/R_tests/test_gamma.R

@@ -0,0 +1,27 @@
+context('** Gamma Distribution **')
+
+context('Kolmogorov-Smirnov test for gamma, shape=1.0, scale=1.0')
+  croupier_gamma <- read.table("../generated_samples/gamma_1_1.data")
+  ks_result<-ks.test(croupier_gamma$V1, "pgamma", shape = 1.0, scale=1.0)
+
+  test_that("p-value > 0.05 gamma, shape=1.0, scale=1.0", {
+    expect_true(ks_result$p.value > 0.05)
+  })
+
+  test_that("statistic converging to 0 gamma, shape=1.0, scale=1.0", {
+    expect_true(as.numeric(ks_result$statistic) < 0.05)
+  })
+
+
+context('Kolmogorov-Smirnov test for gamma, shape=10.35, scale=2.5')
+  croupier_gamma <- read.table("../generated_samples/gamma_1035_25.data")
+  ks_result<-ks.test(croupier_gamma$V1, "pgamma", shape=10.35, scale=2.5)
+
+  test_that("p-value > 0.05 gamma, shape=10.35, scale=2.5", {
+    expect_true(ks_result$p.value > 0.05)
+  })
+
+  test_that("statistic converging to 0 gamma, shape=10.35, scale=2.5", {
+    expect_true(as.numeric(ks_result$statistic) < 0.05)
+  })
+

data/test/distributions/R_tests/test_uniform.R

@@ -7,7 +7,7 @@ context('Kolmogorov-Smirnov test for default sample in [0,1]')
   croupier_uniform_0_1 <- read.table("../generated_samples/uniform_0_1.data")
   ks_result<-ks.test(croupier_uniform_0_1$V1, "punif")
 
-  test_that("p-value > 0.05", {
+  test_that("p-value > 0.05, uniform, [0,1]", {
     expect_true(ks_result$p.value > 0.05)
   })
 
@@ -20,7 +20,7 @@ context('Kolmogorov-Smirnov test for sample with custom interval')
   croupier_uniform_5_33 <- read.table("../generated_samples/uniform_5_33.data")
   ks_result<-ks.test(croupier_uniform_5_33$V1, "punif", min = 5, max = 33)
 
-  test_that("p-value > 0.05", {
+  test_that("p-value > 0.05, uniform, [5,33]", {
     expect_true(ks_result$p.value > 0.05)
   })
 

data/test/distributions/minitest/test_credit_card.rb

@@ -0,0 +1,60 @@
+require "minitest/autorun"
+require "croupier"
+class TestDistributionClass < MiniTest::Unit::TestCase
+
+  def valid_options(optional={})
+    {}.merge(optional)
+  end
+
+  def credit_card(options={})
+    Croupier::Distributions::CreditCard.new(valid_options(options)).generate_number
+  end
+
+  def test_distribution_has_name_and_description
+    dist = Croupier::Distributions::CreditCard.new
+    assert_respond_to dist, 'name'
+    assert_respond_to dist, 'description'
+  end
+
+  def test_visa_starts_with_4
+    assert_equal "4",  credit_card(visa: true)[0]
+  end
+
+  def test_american_express_starts_with_3
+    assert_equal "3", credit_card(american_express: true)[0]
+  end
+
+  def test_master_card_starts_with_5
+    assert_equal "5", credit_card(master_card: true)[0]
+  end
+
+  def test_discover_starts_with_6
+    assert_equal "6", credit_card(discover: true)[0]
+  end
+
+  def test_initial_values_are_placed_at_beginning
+    assert_equal "2345", credit_card(initial_values: "2345")[0..3]
+  end
+
+  def test_initial_values_are_placed_after_card_type_if_one_is_given
+    assert_equal "62345", credit_card(discover: true, initial_values: "2345")[0..4]
+  end
+
+  def test_initial_values_get_not_numbers_removed_before_placing_them
+    assert_equal "2345", credit_card(initial_values: "a2b3c4d5e")[0..3]
+  end
+
+  def test_generate_numbers_for_getting_a_15_chars_long_string
+    assert_equal 16, credit_card.size
+    assert_equal 16, credit_card(visa: true).size
+    assert_equal 16, credit_card(initial_values: "234566789-32").size
+    assert_equal 16, credit_card(initial_values: "01234567890123456789").size
+  end
+
+  def test_check_digit
+    assert_equal "2", credit_card(initial_values: "1234 5678 9012 345")[-1]
+    assert_equal "7", credit_card(initial_values: "1111 1111 1111 111")[-1]
+    assert_equal "8", credit_card(initial_values: "1111 1111 1111 101")[-1]
+    assert_equal "2", credit_card(visa: true, initial_values: "602das63276315242666")[-1]
+  end
+end

data/test/distributions/minitest/test_degenerate_distribution.rb

@@ -0,0 +1,17 @@
+require "minitest/autorun"
+require "croupier"
+class TestDistributionClass < MiniTest::Unit::TestCase
+
+  def test_distribution_has_name_and_description
+    dist = Croupier::Distributions::Degenerate.new
+    assert_respond_to dist, 'name'
+    assert_respond_to dist, 'description'
+  end
+
+  def test_returns_only_one_value
+    dist = Croupier::Distributions::Degenerate.new constant: 5.34
+    5.times do
+      assert_equal 5.34, dist.generate_number
+    end
+  end
+end

data/test/test_distribution_class.rb

@@ -45,4 +45,14 @@ class TestDistributionClass < MiniTest::Unit::TestCase
     a = c.new
     assert a.generate_sample(3).all?
   end
+
+  def test_generate_number_not_returning_array_when_inv_cdf_not_implemented
+    c = Class.new(Croupier::Distribution) do
+      def generate_sample n
+        [1]*n
+      end
+    end
+    a = c.new
+    assert_kind_of Numeric, a.generate_number
+  end
 end

data/test/testsuite.R

@@ -1,7 +1,7 @@
 #!/usr/bin/env Rscript
 #
 # This script runs all the R tests of the croupier gem for all the distributions.
-# 
+#
 # Running the script:
 #  Option 1, Via Rscript:
 #    $> Rscript testsuite.R
@@ -11,11 +11,11 @@
 #
 # Dependencies:
 # In order to run the tests you need to have installed the following packages:
-# 
+#
 #   - testthat
 #   - triangle
 #   - vcd
-# 
+#
 # Croupier will try to install them automatically if they are not included
 # in your R installation.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: croupier
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2013-05-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.
@@ -31,7 +31,10 @@ files:
 - lib/croupier/distributions/bernoulli.rb
 - lib/croupier/distributions/binomial.rb
 - lib/croupier/distributions/cauchy.rb
+- lib/croupier/distributions/credit_card.rb
+- lib/croupier/distributions/degenerate.rb
 - lib/croupier/distributions/exponential.rb
+- lib/croupier/distributions/gamma.rb
 - lib/croupier/distributions/geometric.rb
 - lib/croupier/distributions/nbinomial.rb
 - lib/croupier/distributions/normal.rb
@@ -46,12 +49,15 @@ files:
 - 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_gamma.R
 - test/distributions/R_tests/test_geometric.R
 - test/distributions/R_tests/test_nbinomial.R
 - test/distributions/R_tests/test_normal.R
 - test/distributions/R_tests/test_poisson.R
 - test/distributions/R_tests/test_triangular.R
 - test/distributions/R_tests/test_uniform.R
+- test/distributions/minitest/test_credit_card.rb
+- test/distributions/minitest/test_degenerate_distribution.rb
 - test/test_croupier_module.rb
 - test/test_distribution_class.rb
 - test/test_distributions_module.rb
@@ -69,18 +75,18 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Samples of random numbers with specific probability distributions
@@ -89,12 +95,15 @@ test_files:
 - 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_gamma.R
 - test/distributions/R_tests/test_geometric.R
 - test/distributions/R_tests/test_nbinomial.R
 - test/distributions/R_tests/test_normal.R
 - test/distributions/R_tests/test_poisson.R
 - test/distributions/R_tests/test_triangular.R
 - test/distributions/R_tests/test_uniform.R
+- test/distributions/minitest/test_credit_card.rb
+- test/distributions/minitest/test_degenerate_distribution.rb
 - test/test_croupier_module.rb
 - test/test_distribution_class.rb
 - test/test_distributions_module.rb