rational_choice 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c062495abe33854b1fdda0b37fe663d2f53f1036b2d79c6491577fe06b645b90
-  data.tar.gz: 5155200d59d02441f02c2500adab6676cfe45a294c1319adea2670eedf7cb8cc
+  metadata.gz: 7ae25e7a180ad02a6837d0e085639330ad54577f880211ea5ed9b8bdcbfd24ad
+  data.tar.gz: 9415891d43f63156400471ab1ff71dc388cc76fa30943e5c2dfaf4337cb07d81
 SHA512:
-  metadata.gz: 3de02bef19b681e9467383fd86e9653813201c4a0af91bc9f9efabb60b1c5fd4265ddc93d004aa9bf90cfe66fdae356a02481d084ce014182ce53e3baf2381ea
-  data.tar.gz: b76b864d7bda067426bcd555def66fecd57a5652dfd12426fb544e6d6ae955e24899def8cb74710e596797f0de25043eb56887336f19d44037f53e9b2053a3cf
+  metadata.gz: 598b15197987bf19787f9affafde489cf2fbb8b8b0260b36b16f93d9d23eee53d10548170dc719c4ef49e37d12568a151e2854c187708013bb99a77678b7f0a1
+  data.tar.gz: d6ffe67d2879780a6418fc722bc19a9bfd70b9def2fbd83826dccc077b4ebef54f47531400a6c93e35a9ea8565e2bd03edb24e8f4175d413d5568189f6ac9a1d

data/lib/rational_choice.rb

@@ -1,7 +1,7 @@
 # Tiny fuzzy-logic gate for making choices based on a continuum of permitted values
 # as opposed to a hard condition.
 module RationalChoice
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 
   # Gets raised when a multidimensional choice has to be made with a wrong number
   # of values versus the number of dimensions
@@ -16,9 +16,11 @@ module RationalChoice
     #
     # @param false_at_or_below[#to_f, #<=>] the lower bound, at or below which the value will be considered false
     # @param true_at_or_above[#to_f, #<=>] the upper bound, at or above which the value will be considered true
-    def initialize(false_at_or_below:, true_at_or_above:)
+    # @param random[Random] the RNG, defaults to a new Random
+    def initialize(false_at_or_below:, true_at_or_above:, random: Random.new)
       raise DomainError, "Bounds were the same at #{false_at_or_below}" if false_at_or_below == true_at_or_above
 
+      @random = random
       @lower, @upper = [false_at_or_below, true_at_or_above].sort
       @flip_sign = [@lower, @upper].sort != [false_at_or_below, true_at_or_above]
     end
@@ -55,9 +57,7 @@ module RationalChoice
         delta = @upper.to_f - @lower.to_f
         v = (value - @lower).to_f
         t = (v / delta)
-
-        r = Random.new # To override in tests if needed
-        r.rand < t
+        @random.rand < t
       else
         # just seen where it is (below or above)
         value >= @upper
@@ -79,8 +79,13 @@ module RationalChoice
   # will be first coerced into one (number of truthy evaluations vs. number of falsey evaluations)
   # and then a true/false value will be deduced from that.
   class ManyDimensions
-    def initialize(*dimensions)
+    # Initializes a new Dimension to evaluate values
+    #
+    # @param dimensions[Array<Dimension>] the dimensions to make a choice over
+    # @param random[Random] the RNG, defaults to a new Random
+    def initialize(*dimensions, random: Random.new)
       @dimensions = dimensions
+      @random = random
       raise CardinalityError, '%s has no dimensions to evaluate' % inspect if @dimensions.empty?
     end
 
@@ -106,7 +111,7 @@ module RationalChoice
       evaluations = values.zip(@dimensions).map { |(v, d)| d.choose(v) }
       num_truthy_choices = evaluations.select { |e| e }.length
 
-      Dimension.new(false_at_or_below: 0, true_at_or_above: evaluations.length).choose(num_truthy_choices)
+      Dimension.new(false_at_or_below: 0, true_at_or_above: evaluations.length, random: @random).choose(num_truthy_choices)
     end
   end
 end

data/spec/rational_choice/dimension_spec.rb

@@ -39,6 +39,14 @@ describe 'RationalChoice::Dimension' do
     end
   end
 
+  describe 'with a given Random' do
+    it 'creates a predictable sequence of choices' do
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1, random: Random.new(42))
+      choices = (1..10).map { d.choose(0.5) }
+      expect(choices).to eq([true, false, false, false, true, true, true, false, false, false])
+    end
+  end
+
   describe 'with values between thresholds creates a sensible choice distribution' do
     it 'for 0.5 on a continuum from 0 to 1' do
       d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)

data/spec/rational_choice/many_dimensions_spec.rb

@@ -22,6 +22,16 @@ describe 'RationalChoice::ManyDimensions' do
       RationalChoice::ManyDimensions.new(one_to_zero, one_to_zero, one_to_zero)
     }
 
+    it 'accepts a custom seed and uses it to generate predictable choices' do
+      r = Random.new(42)
+      d1 = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1, random: r)
+      d2 = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1, random: r)
+      d3 = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1, random: r)
+      multi_d = RationalChoice::ManyDimensions.new(d1, d2, d3, random: r)
+      choices = (1..10).map { multi_d.choose(0.5, 0.2, 0.6) }
+      expect(choices).to eq([false, true, false, true, true, false, true, true, true, false])
+    end
+
     it 'returns "true" when all dimensions are at or above upper bound' do
       10_000.times { expect(md.choose(1, 1, 1)).to eq(true) }
       10_000.times { expect(md.choose(2, 2, 2)).to eq(true) }
@@ -35,7 +45,7 @@ describe 'RationalChoice::ManyDimensions' do
     it 'returns "true" in approximately 50% of the cases when all the values are at 0.5' do
       truthy = 0
       10_000.times { truthy += 1 if md.choose(0.5, 0.5, 0.5) }
-      expect(truthy).to be_within(100).of(10_000 / 2)
+      expect(truthy).to be_within(200).of(10_000 / 2)
     end
 
     it 'returns "true" in approximately 10% of the cases when all the values are at 0.1' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rational_choice
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Julik Tarkhanov