bernoulli 0.1.0 → 0.2.0

data/README.md

@@ -1,4 +1,3 @@
-
 # 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*.
@@ -11,23 +10,23 @@ Use RubyGems to install `bernoulli`
 
 	$ gem install bernoulli
 
-## Uses
+## Tutorial
 
 Using `bernoulli`, one can calculate the probabilities of bernoulli experiments.
 
-### Example Usage
+Let's start by looking at an example.
 
 **Question:** What is the chance of getting between 25 and 36 sixes 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
+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
+Or we could just `require 'bernoulli'` in any Ruby script.
 
-Then we create a new instance of class Bernoulli and calculate our desired probability and properties
+Then we create a new instance of class Bernoulli and calculate our desired probability and properties like so
 
 	x = Bernoulli.new(180, 1.0/6)
 	# => #<Bernoulli:0x007fba721a1bf0 @n=180, @p=0.16666666666666666>
@@ -38,3 +37,44 @@ Then we create a new instance of class Bernoulli and calculate our desired proba
 	x.expected_value # => 30.0
 	x.variance # => 25.0
 	
+We could also calculate the standard deviation, excess or skewness:
+	
+	x.standard_deviation # => 5.0
+	x.excess # => 0.006666666666666665
+	x.skewness => 0.13333333333333336
+	
+`bernoulli` can also do empirical tests. Let's look at a smaller example We can simulate the tossing of 4 fair coins
+
+	y = y = Bernoulli.new(4, 0.5)
+	# => #<Bernoulli:0x007ff894293198 @n=4, @p=0.5>
+
+The method `sample` gives as a random array of length `n`, where each entry is `1` with a probability of `p`. The methods `sample_value` gives us the number of wins in a random expriment, we could than compare it to `expected_value`.
+
+	y.sample # => [1, 0, 1, 0]
+	y.sample # => [0, 0, 1, 0]
+	y.sample # => [1, 1, 1, 1]
+
+	y.sample_value # => 2
+	y.sample_value # => 1
+	y.sample_value # => 0
+	y.sample_value # => 2
+	
+	y.expected_value # => 2.0
+
+Last, but not least, we can create a full table of all possible values and their probabilitys like so
+
+	puts y.table
+	
+will produce
+
+	0,0.0625
+	1,0.25
+	2,0.375
+	3,0.25
+	4,0.0625
+
+## Contributing
+
+`bernoulli` is a really small project. After writing the same code for some project and then losing it two or three times I decided to do it one time and well, so I can just call in the code from here next time.
+
+Feel free to cantact me about anything I could/should add  or to contribute in any way to this simple library.

data/Rakefile

@@ -1,10 +1,13 @@
-
 require 'rake/testtask'
 
+desc 'Run tests'
 Rake::TestTask.new do |test|
-	test.libs << 'test'
 end
 
-desc "Run tests"
 task :default => :test
 
+desc 'Build gem'
+task :gem do
+	sh 'gem build bernoulli.gemspec'
+end
+

data/bernoulli.gemspec

@@ -1,13 +1,12 @@
-
 Gem::Specification.new do |spec|
 	
 	spec.name = 'bernoulli'
-	spec.version = '0.1.0'
+	spec.version = '0.2.0'
 	spec.summary = 'Binomial experiments library'
-	spec.description = 'A Library that allows calculation of probibilities and properties of binomial experiments'
-	spec.homepage = 'https://github.com/mkonutgan/bernoulli'
+	spec.description = 'A Library that allows calculation of probibilities and properties of binomial experiments like coin tossing'
+	spec.homepage = 'http://mkonutgan.github.com/bernoulli'
 	
-	spec.date = '2012-05-25'
+	spec.date = '2012-05-28'
 	
 	spec.author = 'Mikael Konutgan'
 	spec.email = 'mkonutgan@shortmail.com'
@@ -20,10 +19,12 @@ Gem::Specification.new do |spec|
 		'bernoulli.gemspec',
 		'lib/bernoulli.rb',
 		'lib/bernoulli/math.rb',
