bernoulli 0.0.1 → 0.1.0

data/README.md

@@ -17,7 +17,7 @@ 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?
+**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:
 
@@ -29,12 +29,12 @@ 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)
+	x = 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
+	x[25..36] # => 0.7665588897840108
 	
-	b.expected_value # => 30.0
-	b.variance # => 25.0
+	x.expected_value # => 30.0
+	x.variance # => 25.0
 	

data/bernoulli.gemspec

@@ -1,6 +1,19 @@
 
 Gem::Specification.new do |spec|
 	
+	spec.name = 'bernoulli'
+	spec.version = '0.1.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.date = '2012-05-25'
+	
+	spec.author = 'Mikael Konutgan'
+	spec.email = 'mkonutgan@shortmail.com'
+	
+	spec.required_ruby_version = '>= 1.9.2'
+	
 	spec.files = [
 		'README.md',
 		'Rakefile',
@@ -9,16 +22,9 @@ Gem::Specification.new do |spec|
 		'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'
+	spec.test_files = [
+		'test/test_bernoulli.rb'
+	]
 	
 end
 

data/lib/bernoulli/math.rb

@@ -2,6 +2,10 @@
 module Math
 
 	def self.factorial(n)
+		
+		if n < 0 or not n.is_a? Integer
+			raise Math::DomainError, 'Numerical argument is out of domain - "factorial"'
+		end
 		if n == 0
 			1
 		else
@@ -10,6 +14,9 @@ module Math
 	end
 
 	def self.binomial(n, k)
+		if n < 0 or n < k or not (n.is_a? Integer and k.is_a? Integer)
+			raise Math::DomainError, 'Numerical argument is out of domain - "binomial"'
+		end
 		factorial(n)/(factorial(k) * factorial(n - k))
 	end
 

data/lib/bernoulli.rb

@@ -4,6 +4,9 @@ require 'bernoulli/math'
 class Bernoulli
 
 	def initialize(n, p)
+		if n < 0 or p > 1.0 or p < 0.0 or not n.is_a? Integer
+			raise 'Could not initialize Bernoulli experiment'
+		end
 		@n = n
 		@p = p
 	end
@@ -14,23 +17,42 @@ class Bernoulli
 
 	def [](k)
 		if k.is_a? Integer
+			raise Math::DomainError if not (k <= @n and k >= 0)
 			self.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)
 			end
 			sum.to_f
+		else
+			raise TypeError
 		end
 	end
 	
 	def expected_value
 		@n * @p
 	end
+	alias :ev :expected_value
 	
 	def variance
 		@n * @p * (1 - @p)
 	end
+	alias :v :variance
+	
+	def standard_deviation
+		Math.sqrt(self.variance)
+	end
+	alias :sd :standard_deviation
+	
+	def skewness
+		(1 - 2 * @p) / (Math.sqrt(@n * @p * (1 - @p)))
+	end
+	
+	def excess
+		(1 - 6 * @p * (1 - @p)) / (@n * @p * (1 - @p))
+	end
 
 end
 

data/test/test_bernoulli.rb

@@ -21,22 +21,48 @@ class BernoulliTest < Test::Unit::TestCase
 		end
 		assert_equal 100947, Math.binomial(23, 17)
 	end
+	
+	def test_new_experiment
+		assert_raises RuntimeError do
+			Bernoulli.new(10, 1.1)
+		end
+		assert_raises RuntimeError do
+			Bernoulli.new(-10, 0.7)
+		end
+		assert_raises RuntimeError do
+			Bernoulli.new(4.5, 0.2)
+		end
+	end
+	
+	def setup
+		@x = Bernoulli.new(180, 1.0/6)
+		@y = Bernoulli.new(2, 0.5)
+	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]
+		assert_equal 0.5, @y[1]
+		assert_equal 0.25, @y[2]
+		assert_equal 1.0, @y[0..2]
 	end
 	
 	def test_expected_value
-		p = Bernoulli.new(180, 1.0/6)
-		assert_equal 30, p.expected_value
+		assert_equal 30, @x.expected_value
 	end
 	
 	def test_variance
-		p = Bernoulli.new(180, 1.0/6)
-		assert_equal 25, p.variance
+		assert_equal 25, @x.variance
+	end
+	
+	def test_standard_deviation
+		assert_equal 5, @x.standard_deviation
+	end
+	
+	def test_skewness
+		assert_in_delta 0.1333333333333333, @x.skewness, 1.0e-7
+	end
+	
+	def test_excess
+		assert_in_delta 0.0066666666666667, @x.excess, 1.0e-7
 	end
 	
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bernoulli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies: []
 description: A Library that allows calculation of probibilities and properties of
-  Bernoulli processes like coin tossing
+  binomial experiments
 email: mkonutgan@shortmail.com
 executables: []
 extensions: []
@@ -24,7 +24,7 @@ files:
 - lib/bernoulli.rb
 - lib/bernoulli/math.rb
 - test/test_bernoulli.rb
-homepage: https://github.com/mkonutgan
+homepage: https://github.com/mkonutgan/bernoulli
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -35,7 +35,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -47,5 +47,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Bernoulli process library
-test_files: []
+summary: Binomial experiments library
+test_files:
+- test/test_bernoulli.rb