games_dice 0.1.1 → 0.1.2

data/README.md

@@ -114,31 +114,78 @@ Convenience method, returns an array [ dice.min, dice.max ]
 
 #### dice.probabilities
 
-Calculates probability distribution for the dice. Note that some distributions, involving keeping
-a number best or worst results, can take significant time to calculate.
+Calculates probability distribution for the dice.
 
 Returns a GamesDice::Probabilities object that describes the probability distribution.
 
     probabilities = dice.probabilities
 
+Note that some distributions, involving keeping a number best or worst results, can take
+significant time to calculate. If the theoretical distribution would contain a large number
+of very low probabilities due to a possibility of large numbers re-rolls, then the
+calculations cut short, typically approximating to the nearest 1.0e-10.
+
 ### GamesDice::Probabilities instance methods
 
 #### probabilities.to_h
 
-Returns a hash representation of the probability distribution. Each keys is a possible result
+Returns a hash representation of the probability distribution. Each key is a possible result
 from rolling the dice (an Integer), and the associated value is the probability of a roll
-returning that value (a Float).
+returning that result (a Float, between 0.0 and 1.0 inclusive).
+
+    distribution = probabilities.to_h
+    distribution[3]           # => 0.0046296296296
 
 #### probabilities.max
 
-Returns maximum value in the probability distribution. This may not be the theoretical maximum
+Returns maximum result in the probability distribution. This may not be the theoretical maximum
 possible on the dice, if for example the dice can roll open-ended high results.
 
+    probabilities.max         # => 18
+
 #### probabilities.min
 
-Returns minimum value in the probability distribution. This may not be the theoretical minimum
+Returns minimum result in the probability distribution. This may not be the theoretical minimum
 possible on the dice, if for example the dice can roll open-ended low results.
 
+    probabilities.min         # => 3
+
+#### probabilities.p_eql( n )
+
+Returns the probability of a result equal to the integer n.
+
+    probabilities.p_eql( 3 )  # => 0.004629629629
+    probabilities.p_eql( 2 )  # => 0.0
+
+Probabilities below 1e-10 due to requiring long sequences of re-rolls will calculate as 0.0
+
+#### probabilities.p_gt( n )
+
+Returns the probability of a result greater than the integer n.
+
+    probabilities.p_gt( 17 )  # => 0.004629629629
+    probabilities.p_gt( 2 )   # => 1.0
+
+#### probabilities.p_ge( n )
+
+Returns the probability of a result greater than or equal to the integer n.
+
+    probabilities.p_ge( 17 )  # => 0.0185185185185
+    probabilities.p_ge( 3 )   # => 1.0
+
+#### probabilities.p_le( n )
+
+Returns the probability of a result less than or equal to the integer n.
+
+    probabilities.p_le( 17 )  # => 0.9953703703703
+    probabilities.p_le( 3 )   # => 0.0046296296296
+
+#### probabilities.p_lt( n )
+
+Returns the probability of a result less than the integer n.
+
+    probabilities.p_lt( 17 )  # => 0.9953703703703
+    probabilities.p_lt( 3 )   # => 0.0
 
 ## String Dice Descriptions
 

data/games_dice.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |gem|
   gem.email         = ["slobo777@gmail.com"]
   gem.description   = %q{A simulated-dice library, with flexible rules that allow dice systems from
                         many board and roleplay games to be built, run and reported.}