-		'test/test_bernoulli.rb'
+		'test/test_bernoulli.rb',
+		'test/test_math.rb'
 	]
 	spec.test_files = [
-		'test/test_bernoulli.rb'
+		'test/test_bernoulli.rb',
+		'test/test_math.rb'
 	]
 	
 end

data/lib/bernoulli/math.rb

@@ -1,4 +1,3 @@
-
 module Math
 
 	def self.factorial(n)

data/lib/bernoulli.rb

@@ -1,5 +1,5 @@
-
 require 'bernoulli/math'
+require 'csv'
 
 class Bernoulli
 
@@ -18,12 +18,12 @@ class Bernoulli
 	def [](k)
 		if k.is_a? Integer
 			raise Math::DomainError if not (k <= @n and k >= 0)
-			self.probability(k).to_f
+			probability(k).to_f
 		elsif k.is_a? Range
 			raise Math::DomainError if not (k.begin >= 0 and k.end <= @n)
 			sum = 0
 			k.each do |i|
-				sum += self.probability(i)
+				sum += probability(i)
 			end
 			sum.to_f
 		else
@@ -31,6 +31,19 @@ class Bernoulli
 		end
 	end
 	
+	def sample
+		s = []
+		@n.times do
+			s << (rand < @p ? 1 : 0)
+		end
+		s
+	end
+	
+	def sample_value
+		sample.inject(:+)
+	end
+	alias :sv :sample_value
+	
 	def expected_value
 		@n * @p
 	end
@@ -42,7 +55,7 @@ class Bernoulli
 	alias :v :variance
 	
 	def standard_deviation
-		Math.sqrt(self.variance)
+		Math.sqrt(variance)
 	end
 	alias :sd :standard_deviation
 	
@@ -53,6 +66,14 @@ class Bernoulli
 	def excess
 		(1 - 6 * @p * (1 - @p)) / (@n * @p * (1 - @p))
 	end
+	
+	def table
+		CSV.generate do |csv|
+			(0..@n).each do |n|
+				csv << [n, probability(n)]
+			end
+		end
+	end
 
 end
 

data/test/test_bernoulli.rb

@@ -1,26 +1,8 @@
-
-require 'test/unit'
+require 'minitest/autorun'
+require 'minitest/pride'
 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
+class BernoulliTest < MiniTest::Unit::TestCase
 	
 	def test_new_experiment
 		assert_raises RuntimeError do

data/test/test_math.rb

@@ -0,0 +1,39 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'bernoulli'
+
+class MathTest < MiniTest::Unit::TestCase
+	
+	def test_factorial
+		assert_raises(Math::DomainError) { Math.factorial(-1) }
+		assert_raises(Math::DomainError) { Math.factorial(2.4) }
+		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
+		pairs = [[-1, 0], [2, 4], [-2, -1], [1.2, 3.4], [12, 50]]
+		pairs.each do |pair|
+			assert_raises Math::DomainError do
+				Math.binomial *pair
+			end
+		end
+		assert_equal 1, Math.binomial(0, 0)
+		(1..20).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
+		(15..20).each do |n|
+			(5..15).each do |k|
+				assert_equal Math.binomial(n, k), Math.binomial(n, n - k)
+			end
+		end
+		assert_equal 100947, Math.binomial(23, 17)
+	end
+	
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bernoulli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-05-28 00:00:00.000000000 Z
 dependencies: []
 description: A Library that allows calculation of probibilities and properties of
-  binomial experiments
+  binomial experiments like coin tossing
 email: mkonutgan@shortmail.com
 executables: []
 extensions: []
@@ -24,7 +24,8 @@ files:
 - lib/bernoulli.rb
 - lib/bernoulli/math.rb
 - test/test_bernoulli.rb
-homepage: https://github.com/mkonutgan/bernoulli
+- test/test_math.rb
+homepage: http://mkonutgan.github.com/bernoulli
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -50,3 +51,4 @@ specification_version: 3
 summary: Binomial experiments library
 test_files:
 - test/test_bernoulli.rb
+- test/test_math.rb