spec/probability_spec.rb in games_dice-0.3.12 vs spec/probability_spec.rb in games_dice-0.4.0

- old
+ new

@@ -1,526 +1,530 @@ -require 'helpers' - -describe GamesDice::Probabilities do - describe "class methods" do - describe "#new" do - it "should create a new distribution from an array and offset" do - pr = GamesDice::Probabilities.new( [1.0], 1 ) - pr.should be_a GamesDice::Probabilities - pr.to_h.should be_valid_distribution - end - - it "should raise an error if passed incorrect parameter types" do - lambda { GamesDice::Probabilities.new( [ nil ], 20 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.new( [0.3,nil,0.5], 7 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.new( [0.3,0.2,0.5], {} ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.new( {:x=>:y}, 17 ) }.should raise_error TypeError - end - - it "should raise an error if distribution is incomplete or inaccurate" do - lambda { GamesDice::Probabilities.new( [0.3,0.2,0.6], 3 ) }.should raise_error ArgumentError - lambda { GamesDice::Probabilities.new( [], 1 ) }.should raise_error ArgumentError - lambda { GamesDice::Probabilities.new( [0.9], 1 ) }.should raise_error ArgumentError - lambda { GamesDice::Probabilities.new( [-0.9,0.2,0.9], 1 ) }.should raise_error ArgumentError - end - end - - describe "#for_fair_die" do - it "should create a new distribution based on number of sides" do - pr2 = GamesDice::Probabilities.for_fair_die( 2 ) - pr2.should be_a GamesDice::Probabilities - pr2.to_h.should == { 1 => 0.5, 2 => 0.5 } - (1..20).each do |sides| - pr = GamesDice::Probabilities.for_fair_die( sides ) - pr.should be_a GamesDice::Probabilities - h = pr.to_h - h.should be_valid_distribution - h.keys.count.should == sides - h.values.each { |v| v.should be_within(1e-10).of 1.0/sides } - end - end - - it "should raise an error if number of sides is not an integer" do - lambda { GamesDice::Probabilities.for_fair_die( {} ) }.should raise_error TypeError - end - - it "should raise an error if number of sides is too low or too high" do - lambda { GamesDice::Probabilities.for_fair_die( 0 ) }.should raise_error ArgumentError - lambda { GamesDice::Probabilities.for_fair_die( 1000001 ) }.should raise_error ArgumentError - end - end - - describe "#add_distributions" do - it "should combine two distributions to create a third one" do - d4a = GamesDice::Probabilities.new( [ 1.0/4, 1.0/4, 1.0/4, 1.0/4 ], 1 ) - d4b = GamesDice::Probabilities.new( [ 1.0/10, 2.0/10, 3.0/10, 4.0/10], 1 ) - pr = GamesDice::Probabilities.add_distributions( d4a, d4b ) - pr.to_h.should be_valid_distribution - end - - it "should calculate a classic 2d6 distribution accurately" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - pr = GamesDice::Probabilities.add_distributions( d6, d6 ) - h = pr.to_h - h.should be_valid_distribution - h[2].should be_within(1e-9).of 1.0/36 - h[3].should be_within(1e-9).of 2.0/36 - h[4].should be_within(1e-9).of 3.0/36 - h[5].should be_within(1e-9).of 4.0/36 - h[6].should be_within(1e-9).of 5.0/36 - h[7].should be_within(1e-9).of 6.0/36 - h[8].should be_within(1e-9).of 5.0/36 - h[9].should be_within(1e-9).of 4.0/36 - h[10].should be_within(1e-9).of 3.0/36 - h[11].should be_within(1e-9).of 2.0/36 - h[12].should be_within(1e-9).of 1.0/36 - end - - it "should raise an error if either parameter is not a GamesDice::Probabilities object" do - d10 = GamesDice::Probabilities.for_fair_die( 10 ) - lambda { GamesDice::Probabilities.add_distributions( '', 6 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.add_distributions( d10, 6 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.add_distributions( '', d10 ) }.should raise_error TypeError - end - end - - describe "#add_distributions_mult" do - it "should combine two multiplied distributions to create a third one" do - d4a = GamesDice::Probabilities.new( [ 1.0/4, 1.0/4, 1.0/4, 1.0/4 ], 1 ) - d4b = GamesDice::Probabilities.new( [ 1.0/10, 2.0/10, 3.0/10, 4.0/10], 1 ) - pr = GamesDice::Probabilities.add_distributions_mult( 2, d4a, -1, d4b ) - pr.to_h.should be_valid_distribution - end - - it "should calculate a distribution for '1d6 - 1d4' accurately" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - d4 = GamesDice::Probabilities.for_fair_die( 4 ) - pr = GamesDice::Probabilities.add_distributions_mult( 1, d6, -1, d4 ) - h = pr.to_h - h.should be_valid_distribution - h[-3].should be_within(1e-9).of 1.0/24 - h[-2].should be_within(1e-9).of 2.0/24 - h[-1].should be_within(1e-9).of 3.0/24 - h[0].should be_within(1e-9).of 4.0/24 - h[1].should be_within(1e-9).of 4.0/24 - h[2].should be_within(1e-9).of 4.0/24 - h[3].should be_within(1e-9).of 3.0/24 - h[4].should be_within(1e-9).of 2.0/24 - h[5].should be_within(1e-9).of 1.0/24 - end - - it "should add asymmetric distributions accurately" do - da = GamesDice::Probabilities.new( [0.7,0.0,0.3], 2 ) - db = GamesDice::Probabilities.new( [0.5,0.3,0.2], 2 ) - pr = GamesDice::Probabilities.add_distributions_mult( 1, da, 2, db ) - h = pr.to_h - h.should be_valid_distribution - h[6].should be_within(1e-9).of 0.7 * 0.5 - h[8].should be_within(1e-9).of 0.7 * 0.3 + 0.3 * 0.5 - h[10].should be_within(1e-9).of 0.7 * 0.2 + 0.3 * 0.3 - h[12].should be_within(1e-9).of 0.3 * 0.2 - end - - it "should raise an error if passed incorrect objects for distributions" do - d10 = GamesDice::Probabilities.for_fair_die( 10 ) - lambda { GamesDice::Probabilities.add_distributions_mult( 1, '', -1, 6 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.add_distributions_mult( 2, d10, 3, 6 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.add_distributions_mult( 1, '', -1, d10 ) }.should raise_error TypeError - end - - it "should raise an error if passed incorrect objects for multipliers" do - d10 = GamesDice::Probabilities.for_fair_die( 10 ) - lambda { GamesDice::Probabilities.add_distributions_mult( {}, d10, [], d10 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.add_distributions_mult( [7], d10, 3, d10 ) }.should raise_error TypeError - lambda { GamesDice::Probabilities.add_distributions_mult( 1, d10, {}, d10 ) }.should raise_error TypeError - end - end - - describe "#from_h" do - it "should create a Probabilities object from a valid hash" do - pr = GamesDice::Probabilities.from_h( { 7 => 0.5, 9 => 0.5 } ) - pr.should be_a GamesDice::Probabilities - end - - it "should raise an ArgumentError when called with a non-valid hash" do - lambda { GamesDice::Probabilities.from_h( { 7 => 0.5, 9 => 0.6 } ) }.should raise_error ArgumentError - end - - it "should raise an TypeError when called with data that is not a hash" do - lambda { GamesDice::Probabilities.from_h( :foo ) }.should raise_error TypeError - end - - it "should raise a TypeError when called when keys and values are not all integers and floats" do - lambda { GamesDice::Probabilities.from_h( { 'x' => 0.5, 9 => 0.5 } ) }.should raise_error - lambda { GamesDice::Probabilities.from_h( { 7 => [], 9 => 0.5 } ) }.should raise_error TypeError - end - - it "should raise an ArgumentError when results are spread very far apart" do - lambda { GamesDice::Probabilities.from_h( { 0 => 0.5, 2000000 => 0.5 } ) }.should raise_error ArgumentError - end - end - - describe "#implemented_in" do - it "should be either :c or :ruby" do - lang = GamesDice::Probabilities.implemented_in - lang.should be_a Symbol - [:c, :ruby].member?( lang ).should == true - end - end - end # describe "class methods" - - describe "instance methods" do - let(:pr2) { GamesDice::Probabilities.for_fair_die( 2 ) } - let(:pr4) { GamesDice::Probabilities.for_fair_die( 4 ) } - let(:pr6) { GamesDice::Probabilities.for_fair_die( 6 ) } - let(:pr10) { GamesDice::Probabilities.for_fair_die( 10 ) } - let(:pra) { GamesDice::Probabilities.new( [ 0.4, 0.2, 0.4 ], -1 ) } - - describe "#each" do - it "should iterate through all result/probability pairs" do - yielded = [] - pr4.each { |r,p| yielded << [r,p] } - yielded.should == [ [1,0.25], [2,0.25], [3,0.25], [4,0.25] ] - end - - it "should skip zero probabilities" do - pr_plus_minus = GamesDice::Probabilities.new( [ 0.5, 0.0, 0.5 ], -1 ) - yielded = [] - pr_plus_minus .each { |r,p| yielded << [r,p] } - yielded.should == [ [-1,0.5], [1,0.5] ] - end - end - - describe "#p_eql" do - it "should return probability of getting a number inside the range" do - pr2.p_eql(2).should be_within(1.0e-9).of 0.5 - pr4.p_eql(1).should be_within(1.0e-9).of 0.25 - pr6.p_eql(6).should be_within(1.0e-9).of 1.0/6 - pr10.p_eql(3).should be_within(1.0e-9).of 0.1 - pra.p_eql(-1).should be_within(1.0e-9).of 0.4 - end - - it "should return 0.0 for values not covered by distribution" do - pr2.p_eql(3).should == 0.0 - pr4.p_eql(-1).should == 0.0 - pr6.p_eql(8).should == 0.0 - pr10.p_eql(11).should == 0.0 - pra.p_eql(2).should == 0.0 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr2.p_eql( [] ) }.should raise_error TypeError - end - end # describe "#p_eql" - - describe "#p_gt" do - it "should return probability of getting a number greater than target" do - pr2.p_gt(1).should be_within(1.0e-9).of 0.5 - pr4.p_gt(3).should be_within(1.0e-9).of 0.25 - pr6.p_gt(2).should be_within(1.0e-9).of 4.0/6 - pr10.p_gt(6).should be_within(1.0e-9).of 0.4 - - # Trying more than one, due to possibilities of caching error (in pure Ruby implementation) - pra.p_gt(-2).should be_within(1.0e-9).of 1.0 - pra.p_gt(-1).should be_within(1.0e-9).of 0.6 - pra.p_gt(0).should be_within(1.0e-9).of 0.4 - pra.p_gt(1).should be_within(1.0e-9).of 0.0 - end - - it "should return 0.0 when the target number is equal or higher than maximum possible" do - pr2.p_gt(2).should == 0.0 - pr4.p_gt(5).should == 0.0 - pr6.p_gt(6).should == 0.0 - pr10.p_gt(20).should == 0.0 - pra.p_gt(3).should == 0.0 - end - - it "should return 1.0 when the target number is lower than minimum" do - pr2.p_gt(0).should == 1.0 - pr4.p_gt(-5).should == 1.0 - pr6.p_gt(0).should == 1.0 - pr10.p_gt(-200).should == 1.0 - pra.p_gt(-2).should == 1.0 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr2.p_gt( {} ) }.should raise_error TypeError - end - end # describe "#p_gt" - - describe "#p_ge" do - it "should return probability of getting a number greater than or equal to target" do - pr2.p_ge(2).should be_within(1.0e-9).of 0.5 - pr4.p_ge(3).should be_within(1.0e-9).of 0.5 - pr6.p_ge(2).should be_within(1.0e-9).of 5.0/6 - pr10.p_ge(6).should be_within(1.0e-9).of 0.5 - end - - it "should return 0.0 when the target number is higher than maximum possible" do - pr2.p_ge(6).should == 0.0 - pr4.p_ge(5).should == 0.0 - pr6.p_ge(7).should == 0.0 - pr10.p_ge(20).should == 0.0 - end - - it "should return 1.0 when the target number is lower than or equal to minimum possible" do - pr2.p_ge(1).should == 1.0 - pr4.p_ge(-5).should == 1.0 - pr6.p_ge(1).should == 1.0 - pr10.p_ge(-200).should == 1.0 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr4.p_ge( {} ) }.should raise_error TypeError - end - end # describe "#p_ge" - - describe "#p_le" do - it "should return probability of getting a number less than or equal to target" do - pr2.p_le(1).should be_within(1.0e-9).of 0.5 - pr4.p_le(2).should be_within(1.0e-9).of 0.5 - pr6.p_le(2).should be_within(1.0e-9).of 2.0/6 - pr10.p_le(6).should be_within(1.0e-9).of 0.6 - end - - it "should return 1.0 when the target number is higher than or equal to maximum possible" do - pr2.p_le(6).should == 1.0 - pr4.p_le(4).should == 1.0 - pr6.p_le(7).should == 1.0 - pr10.p_le(10).should == 1.0 - end - - it "should return 0.0 when the target number is lower than minimum possible" do - pr2.p_le(0).should == 0.0 - pr4.p_le(-5).should == 0.0 - pr6.p_le(0).should == 0.0 - pr10.p_le(-200).should == 0.0 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr4.p_le( [] ) }.should raise_error TypeError - end - end # describe "#p_le" - - describe "#p_lt" do - it "should return probability of getting a number less than target" do - pr2.p_lt(2).should be_within(1.0e-9).of 0.5 - pr4.p_lt(3).should be_within(1.0e-9).of 0.5 - pr6.p_lt(2).should be_within(1.0e-9).of 1/6.0 - pr10.p_lt(6).should be_within(1.0e-9).of 0.5 - end - - it "should return 1.0 when the target number is higher than maximum possible" do - pr2.p_lt(6).should == 1.0 - pr4.p_lt(5).should == 1.0 - pr6.p_lt(7).should == 1.0 - pr10.p_lt(20).should == 1.0 - end - - it "should return 0.0 when the target number is lower than or equal to minimum possible" do - pr2.p_lt(1).should == 0.0 - pr4.p_lt(-5).should == 0.0 - pr6.p_lt(1).should == 0.0 - pr10.p_lt(-200).should == 0.0 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr6.p_lt( {} ) }.should raise_error TypeError - end - end # describe "#p_lt" - - describe "#to_h" do - # This is used loads in other tests - it "should represent a valid distribution with each integer result associated with its probability" do - pr2.to_h.should be_valid_distribution - pr4.to_h.should be_valid_distribution - pr6.to_h.should be_valid_distribution - pr10.to_h.should be_valid_distribution - end - end - - describe "#min" do - it "should return lowest possible result allowed by distribution" do - pr2.min.should == 1 - pr4.min.should == 1 - pr6.min.should == 1 - pr10.min.should == 1 - GamesDice::Probabilities.add_distributions( pr6, pr10 ).min.should == 2 - end - end - - describe "#max" do - it "should return highest possible result allowed by distribution" do - pr2.max.should == 2 - pr4.max.should == 4 - pr6.max.should == 6 - pr10.max.should == 10 - GamesDice::Probabilities.add_distributions( pr6, pr10 ).max.should == 16 - end - end - - describe "#expected" do - it "should return the weighted mean value" do - pr2.expected.should be_within(1.0e-9).of 1.5 - pr4.expected.should be_within(1.0e-9).of 2.5 - pr6.expected.should be_within(1.0e-9).of 3.5 - pr10.expected.should be_within(1.0e-9).of 5.5 - GamesDice::Probabilities.add_distributions( pr6, pr10 ).expected.should be_within(1.0e-9).of 9.0 - end - end - - describe "#given_ge" do - it "should return a new distribution with probabilities calculated assuming value is >= target" do - pd = pr2.given_ge(2) - pd.to_h.should == { 2 => 1.0 } - pd = pr10.given_ge(4) - pd.to_h.should be_valid_distribution - pd.p_eql( 3 ).should == 0.0 - pd.p_eql( 10 ).should be_within(1.0e-9).of 0.1/0.7 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr10.given_ge( [] ) }.should raise_error TypeError - end - end - - describe "#given_le" do - it "should return a new distribution with probabilities calculated assuming value is <= target" do - pd = pr2.given_le(2) - pd.to_h.should == { 1 => 0.5, 2 => 0.5 } - pd = pr10.given_le(4) - pd.to_h.should be_valid_distribution - pd.p_eql( 3 ).should be_within(1.0e-9).of 0.1/0.4 - pd.p_eql( 10 ).should == 0.0 - end - - it "should raise a TypeError if asked for probability of non-Integer" do - lambda { pr10.given_le( {} ) }.should raise_error TypeError - end - end - - describe "#repeat_sum" do - it "should output a valid distribution if params are valid" do - d4a = GamesDice::Probabilities.new( [ 1.0/4, 1.0/4, 1.0/4, 1.0/4 ], 1 ) - d4b = GamesDice::Probabilities.new( [ 1.0/10, 2.0/10, 3.0/10, 4.0/10], 1 ) - pr = d4a.repeat_sum( 7 ) - pr.to_h.should be_valid_distribution - pr = d4b.repeat_sum( 12 ) - pr.to_h.should be_valid_distribution - end - - it "should raise an error if any param is unexpected type" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - lambda{ d6.repeat_sum( {} ) }.should raise_error TypeError - end - - it "should raise an error if distribution would have more than a million results" do - d1000 = GamesDice::Probabilities.for_fair_die( 1000 ) - lambda{ d1000.repeat_sum( 11000 ) }.should raise_error - end - - it "should calculate a '3d6' distribution accurately" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - pr = d6.repeat_sum( 3 ) - h = pr.to_h - h.should be_valid_distribution - h[3].should be_within(1e-9).of 1.0/216 - h[4].should be_within(1e-9).of 3.0/216 - h[5].should be_within(1e-9).of 6.0/216 - h[6].should be_within(1e-9).of 10.0/216 - h[7].should be_within(1e-9).of 15.0/216 - h[8].should be_within(1e-9).of 21.0/216 - h[9].should be_within(1e-9).of 25.0/216 - h[10].should be_within(1e-9).of 27.0/216 - h[11].should be_within(1e-9).of 27.0/216 - h[12].should be_within(1e-9).of 25.0/216 - h[13].should be_within(1e-9).of 21.0/216 - h[14].should be_within(1e-9).of 15.0/216 - h[15].should be_within(1e-9).of 10.0/216 - h[16].should be_within(1e-9).of 6.0/216 - h[17].should be_within(1e-9).of 3.0/216 - h[18].should be_within(1e-9).of 1.0/216 - end - end # describe "#repeat_sum" - - describe "#repeat_n_sum_k" do - it "should output a valid distribution if params are valid" do - d4a = GamesDice::Probabilities.new( [ 1.0/4, 1.0/4, 1.0/4, 1.0/4 ], 1 ) - d4b = GamesDice::Probabilities.new( [ 1.0/10, 2.0/10, 3.0/10, 4.0/10], 1 ) - pr = d4a.repeat_n_sum_k( 3, 2 ) - pr.to_h.should be_valid_distribution - pr = d4b.repeat_n_sum_k( 12, 4 ) - pr.to_h.should be_valid_distribution - end - - it "should raise an error if any param is unexpected type" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - lambda{ d6.repeat_n_sum_k( {}, 10 ) }.should raise_error TypeError - lambda{ d6.repeat_n_sum_k( 10, {} ) }.should raise_error TypeError - end - - it "should raise an error if n is greater than 170" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - lambda{ d6.repeat_n_sum_k( 171, 10 ) }.should raise_error - end - - it "should calculate a '4d6 keep best 3' distribution accurately" do - d6 = GamesDice::Probabilities.for_fair_die( 6 ) - pr = d6.repeat_n_sum_k( 4, 3 ) - h = pr.to_h - h.should be_valid_distribution - h[3].should be_within(1e-10).of 1/1296.0 - h[4].should be_within(1e-10).of 4/1296.0 - h[5].should be_within(1e-10).of 10/1296.0 - h[6].should be_within(1e-10).of 21/1296.0 - h[7].should be_within(1e-10).of 38/1296.0 - h[8].should be_within(1e-10).of 62/1296.0 - h[9].should be_within(1e-10).of 91/1296.0 - h[10].should be_within(1e-10).of 122/1296.0 - h[11].should be_within(1e-10).of 148/1296.0 - h[12].should be_within(1e-10).of 167/1296.0 - h[13].should be_within(1e-10).of 172/1296.0 - h[14].should be_within(1e-10).of 160/1296.0 - h[15].should be_within(1e-10).of 131/1296.0 - h[16].should be_within(1e-10).of 94/1296.0 - h[17].should be_within(1e-10).of 54/1296.0 - h[18].should be_within(1e-10).of 21/1296.0 - end - - it "should calculate a '2d20 keep worst result' distribution accurately" do - d20 = GamesDice::Probabilities.for_fair_die( 20 ) - pr = d20.repeat_n_sum_k( 2, 1, :keep_worst ) - h = pr.to_h - h.should be_valid_distribution - h[1].should be_within(1e-10).of 39/400.0 - h[2].should be_within(1e-10).of 37/400.0 - h[3].should be_within(1e-10).of 35/400.0 - h[4].should be_within(1e-10).of 33/400.0 - h[5].should be_within(1e-10).of 31/400.0 - h[6].should be_within(1e-10).of 29/400.0 - h[7].should be_within(1e-10).of 27/400.0 - h[8].should be_within(1e-10).of 25/400.0 - h[9].should be_within(1e-10).of 23/400.0 - h[10].should be_within(1e-10).of 21/400.0 - h[11].should be_within(1e-10).of 19/400.0 - h[12].should be_within(1e-10).of 17/400.0 - h[13].should be_within(1e-10).of 15/400.0 - h[14].should be_within(1e-10).of 13/400.0 - h[15].should be_within(1e-10).of 11/400.0 - h[16].should be_within(1e-10).of 9/400.0 - h[17].should be_within(1e-10).of 7/400.0 - h[18].should be_within(1e-10).of 5/400.0 - h[19].should be_within(1e-10).of 3/400.0 - h[20].should be_within(1e-10).of 1/400.0 - end - end # describe "#repeat_n_sum_k" - - end # describe "instance methods" - - describe "serialisation via Marshall" do - it "can load a saved GamesDice::Probabilities" do - pd6 = File.open( fixture('probs_fair_die_6.dat') ) { |file| Marshal.load(file) } - pd6.to_h.should be_valid_distribution - pd6.p_gt(4).should be_within(1e-10).of 1.0/3 - end - end -end +# frozen_string_literal: true + +require 'helpers' + +describe GamesDice::Probabilities do + describe 'class methods' do + describe '#new' do + it 'should create a new distribution from an array and offset' do + pr = GamesDice::Probabilities.new([1.0], 1) + expect(pr).to be_a GamesDice::Probabilities + expect(pr.to_h).to be_valid_distribution + end + + it 'should raise an error if passed incorrect parameter types' do + expect(-> { GamesDice::Probabilities.new([nil], 20) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.new([0.3, nil, 0.5], 7) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.new([0.3, 0.2, 0.5], {}) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.new({ x: :y }, 17) }).to raise_error TypeError + end + + it 'should raise an error if distribution is incomplete or inaccurate' do + expect(-> { GamesDice::Probabilities.new([0.3, 0.2, 0.6], 3) }).to raise_error ArgumentError + expect(-> { GamesDice::Probabilities.new([], 1) }).to raise_error ArgumentError + expect(-> { GamesDice::Probabilities.new([0.9], 1) }).to raise_error ArgumentError + expect(-> { GamesDice::Probabilities.new([-0.9, 0.2, 0.9], 1) }).to raise_error ArgumentError + end + end + + describe '#for_fair_die' do + it 'should create a new distribution based on number of sides' do + pr2 = GamesDice::Probabilities.for_fair_die(2) + expect(pr2).to be_a GamesDice::Probabilities + expect(pr2.to_h).to eql({ 1 => 0.5, 2 => 0.5 }) + (1..20).each do |sides| + pr = GamesDice::Probabilities.for_fair_die(sides) + expect(pr).to be_a GamesDice::Probabilities + h = pr.to_h + expect(h).to be_valid_distribution + expect(h.keys.count).to eql sides + h.each_value { |v| expect(v).to be_within(1e-10).of 1.0 / sides } + end + end + + it 'should raise an error if number of sides is not an integer' do + expect(-> { GamesDice::Probabilities.for_fair_die({}) }).to raise_error TypeError + end + + it 'should raise an error if number of sides is too low or too high' do + expect(-> { GamesDice::Probabilities.for_fair_die(0) }).to raise_error ArgumentError + expect(-> { GamesDice::Probabilities.for_fair_die(1_000_001) }).to raise_error ArgumentError + end + end + + describe '#add_distributions' do + it 'should combine two distributions to create a third one' do + d4a = GamesDice::Probabilities.new([1.0 / 4, 1.0 / 4, 1.0 / 4, 1.0 / 4], 1) + d4b = GamesDice::Probabilities.new([1.0 / 10, 2.0 / 10, 3.0 / 10, 4.0 / 10], 1) + pr = GamesDice::Probabilities.add_distributions(d4a, d4b) + expect(pr.to_h).to be_valid_distribution + end + + it 'should calculate a classic 2d6 distribution accurately' do + d6 = GamesDice::Probabilities.for_fair_die(6) + pr = GamesDice::Probabilities.add_distributions(d6, d6) + h = pr.to_h + expect(h).to be_valid_distribution + expect(h[2]).to be_within(1e-9).of 1.0 / 36 + expect(h[3]).to be_within(1e-9).of 2.0 / 36 + expect(h[4]).to be_within(1e-9).of 3.0 / 36 + expect(h[5]).to be_within(1e-9).of 4.0 / 36 + expect(h[6]).to be_within(1e-9).of 5.0 / 36 + expect(h[7]).to be_within(1e-9).of 6.0 / 36 + expect(h[8]).to be_within(1e-9).of 5.0 / 36 + expect(h[9]).to be_within(1e-9).of 4.0 / 36 + expect(h[10]).to be_within(1e-9).of 3.0 / 36 + expect(h[11]).to be_within(1e-9).of 2.0 / 36 + expect(h[12]).to be_within(1e-9).of 1.0 / 36 + end + + it 'should raise an error if either parameter is not a GamesDice::Probabilities object' do + d10 = GamesDice::Probabilities.for_fair_die(10) + expect(-> { GamesDice::Probabilities.add_distributions('', 6) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.add_distributions(d10, 6) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.add_distributions('', d10) }).to raise_error TypeError + end + end + + describe '#add_distributions_mult' do + it 'should combine two multiplied distributions to create a third one' do + d4a = GamesDice::Probabilities.new([1.0 / 4, 1.0 / 4, 1.0 / 4, 1.0 / 4], 1) + d4b = GamesDice::Probabilities.new([1.0 / 10, 2.0 / 10, 3.0 / 10, 4.0 / 10], 1) + pr = GamesDice::Probabilities.add_distributions_mult(2, d4a, -1, d4b) + expect(pr.to_h).to be_valid_distribution + end + + it "should calculate a distribution for '1d6 - 1d4' accurately" do + d6 = GamesDice::Probabilities.for_fair_die(6) + d4 = GamesDice::Probabilities.for_fair_die(4) + pr = GamesDice::Probabilities.add_distributions_mult(1, d6, -1, d4) + h = pr.to_h + expect(h).to be_valid_distribution + expect(h[-3]).to be_within(1e-9).of 1.0 / 24 + expect(h[-2]).to be_within(1e-9).of 2.0 / 24 + expect(h[-1]).to be_within(1e-9).of 3.0 / 24 + expect(h[0]).to be_within(1e-9).of 4.0 / 24 + expect(h[1]).to be_within(1e-9).of 4.0 / 24 + expect(h[2]).to be_within(1e-9).of 4.0 / 24 + expect(h[3]).to be_within(1e-9).of 3.0 / 24 + expect(h[4]).to be_within(1e-9).of 2.0 / 24 + expect(h[5]).to be_within(1e-9).of 1.0 / 24 + end + + it 'should add asymmetric distributions accurately' do + da = GamesDice::Probabilities.new([0.7, 0.0, 0.3], 2) + db = GamesDice::Probabilities.new([0.5, 0.3, 0.2], 2) + pr = GamesDice::Probabilities.add_distributions_mult(1, da, 2, db) + h = pr.to_h + expect(h).to be_valid_distribution + expect(h[6]).to be_within(1e-9).of 0.7 * 0.5 + expect(h[8]).to be_within(1e-9).of (0.7 * 0.3) + (0.3 * 0.5) + expect(h[10]).to be_within(1e-9).of (0.7 * 0.2) + (0.3 * 0.3) + expect(h[12]).to be_within(1e-9).of 0.3 * 0.2 + end + + it 'should raise an error if passed incorrect objects for distributions' do + d10 = GamesDice::Probabilities.for_fair_die(10) + expect(-> { GamesDice::Probabilities.add_distributions_mult(1, '', -1, 6) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.add_distributions_mult(2, d10, 3, 6) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.add_distributions_mult(1, '', -1, d10) }).to raise_error TypeError + end + + it 'should raise an error if passed incorrect objects for multipliers' do + d10 = GamesDice::Probabilities.for_fair_die(10) + expect(-> { GamesDice::Probabilities.add_distributions_mult({}, d10, [], d10) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.add_distributions_mult([7], d10, 3, d10) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.add_distributions_mult(1, d10, {}, d10) }).to raise_error TypeError + end + end + + describe '#from_h' do + it 'should create a Probabilities object from a valid hash' do + pr = GamesDice::Probabilities.from_h({ 7 => 0.5, 9 => 0.5 }) + expect(pr).to be_a GamesDice::Probabilities + end + + it 'should raise an ArgumentError when called with a non-valid hash' do + expect(-> { GamesDice::Probabilities.from_h({ 7 => 0.5, 9 => 0.6 }) }).to raise_error ArgumentError + end + + it 'should raise an TypeError when called with data that is not a hash' do + expect(-> { GamesDice::Probabilities.from_h(:foo) }).to raise_error TypeError + end + + it 'should raise a TypeError when called when keys and values are not all integers and floats' do + expect(-> { GamesDice::Probabilities.from_h({ 'x' => 0.5, 9 => 0.5 }) }).to raise_error TypeError + expect(-> { GamesDice::Probabilities.from_h({ 7 => [], 9 => 0.5 }) }).to raise_error TypeError + end + + it 'should raise an ArgumentError when results are spread very far apart' do + expect(-> { GamesDice::Probabilities.from_h({ 0 => 0.5, 2_000_000 => 0.5 }) }).to raise_error ArgumentError + end + end + + describe '#implemented_in' do + it 'should be either :c or :ruby' do + lang = GamesDice::Probabilities.implemented_in + expect(lang).to be_a Symbol + expect(%i[c ruby].member?(lang)).to eql true + end + end + end + + describe 'instance methods' do + let(:pr2) { GamesDice::Probabilities.for_fair_die(2) } + let(:pr4) { GamesDice::Probabilities.for_fair_die(4) } + let(:pr6) { GamesDice::Probabilities.for_fair_die(6) } + let(:pr10) { GamesDice::Probabilities.for_fair_die(10) } + let(:pra) { GamesDice::Probabilities.new([0.4, 0.2, 0.4], -1) } + + describe '#each' do + it 'should iterate through all result/probability pairs' do + yielded = [] + pr4.each { |r, p| yielded << [r, p] } + expect(yielded).to eql [[1, 0.25], [2, 0.25], [3, 0.25], [4, 0.25]] + end + + it 'should skip zero probabilities' do + pr_plus_minus = GamesDice::Probabilities.new([0.5, 0.0, 0.5], -1) + yielded = [] + pr_plus_minus.each { |r, p| yielded << [r, p] } + expect(yielded).to eql [[-1, 0.5], [1, 0.5]] + end + end + + describe '#p_eql' do + it 'should return probability of getting a number inside the range' do + expect(pr2.p_eql(2)).to be_within(1.0e-9).of 0.5 + expect(pr4.p_eql(1)).to be_within(1.0e-9).of 0.25 + expect(pr6.p_eql(6)).to be_within(1.0e-9).of 1.0 / 6 + expect(pr10.p_eql(3)).to be_within(1.0e-9).of 0.1 + expect(pra.p_eql(-1)).to be_within(1.0e-9).of 0.4 + end + + it 'should return 0.0 for values not covered by distribution' do + expect(pr2.p_eql(3)).to eql 0.0 + expect(pr4.p_eql(-1)).to eql 0.0 + expect(pr6.p_eql(8)).to eql 0.0 + expect(pr10.p_eql(11)).to eql 0.0 + expect(pra.p_eql(2)).to eql 0.0 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr2.p_eql([]) }).to raise_error TypeError + end + end + + describe '#p_gt' do + it 'should return probability of getting a number greater than target' do + expect(pr2.p_gt(1)).to be_within(1.0e-9).of 0.5 + expect(pr4.p_gt(3)).to be_within(1.0e-9).of 0.25 + expect(pr6.p_gt(2)).to be_within(1.0e-9).of 4.0 / 6 + expect(pr10.p_gt(6)).to be_within(1.0e-9).of 0.4 + + # Trying more than one, due to possibilities of caching error (in pure Ruby implementation) + expect(pra.p_gt(-2)).to be_within(1.0e-9).of 1.0 + expect(pra.p_gt(-1)).to be_within(1.0e-9).of 0.6 + expect(pra.p_gt(0)).to be_within(1.0e-9).of 0.4 + expect(pra.p_gt(1)).to be_within(1.0e-9).of 0.0 + end + + it 'should return 0.0 when the target number is equal or higher than maximum possible' do + expect(pr2.p_gt(2)).to eql 0.0 + expect(pr4.p_gt(5)).to eql 0.0 + expect(pr6.p_gt(6)).to eql 0.0 + expect(pr10.p_gt(20)).to eql 0.0 + expect(pra.p_gt(3)).to eql 0.0 + end + + it 'should return 1.0 when the target number is lower than minimum' do + expect(pr2.p_gt(0)).to eql 1.0 + expect(pr4.p_gt(-5)).to eql 1.0 + expect(pr6.p_gt(0)).to eql 1.0 + expect(pr10.p_gt(-200)).to eql 1.0 + expect(pra.p_gt(-2)).to eql 1.0 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr2.p_gt({}) }).to raise_error TypeError + end + end + + describe '#p_ge' do + it 'should return probability of getting a number greater than or equal to target' do + expect(pr2.p_ge(2)).to be_within(1.0e-9).of 0.5 + expect(pr4.p_ge(3)).to be_within(1.0e-9).of 0.5 + expect(pr6.p_ge(2)).to be_within(1.0e-9).of 5.0 / 6 + expect(pr10.p_ge(6)).to be_within(1.0e-9).of 0.5 + end + + it 'should return 0.0 when the target number is higher than maximum possible' do + expect(pr2.p_ge(6)).to eql 0.0 + expect(pr4.p_ge(5)).to eql 0.0 + expect(pr6.p_ge(7)).to eql 0.0 + expect(pr10.p_ge(20)).to eql 0.0 + end + + it 'should return 1.0 when the target number is lower than or equal to minimum possible' do + expect(pr2.p_ge(1)).to eql 1.0 + expect(pr4.p_ge(-5)).to eql 1.0 + expect(pr6.p_ge(1)).to eql 1.0 + expect(pr10.p_ge(-200)).to eql 1.0 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr4.p_ge({}) }).to raise_error TypeError + end + end + + describe '#p_le' do + it 'should return probability of getting a number less than or equal to target' do + expect(pr2.p_le(1)).to be_within(1.0e-9).of 0.5 + expect(pr4.p_le(2)).to be_within(1.0e-9).of 0.5 + expect(pr6.p_le(2)).to be_within(1.0e-9).of 2.0 / 6 + expect(pr10.p_le(6)).to be_within(1.0e-9).of 0.6 + end + + it 'should return 1.0 when the target number is higher than or equal to maximum possible' do + expect(pr2.p_le(6)).to eql 1.0 + expect(pr4.p_le(4)).to eql 1.0 + expect(pr6.p_le(7)).to eql 1.0 + expect(pr10.p_le(10)).to eql 1.0 + end + + it 'should return 0.0 when the target number is lower than minimum possible' do + expect(pr2.p_le(0)).to eql 0.0 + expect(pr4.p_le(-5)).to eql 0.0 + expect(pr6.p_le(0)).to eql 0.0 + expect(pr10.p_le(-200)).to eql 0.0 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr4.p_le([]) }).to raise_error TypeError + end + end + + describe '#p_lt' do + it 'should return probability of getting a number less than target' do + expect(pr2.p_lt(2)).to be_within(1.0e-9).of 0.5 + expect(pr4.p_lt(3)).to be_within(1.0e-9).of 0.5 + expect(pr6.p_lt(2)).to be_within(1.0e-9).of 1 / 6.0 + expect(pr10.p_lt(6)).to be_within(1.0e-9).of 0.5 + end + + it 'should return 1.0 when the target number is higher than maximum possible' do + expect(pr2.p_lt(6)).to eql 1.0 + expect(pr4.p_lt(5)).to eql 1.0 + expect(pr6.p_lt(7)).to eql 1.0 + expect(pr10.p_lt(20)).to eql 1.0 + end + + it 'should return 0.0 when the target number is lower than or equal to minimum possible' do + expect(pr2.p_lt(1)).to eql 0.0 + expect(pr4.p_lt(-5)).to eql 0.0 + expect(pr6.p_lt(1)).to eql 0.0 + expect(pr10.p_lt(-200)).to eql 0.0 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr6.p_lt({}) }).to raise_error TypeError + end + end + + describe '#to_h' do + # This is used loads in other tests + it 'should represent a valid distribution with each integer result associated with its probability' do + expect(pr2.to_h).to be_valid_distribution + expect(pr4.to_h).to be_valid_distribution + expect(pr6.to_h).to be_valid_distribution + expect(pr10.to_h).to be_valid_distribution + end + end + + describe '#min' do + it 'should return lowest possible result allowed by distribution' do + expect(pr2.min).to eql 1 + expect(pr4.min).to eql 1 + expect(pr6.min).to eql 1 + expect(pr10.min).to eql 1 + expect(GamesDice::Probabilities.add_distributions(pr6, pr10).min).to eql 2 + end + end + + describe '#max' do + it 'should return highest possible result allowed by distribution' do + expect(pr2.max).to eql 2 + expect(pr4.max).to eql 4 + expect(pr6.max).to eql 6 + expect(pr10.max).to eql 10 + expect(GamesDice::Probabilities.add_distributions(pr6, pr10).max).to eql 16 + end + end + + describe '#expected' do + it 'should return the weighted mean value' do + expect(pr2.expected).to be_within(1.0e-9).of 1.5 + expect(pr4.expected).to be_within(1.0e-9).of 2.5 + expect(pr6.expected).to be_within(1.0e-9).of 3.5 + expect(pr10.expected).to be_within(1.0e-9).of 5.5 + expect(GamesDice::Probabilities.add_distributions(pr6, pr10).expected).to be_within(1.0e-9).of 9.0 + end + end + + describe '#given_ge' do + it 'should return a new distribution with probabilities calculated assuming value is >= target' do + pd = pr2.given_ge(2) + expect(pd.to_h).to eql({ 2 => 1.0 }) + pd = pr10.given_ge(4) + expect(pd.to_h).to be_valid_distribution + expect(pd.p_eql(3)).to eql 0.0 + expect(pd.p_eql(10)).to be_within(1.0e-9).of 0.1 / 0.7 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr10.given_ge([]) }).to raise_error TypeError + end + end + + describe '#given_le' do + it 'should return a new distribution with probabilities calculated assuming value is <= target' do + pd = pr2.given_le(2) + expect(pd.to_h).to eql({ 1 => 0.5, 2 => 0.5 }) + pd = pr10.given_le(4) + expect(pd.to_h).to be_valid_distribution + expect(pd.p_eql(3)).to be_within(1.0e-9).of 0.1 / 0.4 + expect(pd.p_eql(10)).to eql 0.0 + end + + it 'should raise a TypeError if asked for probability of non-Integer' do + expect(-> { pr10.given_le({}) }).to raise_error TypeError + end + end + + describe '#repeat_sum' do + it 'should output a valid distribution if params are valid' do + d4a = GamesDice::Probabilities.new([1.0 / 4, 1.0 / 4, 1.0 / 4, 1.0 / 4], 1) + d4b = GamesDice::Probabilities.new([1.0 / 10, 2.0 / 10, 3.0 / 10, 4.0 / 10], 1) + pr = d4a.repeat_sum(7) + expect(pr.to_h).to be_valid_distribution + pr = d4b.repeat_sum(12) + expect(pr.to_h).to be_valid_distribution + end + + it 'should raise an error if any param is unexpected type' do + d6 = GamesDice::Probabilities.for_fair_die(6) + expect(-> { d6.repeat_sum({}) }).to raise_error TypeError + end + + it 'should raise an error if distribution would have more than a million results' do + d1000 = GamesDice::Probabilities.for_fair_die(1000) + expect(-> { d1000.repeat_sum(11_000) }).to raise_error(RuntimeError, /Too many probability slots/) + end + + it "should calculate a '3d6' distribution accurately" do + d6 = GamesDice::Probabilities.for_fair_die(6) + pr = d6.repeat_sum(3) + h = pr.to_h + expect(h).to be_valid_distribution + expect(h[3]).to be_within(1e-9).of 1.0 / 216 + expect(h[4]).to be_within(1e-9).of 3.0 / 216 + expect(h[5]).to be_within(1e-9).of 6.0 / 216 + expect(h[6]).to be_within(1e-9).of 10.0 / 216 + expect(h[7]).to be_within(1e-9).of 15.0 / 216 + expect(h[8]).to be_within(1e-9).of 21.0 / 216 + expect(h[9]).to be_within(1e-9).of 25.0 / 216 + expect(h[10]).to be_within(1e-9).of 27.0 / 216 + expect(h[11]).to be_within(1e-9).of 27.0 / 216 + expect(h[12]).to be_within(1e-9).of 25.0 / 216 + expect(h[13]).to be_within(1e-9).of 21.0 / 216 + expect(h[14]).to be_within(1e-9).of 15.0 / 216 + expect(h[15]).to be_within(1e-9).of 10.0 / 216 + expect(h[16]).to be_within(1e-9).of 6.0 / 216 + expect(h[17]).to be_within(1e-9).of 3.0 / 216 + expect(h[18]).to be_within(1e-9).of 1.0 / 216 + end + end + + describe '#repeat_n_sum_k' do + it 'should output a valid distribution if params are valid' do + d4a = GamesDice::Probabilities.new([1.0 / 4, 1.0 / 4, 1.0 / 4, 1.0 / 4], 1) + d4b = GamesDice::Probabilities.new([1.0 / 10, 2.0 / 10, 3.0 / 10, 4.0 / 10], 1) + pr = d4a.repeat_n_sum_k(3, 2) + expect(pr.to_h).to be_valid_distribution + pr = d4b.repeat_n_sum_k(12, 4) + expect(pr.to_h).to be_valid_distribution + end + + it 'should raise an error if any param is unexpected type' do + d6 = GamesDice::Probabilities.for_fair_die(6) + expect(-> { d6.repeat_n_sum_k({}, 10) }).to raise_error TypeError + expect(-> { d6.repeat_n_sum_k(10, {}) }).to raise_error TypeError + end + + it 'should raise an error if n is greater than 170' do + d6 = GamesDice::Probabilities.for_fair_die(6) + expect(-> { d6.repeat_n_sum_k(171, 10) }).to raise_error(RuntimeError, /Too many dice/) + end + + it "should calculate a '4d6 keep best 3' distribution accurately" do + d6 = GamesDice::Probabilities.for_fair_die(6) + pr = d6.repeat_n_sum_k(4, 3) + h = pr.to_h + expect(h).to be_valid_distribution + expect(h[3]).to be_within(1e-10).of 1 / 1296.0 + expect(h[4]).to be_within(1e-10).of 4 / 1296.0 + expect(h[5]).to be_within(1e-10).of 10 / 1296.0 + expect(h[6]).to be_within(1e-10).of 21 / 1296.0 + expect(h[7]).to be_within(1e-10).of 38 / 1296.0 + expect(h[8]).to be_within(1e-10).of 62 / 1296.0 + expect(h[9]).to be_within(1e-10).of 91 / 1296.0 + expect(h[10]).to be_within(1e-10).of 122 / 1296.0 + expect(h[11]).to be_within(1e-10).of 148 / 1296.0 + expect(h[12]).to be_within(1e-10).of 167 / 1296.0 + expect(h[13]).to be_within(1e-10).of 172 / 1296.0 + expect(h[14]).to be_within(1e-10).of 160 / 1296.0 + expect(h[15]).to be_within(1e-10).of 131 / 1296.0 + expect(h[16]).to be_within(1e-10).of 94 / 1296.0 + expect(h[17]).to be_within(1e-10).of 54 / 1296.0 + expect(h[18]).to be_within(1e-10).of 21 / 1296.0 + end + + it "should calculate a '2d20 keep worst result' distribution accurately" do + d20 = GamesDice::Probabilities.for_fair_die(20) + pr = d20.repeat_n_sum_k(2, 1, :keep_worst) + h = pr.to_h + expect(h).to be_valid_distribution + expect(h[1]).to be_within(1e-10).of 39 / 400.0 + expect(h[2]).to be_within(1e-10).of 37 / 400.0 + expect(h[3]).to be_within(1e-10).of 35 / 400.0 + expect(h[4]).to be_within(1e-10).of 33 / 400.0 + expect(h[5]).to be_within(1e-10).of 31 / 400.0 + expect(h[6]).to be_within(1e-10).of 29 / 400.0 + expect(h[7]).to be_within(1e-10).of 27 / 400.0 + expect(h[8]).to be_within(1e-10).of 25 / 400.0 + expect(h[9]).to be_within(1e-10).of 23 / 400.0 + expect(h[10]).to be_within(1e-10).of 21 / 400.0 + expect(h[11]).to be_within(1e-10).of 19 / 400.0 + expect(h[12]).to be_within(1e-10).of 17 / 400.0 + expect(h[13]).to be_within(1e-10).of 15 / 400.0 + expect(h[14]).to be_within(1e-10).of 13 / 400.0 + expect(h[15]).to be_within(1e-10).of 11 / 400.0 + expect(h[16]).to be_within(1e-10).of 9 / 400.0 + expect(h[17]).to be_within(1e-10).of 7 / 400.0 + expect(h[18]).to be_within(1e-10).of 5 / 400.0 + expect(h[19]).to be_within(1e-10).of 3 / 400.0 + expect(h[20]).to be_within(1e-10).of 1 / 400.0 + end + end + end + + describe 'serialisation via Marshall' do + it 'can load a saved GamesDice::Probabilities' do + # rubocop:disable Security/MarshalLoad + # This is a test of using Marshal on a fixed test file + pd6 = File.open(fixture('probs_fair_die_6.dat')) { |file| Marshal.load(file) } + # rubocop:enable Security/MarshalLoad + expect(pd6.to_h).to be_valid_distribution + expect(pd6.p_gt(4)).to be_within(1e-10).of 1.0 / 3 + end + end +end