-  gem.summary       = %q{Simulates and explains dice rolls from a variety of game systems.}
+  gem.summary       = %q{Simulates and explains dice rolls from simple "1d6" to complex "roll 7 ten-sided dice, take best 3,
+                        results of 10 roll again and add on".}
   gem.homepage      = "https://github.com/neilslater/games_dice"
 
   gem.add_development_dependency "rspec", ">= 2.13.0"

data/lib/games_dice/version.rb

@@ -1,3 +1,3 @@
 module GamesDice
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/complex_die_spec.rb

@@ -1,15 +1,5 @@
 require 'games_dice'
 
-# Test helper class, a stub of a PRNG
-class TestPRNG
-  def initialize
-    @numbers = [0.123,0.234,0.345,0.999,0.876,0.765,0.543,0.111,0.333,0.777]
-  end
-  def rand(n)
-    Integer( n * @numbers.pop )
-  end
-end
-
 describe GamesDice::ComplexDie do
 
   before do

data/spec/die_spec.rb

@@ -1,16 +1,5 @@
 require 'games_dice'
 
-# Test helper class, a stub of a PRNG
-class TestPRNG
-  def initialize
-    # Numbers that I randomly thought up!
-    @numbers = [0.123,0.234,0.345,0.999,0.876,0.765,0.543,0.111,0.333,0.777]
-  end
-  def rand(n)
-    Integer( n * @numbers.pop )
-  end
-end
-
 describe GamesDice::Die do
 
   before do

data/spec/helpers.rb

@@ -0,0 +1,49 @@
+# games_dice/spec/helpers.rb
+
+class TestPRNG
+  def initialize
+    @numbers = [0.123,0.234,0.345,0.999,0.876,0.765,0.543,0.111,0.333,0.777]
+  end
+  def rand(n)
+    Integer( n * @numbers.pop )
+  end
+end
+
+# A valid distribution is:
+#  A hash
+#  Keys are all Integers
+#  Values are all positive Floats, between 0.0 and 1.0
+#  Sum of values is 1.0
+RSpec::Matchers.define :be_valid_distribution do
+  match do |given|
+    @error = nil
+    if ! given.is_a?(Hash)
+      @error = "distribution should be a Hash, but it is a #{given.class}"
+    elsif given.keys.any? { |k| ! k.is_a?(Fixnum) }
+      bad_key = given.keys.first { |k| ! k.is_a?(Fixnum) }
+      @error = "all keys should be Fixnums, but found '#{bad_key.inspect}' which is a #{bad_key.class}"
+    elsif given.values.any? { |v| ! v.is_a?(Float) }
+      bad_value = given.values.first { |v| ! v.is_a?(Float) }
+      @error = "all values should be Floats, but found '#{bad_value.inspect}' which is a #{bad_value.class}"
+    elsif given.values.any? { |v| v < 0.0 || v > 1.0 }
+      bad_value = given.values.first { |v| v < 0.0 || v > 1.0 }
+      @error = "all values should be in range (0.0..1.0), but found #{bad_value}"
+    elsif (1.0 - given.values.inject(:+)).abs > 1e-6
+      total_probs = given.values.inject(:+)
+      @error = "sum of values should be 1.0, but got #{total_probs}"
+    end
+    ! @error
+  end
+
+  failure_message_for_should do |given|
+    @error ? @error : 'Distribution is valid and complete'
+  end
+
+  failure_message_for_should_not do |given|
+     @error ? @error : 'Distribution is valid and complete'
+  end
+
+  description do |given|
+    "a hash describing a complete probability distribution of integer results"
+  end
+end

data/spec/probability_spec.rb

@@ -1,44 +1,5 @@
 require 'games_dice'
 
-# A valid distribution is:
-#  A hash
-#  Keys are all Integers
-#  Values are all positive Floats, between 0.0 and 1.0
-#  Sum of values is 1.0
-RSpec::Matchers.define :be_valid_distribution do
-  match do |given|
-    @error = nil
-    if ! given.is_a?(Hash)
-      @error = "distribution should be a Hash, but it is a #{given.class}"
-    elsif given.keys.any? { |k| ! k.is_a?(Fixnum) }
-      bad_key = given.keys.first { |k| ! k.is_a?(Fixnum) }
-      @error = "all keys should be Fixnums, but found '#{bad_key.inspect}' which is a #{bad_key.class}"
-    elsif given.values.any? { |v| ! v.is_a?(Float) }
-      bad_value = given.values.first { |v| ! v.is_a?(Float) }
-      @error = "all values should be Floats, but found '#{bad_value.inspect}' which is a #{bad_value.class}"
-    elsif given.values.any? { |v| v < 0.0 || v > 1.0 }
-      bad_value = given.values.first { |v| v < 0.0 || v > 1.0 }
-      @error = "all values should be in range (0.0..1.0), but found #{bad_value}"
-    elsif (1.0 - given.values.inject(:+)).abs > 1e-6
-      total_probs = given.values.inject(:+)
-      @error = "sum of values should be 1.0, but got #{total_probs}"
-    end
-    ! @error
-  end
-
-  failure_message_for_should do |given|
-    @error ? @error : 'Distribution is valid and complete'
-  end
-
-  failure_message_for_should_not do |given|
-     @error ? @error : 'Distribution is valid and complete'
-  end
-
-  description do |given|
-    "a hash describing a complete probability distribution of integer results"
-  end
-end
-
 describe GamesDice::Probabilities do
 
   describe "class methods" do

data/spec/readme_spec.rb

@@ -1,16 +1,7 @@
 require 'games_dice'
+require 'helpers'
 # This spec demonstrates that documentation from the README.md works as intended
 
-# Test helper class, a stub of a PRNG
-class TestPRNG
-  def initialize
-    @numbers = [0.123,0.234,0.345,0.999,0.876,0.765,0.543,0.111,0.333,0.777]
-  end
-  def rand(n)
-    Integer( n * @numbers.pop )
-  end
-end
-
 describe GamesDice do
 
   describe '#create' do
@@ -94,3 +85,64 @@ describe GamesDice::Dice do
   end
 
 end # describe GamesDice::Dice
+
+describe GamesDice::Probabilities do
+  let(:probs) { GamesDice.create('3d6').probabilities }
+
+  describe "#to_h" do
+    it "returns a hash representation of the probability distribution" do
+      h = probs.to_h
+      h.should be_valid_distribution
+      h[3].should be_within(1e-10).of 1.0/216
+      h[11].should be_within(1e-10).of 27.0/216
+    end
+  end
+
+  describe "#max" do
+    it "returns maximum result in the probability distribution" do
+      probs.max.should == 18
+    end
+  end
+
+  describe "#min" do
+    it "returns minimum result in the probability distribution" do
+      probs.min.should == 3
+    end
+  end
+
+  describe "#p_eql( n )" do
+    it "returns the probability of a result equal to the integer n" do
+      probs.p_eql( 3 ).should be_within(1e-10).of 1.0/216
+      probs.p_eql( 2 ).should == 0.0
+    end
+  end
+
+  describe "#p_gt( n )" do
+    it "returns the probability of a result greater than the integer n" do
+      probs.p_gt( 17 ).should be_within(1e-10).of 1.0/216
+      probs.p_gt( 2 ).should == 1.0
+    end
+  end
+
+  describe "#p_ge( n )" do
+    it "returns the probability of a result greater than the integer n" do
+      probs.p_ge( 17 ).should be_within(1e-10).of 4.0/216
+      probs.p_ge( 3 ).should == 1.0
+    end
+  end
+
+  describe "#p_le( n )" do
+    it "returns the probability of a result less than or equal to the integer n" do
+      probs.p_le( 17 ).should be_within(1e-10).of 215.0/216
+      probs.p_le( 3 ).should be_within(1e-10).of 1.0/216
+    end
+  end
+
+  describe "#p_lt( n )" do
+    it "returns the probability of a result less than the integer n" do
+      probs.p_lt( 17 ).should be_within(1e-10).of 212.0/216
+      probs.p_lt( 3 ).should == 0.0
+    end
+  end
+
+end  # describe GamesDice::Probabilities

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: games_dice
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -69,6 +69,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,12 +92,12 @@ files:
 - spec/dice_spec.rb
 - spec/die_result_spec.rb
 - spec/die_spec.rb
+- spec/helpers.rb
 - spec/map_rule_spec.rb
 - spec/parser_spec.rb
 - spec/probability_spec.rb
 - spec/readme_spec.rb
 - spec/reroll_rule_spec.rb
-- travis.yml
 homepage: https://github.com/neilslater/games_dice
 licenses: []
 post_install_message: 
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 514639472622102988
+      hash: -2496597161129373974
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,19 +121,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 514639472622102988
+      hash: -2496597161129373974
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Simulates and explains dice rolls from a variety of game systems.
+summary: Simulates and explains dice rolls from simple "1d6" to complex "roll 7 ten-sided
+  dice, take best 3, results of 10 roll again and add on".
 test_files:
 - spec/bunch_spec.rb
 - spec/complex_die_spec.rb
 - spec/dice_spec.rb
 - spec/die_result_spec.rb
 - spec/die_spec.rb
+- spec/helpers.rb
 - spec/map_rule_spec.rb
 - spec/parser_spec.rb
 - spec/probability_spec.rb