binomial_distribution 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6622daa3e81337424a264d794ab0cf6f7c86c375
+  data.tar.gz: 725288b83c2568b74a45ad7391aa813e3c3e222c
+SHA512:
+  metadata.gz: d472d9760571bd9bb1cc2ec21b7d23d485406e67efa3afcdb57e203c3974cc32b7c813027e137bf724c6b9d769fa7896fd6bbd46cb6d9acdb84f045591208ce5
+  data.tar.gz: e853d80ff48ffea3dee69b5f8b46ecc814f4ad626b3090144a2c2ab6e5ab8c53ac012bdb55c5d02f57460b44376ab89460735e9001d8d2fb0fc78bd167cca9cc

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+T�+=M9R�W8���{h�5�>�{$�X�ܗ��1]�����P���T�d@�R��LC�7��-�R��!Y��e�
+P聐2L�䘜q����)
+L{QM!�y:\@��n�m.��vI1��e��g������핇�S)����:��v���-؅I���^�AXj

data/CHANGELOG

@@ -0,0 +1,5 @@
+v0.1.1
+	* Initialize the project
+  * Add tests
+  * Improve names
+  * Fix few bugs

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'nomorebeer' # action against drunk driving
+

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    nomorebeer (1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nomorebeer
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,37 @@
+# A ruby implementation of the Binomial Distribution
+
+## Installation
+
+```sh
+gem install binomial_distribution
+```
+
+or in the ``Gemfile``
+
+```ruby
+gem 'binomial_distribution'
+```
+
+
+## Usage in Ruby
+
+```ruby
+require 'binomial_distribution'
+
+Math.binomial_distribution(tries: 1, probability: 0.4, success: 1) # => 0.4
+```
+
+
+## Unitary tests
+
+```sh
+rake test
+```
+
+
+## Contributes !
+
+Find a bug ? Want a new feature ?
+Create a clear pull request and we'll see :)
+
+- Nephos (poulet_a)

data/Rakefile

@@ -0,0 +1,16 @@
+#encoding: utf-8
+
+task :default => [:test]
+
+task :test do
+  ruby "test/unit_test.rb"
+end
+
+namespace :test do
+
+  desc "Unitary tests."
+  task :test do
+    ruby "test/unit_test.rb"
+  end
+
+end

data/binomial_distribution.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  s.name        = 'binomial_distribution'
+  s.version     = File.read("version")
+  s.date        = Time.now.getgm.to_s.split.first
+  s.summary     = File.read("CHANGELOG").match(/^v[^\n]+\n((\t[^\n]+\n)+)/m)[1].split("\t").join
+  s.description = 'A ruby implementation of the Binomial Distribution'
+  s.authors     = ['Nephos (poulet_a)']
+  s.email       = ['arthur.poulet@mailoo.org']
+  s.files       = %w(
+  lib/binomial_distribution.rb
+
+  README.md
+  CHANGELOG
+
+  Rakefile
+  Gemfile
+  Gemfile.lock
+  binomial_distribution.gemspec
+  version
+
+  test/unit_test.rb
+  test/binomial_distribution.rb
+
+  certs/nephos.pem
+  )
+  s.executables = %w(
+  )
+  s.homepage    = 'https://github.com/Nephos/BinomialDistribution'
+  s.license     = 'WTFPL'
+
+  s.cert_chain  = ['certs/nephos.pem']
+  s.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+
+  # s.add_dependency 'nephos', '~> 1.0'
+  s.add_dependency 'nomorebeer', '~> 1.1'
+
+end

data/certs/nephos.pem

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRYwFAYDVQQDDA1hcnRo
+dXIucG91bGV0MRkwFwYKCZImiZPyLGQBGRYJY3J5cHRvbGFiMRMwEQYKCZImiZPy
+LGQBGRYDbmV0MB4XDTE1MTAwMzIxNTQyMFoXDTE2MTAwMjIxNTQyMFowSDEWMBQG
+A1UEAwwNYXJ0aHVyLnBvdWxldDEZMBcGCgmSJomT8ixkARkWCWNyeXB0b2xhYjET
+MBEGCgmSJomT8ixkARkWA25ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+ggEBANnLB9vH7/O0aUWi0f9VtC7F73zMC1OvxDaJq+qIcmGBFiKPOngDCRyKffWf
+A6gyf7VsJAlDVFYoyNw7bzLFjBT9gkb5xmED3Uaxvt8Ax131YvKv0sTsQeiTVHHW
+1crq7266hW1McrFU2A1uQRV8FHuruUJBuP7UUYK7fZi0barbkdAIb4VvQFZxXByI
+lKdQSuhu8k0RcG1vTACEsQXJIUImc8CWMi8/TG3HidJdASMvIWtV2rNQXlQ+UgIc
+UeHC0p+SNTrc09H6q+5eH8NRYhJ91xKuLXv7NNy8M3quAMHcQ1GM6DWljc+Jc4cm
+uAPQMYJf7Vy6OzWLoEiv2QU6sE0CAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+DwQEAwIEsDAdBgNVHQ4EFgQU08cDEZOTZNjP/0+E2unJWyw4NzQwJgYDVR0RBB8w
+HYEbYXJ0aHVyLnBvdWxldEBjcnlwdG9sYWIubmV0MCYGA1UdEgQfMB2BG2FydGh1
+ci5wb3VsZXRAY3J5cHRvbGFiLm5ldDANBgkqhkiG9w0BAQUFAAOCAQEAo60BuRZM
+5Vtn0H0kHHTPiXz09lwxx4cFpTqrTTM0T6qM3gKsR5eLyR1Rt5hGmYLPgY4ZW4zI
+XcuDbgRJrczZs7AZNy5NXyVWpxCwkZzklpbGTuYQdFz7mKfVyALjLjrilOIktXcz
+PvB7EoLlqYvq9cnwV3WE1MkRcBd07xpofcp0kxae2dCOZPUq24TcNaRe7Utw6jjA
+iL0bcH7zZkzMsNoNpPAgsd3ovU4Mf9M+A3M8COmd7KzKyZ0k7P12u5InPWUsNQS2
+tcYkgfqUJPitIJx1RvWZpIyH5uJhRUYK3+vU9nMOxez5WbIlC1TtpByKAPMX+sht
+gib3AoIT8jh/2w==
+-----END CERTIFICATE-----

data/lib/binomial_distribution.rb

@@ -0,0 +1,83 @@
+module Math
+
+  def self.factorial(n)
+    raise ArgumentError, 'The argument muse be a natural Fixnum N' if not n.is_a? Fixnum
+    raise Math::DomainError, 'The argument must be a natural (out of domain -- factorial)' if n < 0
+    return 1 if n.zero?
+    return (1..n).inject(:*)
+  end unless self.method_defined? :factorial
+
+  def self.coef_binomial(n, k)
+    return 0 if n < 0 or k < 0 or n < k
+    return factorial(n) / (factorial(k) * factorial(n - k))
+  end
+
+  # @note if no named parameters are used, then it will try to use the unamed parameters (tries, success, probability)
+  def self.binomial_distribution(*unamed, tries: nil, success: nil, probability: nil)
+    unamed.reverse! # pop works on a stack
+    Binomial.new(tries: tries || unamed.pop, probability: probability || unamed.pop).distribute(success || unamed.pop)
+  end
+
+  class SuperiorityError < Exception; end
+end
+
+class Array
+  def second
+    self[1]
+  end unless self.method_defined? :second
+end
+
+class Binomial
+
+  # @param n [Fixnum] number of tries
+  # @param p [Float] probability of success
+  # @param tries [Fixnum] alias for n
+  # @param probability [Float] alias for p
+  # @param failure [Float] alias for `p = 1 - failure`
+  # @note if no probability is defined, the default value will be 0.5
+  def initialize n: nil, p: nil, tries: nil, probability: nil, failure: nil
+    tries_count = n || tries
+    probability = p || probability || (failure && 1.0 - failure) || 0.5
+    raise ArgumentError, "The argument `n` `#{tries_count}` is not an Integer" unless tries_count.is_a? Integer
+    raise ArgumentError, "The argument `p` `#{probability}` is not a Numeric" unless probability.is_a? Numeric
+    tries_count = Float(tries_count)
+    raise Math::DomainError, "The argument `n` `#{tries_count}` is not in greater or equal to 0" if tries_count < 0.0
+    raise Math::DomainError, "The argument `p` `#{probability}` is not in greater or equal to 0" if probability < 0.0
+    raise Math::DomainError, "The argument `p` `#{probability}` is not in lesser or equal to 1" if probability > 1.0
+    @n = tries_count.to_i
+    @p = probability.to_f
+  end
+
+  def to_s
+    "#<#{self.class} @n=#@n, @p=#@p>"
+  end
+
+  # @param k [Fixnum] number of test successful.
+  # @param k [Enumerable] list of number of test successful.
+  # @return [Float] probability
+  def distribute k
+    if k.is_a? Enumerable
+      distribute_enumerable k
+    elsif k.is_a? Integer
+      distribute_integer k
+    else
+      raise ArgumentError
+    end
+  end
+
+  private def distribute_enumerable k
+    k.map{|p| calc(p) }.inject(&:+)
+  end
+
+  private def distribute_integer k
+    raise Math::SuperiorityError, "the number of success must be lesser or equal to the number of tries (#{@n})" if k > @n
+    Math.coef_binomial(@n, k) * @p**k * (1 - @p) ** (@n - k)
+  end
+
+end
+
+#
+# if __FILE__ == $0
+#   require 'pry'
+#   binding.pry
+# end

data/test/binomial_distribution.rb

@@ -0,0 +1,20 @@
+class TestBinomialDistribution < Test::Unit::TestCase
+
+  def test_simple
+    0.0.step(by: 0.1, to: 1.0) do |proba|
+      assert_equal proba, Math.binomial_distribution(tries: 1, probability: proba, success: 1)
+    end
+  end
+
+  def test_nonamed_arguments
+    assert_equal 0.4, Math.binomial_distribution(tries: 1, probability: 0.4, success: 1)
+    assert_equal 0.4, Math.binomial_distribution(1, probability: 0.4, success: 1)
+    assert_equal 0.4, Math.binomial_distribution(1, tries: 1, probability: 0.4)
+    assert_equal 0.4, Math.binomial_distribution(0.4, tries: 1, success: 1)
+    assert_equal 0.4, Math.binomial_distribution(1, 0.4, success: 1)
+    assert_equal 0.4, Math.binomial_distribution(0.4, 1, tries: 1)
+    assert_equal 0.4, Math.binomial_distribution(1, 0.4, 1)
+    assert_equal 0.4, Math.binomial_distribution(1, 1, probability: 0.4)
+end
+
+end

data/test/unit_test.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "test/unit"
+
+require_relative '../lib/binomial_distribution'
+
+require_relative 'binomial_distribution'

data/version

@@ -0,0 +1 @@
+0.1.1

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: binomial_distribution
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nephos (poulet_a)
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRYwFAYDVQQDDA1hcnRo
+  dXIucG91bGV0MRkwFwYKCZImiZPyLGQBGRYJY3J5cHRvbGFiMRMwEQYKCZImiZPy
+  LGQBGRYDbmV0MB4XDTE1MTAwMzIxNTQyMFoXDTE2MTAwMjIxNTQyMFowSDEWMBQG
+  A1UEAwwNYXJ0aHVyLnBvdWxldDEZMBcGCgmSJomT8ixkARkWCWNyeXB0b2xhYjET
+  MBEGCgmSJomT8ixkARkWA25ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBANnLB9vH7/O0aUWi0f9VtC7F73zMC1OvxDaJq+qIcmGBFiKPOngDCRyKffWf
+  A6gyf7VsJAlDVFYoyNw7bzLFjBT9gkb5xmED3Uaxvt8Ax131YvKv0sTsQeiTVHHW
+  1crq7266hW1McrFU2A1uQRV8FHuruUJBuP7UUYK7fZi0barbkdAIb4VvQFZxXByI
+  lKdQSuhu8k0RcG1vTACEsQXJIUImc8CWMi8/TG3HidJdASMvIWtV2rNQXlQ+UgIc
+  UeHC0p+SNTrc09H6q+5eH8NRYhJ91xKuLXv7NNy8M3quAMHcQ1GM6DWljc+Jc4cm
+  uAPQMYJf7Vy6OzWLoEiv2QU6sE0CAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+  DwQEAwIEsDAdBgNVHQ4EFgQU08cDEZOTZNjP/0+E2unJWyw4NzQwJgYDVR0RBB8w
+  HYEbYXJ0aHVyLnBvdWxldEBjcnlwdG9sYWIubmV0MCYGA1UdEgQfMB2BG2FydGh1
+  ci5wb3VsZXRAY3J5cHRvbGFiLm5ldDANBgkqhkiG9w0BAQUFAAOCAQEAo60BuRZM
+  5Vtn0H0kHHTPiXz09lwxx4cFpTqrTTM0T6qM3gKsR5eLyR1Rt5hGmYLPgY4ZW4zI
+  XcuDbgRJrczZs7AZNy5NXyVWpxCwkZzklpbGTuYQdFz7mKfVyALjLjrilOIktXcz
+  PvB7EoLlqYvq9cnwV3WE1MkRcBd07xpofcp0kxae2dCOZPUq24TcNaRe7Utw6jjA
+  iL0bcH7zZkzMsNoNpPAgsd3ovU4Mf9M+A3M8COmd7KzKyZ0k7P12u5InPWUsNQS2
+  tcYkgfqUJPitIJx1RvWZpIyH5uJhRUYK3+vU9nMOxez5WbIlC1TtpByKAPMX+sht
+  gib3AoIT8jh/2w==
+  -----END CERTIFICATE-----
+date: 2016-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nomorebeer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A ruby implementation of the Binomial Distribution
+email:
+- arthur.poulet@mailoo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- binomial_distribution.gemspec
+- certs/nephos.pem
+- lib/binomial_distribution.rb
+- test/binomial_distribution.rb
+- test/unit_test.rb
+- version
+homepage: https://github.com/Nephos/BinomialDistribution
+licenses:
+- WTFPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: "* Initialize the project"
+test_files: []
+has_rdoc: