bernoulli 0.0.1

data/README.md

@@ -0,0 +1,40 @@
+
+# Bernoulli : A Ruby library for the binomial distribution
+
+In probability theory and statistics, the **binomial distribution** is the discrete probability distribution of the number of successes in a sequence of *n* independent yes/no experiments, each of which yields success with probability *p*.
+
+You can read more about **Bernoulli trials** and the **binomial distribution** [on Wikipedia](http://en.wikipedia.org/wiki/Binomial_distribution).
+
+## Installation
+
+Use RubyGems to install `bernoulli`
+
+	$ gem install bernoulli
+
+## Uses
+
+Using `bernoulli`, one can calculate the probabilities of bernoulli experiments.
+
+### Example Usage
+
+**Question:** What is the chance of getting between 25 and 36 6's when one rolls a die 180 times? What is the expected value and variance of this trial?
+
+Let's use `bernoulli` to solve this:
+
+First we load up `irb` from the terminal including `bernoulli` as a library
+
+	$ irb -r bernoulli
+	
+Or we could just include `require 'bernoulli'` in any Ruby script
+
+Then we create a new instance of class Bernoulli and calculate our desired probability and properties
+
+	b = Bernoulli.new(180, 1.0/6)
+	# => #<Bernoulli:0x007fba721a1bf0 @n=180, @p=0.16666666666666666>
+	
+	# The probability of getting between 25 and 36 sixes is
+	b[25..36] # => 0.7665588897840108
+	
+	b.expected_value # => 30.0
+	b.variance # => 25.0
+	

data/Rakefile

@@ -0,0 +1,10 @@
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+	test.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/bernoulli.gemspec

@@ -0,0 +1,24 @@
+
+Gem::Specification.new do |spec|
+	
+	spec.files = [
+		'README.md',
+		'Rakefile',
+		'bernoulli.gemspec',
+		'lib/bernoulli.rb',
+		'lib/bernoulli/math.rb',
+		'test/test_bernoulli.rb'
+	]
+	spec.name = 'bernoulli'
+	spec.summary = 'Bernoulli process library'
+	spec.version = '0.0.1'
+	
+	spec.date = '2012-05-24'
+	spec.description = "A Library that allows calculation of probibilities and properties of Bernoulli processes like coin tossing"
+	
+	spec.author = 'Mikael Konutgan'
+	spec.homepage = 'https://github.com/mkonutgan'
+	spec.email = 'mkonutgan@shortmail.com'
+	
+end
+

data/lib/bernoulli/math.rb

@@ -0,0 +1,17 @@
+
+module Math
+
+	def self.factorial(n)
+		if n == 0
+			1
+		else
+			(1..n).inject(:*)
+		end
+	end
+
+	def self.binomial(n, k)
+		factorial(n)/(factorial(k) * factorial(n - k))
+	end
+
+end
+

data/lib/bernoulli.rb

@@ -0,0 +1,36 @@
+
+require 'bernoulli/math'
+
+class Bernoulli
+
+	def initialize(n, p)
+		@n = n
+		@p = p
+	end
+
+	def probability(k)
+		Math.binomial(@n, k) * @p**k * (1 - @p)**(@n - k)
+	end
+
+	def [](k)
+		if k.is_a? Integer
+			self.probability(k).to_f
+		elsif k.is_a? Range
+			sum = 0
+			k.each do |i|
+				sum += self.probability(i)
+			end
+			sum.to_f
+		end
+	end
+	
+	def expected_value
+		@n * @p
+	end
+	
+	def variance
+		@n * @p * (1 - @p)
+	end
+
+end
+

data/test/test_bernoulli.rb

@@ -0,0 +1,43 @@
+
+require 'test/unit'
+require 'bernoulli'
+
+class BernoulliTest < Test::Unit::TestCase
+	
+	def test_factorial
+		assert_equal 1, Math.factorial(0)
+		assert_equal 1, Math.factorial(1)
+		assert_equal 120, Math.factorial(5)
+		assert_equal 263130836933693530167218012160000000, Math.factorial(32)
+	end
+
+	def test_binomial
+		assert_equal 1, Math.binomial(0, 0)
+		(1..10).each do |k|
+			assert_equal 1, Math.binomial(k, 0)
+			assert_equal 1, Math.binomial(k, k)
+			assert_equal k, Math.binomial(k, 1)
+			assert_equal k, Math.binomial(k, k - 1)
+		end
+		assert_equal 100947, Math.binomial(23, 17)
+	end
+
+	def test_coin_toss
+		p = Bernoulli.new(2, 0.5)
+		assert_equal 0.5, p[1]
+		assert_equal 0.25, p[2]
+		assert_equal 1.0, p[0..2]
+	end
+	
+	def test_expected_value
+		p = Bernoulli.new(180, 1.0/6)
+		assert_equal 30, p.expected_value
+	end
+	
+	def test_variance
+		p = Bernoulli.new(180, 1.0/6)
+		assert_equal 25, p.variance
+	end
+	
+end
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: bernoulli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mikael Konutgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies: []
+description: A Library that allows calculation of probibilities and properties of
+  Bernoulli processes like coin tossing
+email: mkonutgan@shortmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bernoulli.gemspec
+- lib/bernoulli.rb
+- lib/bernoulli/math.rb
+- test/test_bernoulli.rb
+homepage: https://github.com/mkonutgan
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.24
+signing_key: 
+specification_version: 3
+summary: Bernoulli process library
+test_files: []