composite_rng 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c30e36b6d59c807536035ad3fdbaefa8dccb420
-  data.tar.gz: 3ff2d418c856aa7af2b76af17e5f9d3950caa6d8
+  metadata.gz: 1f340e108ce670dca8fd91ec9089ae5753eae06e
+  data.tar.gz: b992ad5f3defe4e2578090833730107b256bfc89
 SHA512:
-  metadata.gz: 8282ef4f619b086e53fc1663cc843008b194f533baa72d0806d499d4ef4e3c5bdad1c50e9a49de39d1825d379c5275d697edc0c00dbe0275214ddfa2c185e7c4
-  data.tar.gz: 495bef03e18c3860c9e50cb023fe50e70b792d66f9d066ee830697e2c290d9668a0a273b4b7ba8b82d609862f1ca98d66bfddaa4c9ad355670b1777dd2120652
+  metadata.gz: 1731dee7aeb11ec2f9006853c038211c89afcaa4a5e4e9f4e6b3f74e24339218d39c2108e270feea0b05aa01a9f6277d365fb27b59e1397d2799f06d314f828d
+  data.tar.gz: cf12a60cc2dba80842ef8f2e73dede341cb0a7e6766f1800a6bec6f16b00fbf3a2dd030f7e380818288f3670120f1d12a18d824985ea45dce084da9176f947a4

data/README.md

@@ -2,30 +2,36 @@
 
 The composite (psuedo) random number generator is a container for two other
 (psuedo) random number generators. By working together, these create higher
-quality random number streams than either could by itself.
+quality pseudo-random number streams than either could by itself.
 
-The two generators do NOT need to be the same type. While not a good idea,
-they may even be the same instance, or the same type with the same seed, but
-this negates the advantage of compositing them.
+The two generators do not need to be the same type. In fact it helps to reduce
+any possible correlation between the parent and the child if they are
+completely different sorts of generators. It is really not a good idea for them
+to be either the same instance, or the same type with the same seed, because
+this negates the advantage of compositing generators.
 
 The generators used must comply to the following duck characteristics:
 
     rand(max) - This method must compute a random integer from 0...max
 
-That's all! The following shows how this could work:
+The constructor takes four arguments:
+* The parent PRNG that is used to "educate" the child.
+* The child PRNG that is the actual generator of data.
+* The optional churn_limit factor that controls how much tutoring the child
+can receive. This optional parameter defaults to 16. This value may be read
+back with the churn_limit property. Valid values are 2..256
+* The optional init factor that controls the amount of initial tutoring the
+child receives initially. This defaults to 0 for none. Valid values are 0..256
+
+The following shows how this could work:
 ```ruby
 parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
 child  = Random.new
-composite = CompositeRng.new(parent, child, 42)
+composite = CompositeRng.new(parent, child, 42, 11)
 # ...
 dice_roll = 1 + composite.rand(6)
 # ...
 ```
-The constructor takes three arguements:
-* The parent PRNG that is used to "educate" the child.
-* The child PRNG that is the actual generator of data.
-* The churn factor that controls how much tutoring the child is to receive.
-This optional parameter defaults to 16.
 
 It is also possible to use the default PRNG as follows:
 ```ruby
@@ -87,6 +93,8 @@ Or install it yourself as:
 
 The composite_rng gem itself is found at: ( https://rubygems.org/gems/composite_rng )
 
+The fibonacci_rng code lives at: ( https://github.com/PeterCamilleri/fibonacci_rng )
+
 ## Contributing
 
 #### Plan A

data/lib/composite_rng.rb

@@ -3,13 +3,35 @@ require_relative "composite_rng/version"
 #A class of random number generators that work by nesting other PRNGs.
 class CompositeRng
 
+  #The limits on the churn limit.
+  CHURNS = 2..256
+
+  #The limits on the init.
+  INITS = 0..256
+
+  #The current upper limit on churn
+  attr_reader :churn_limit
+
   #Create a composite PRNG
   #<br>Parameters
   #* parent - the starting PRNG
   #* child - the progeny PRNG
-  #* churn - the amount of churning done.
-  def initialize(parent, child, churn=16)
-    @parent, @child, @churn = parent, child, churn
+  #* churn_limit - the max amount of churning done.
+  #* init = the number of initial churn steps.
+  def initialize(parent, child, churn_limit=16, init=0)
+    @parent, @child, @churn_limit = parent, child, churn_limit
+
+    #Validate the churn_limit
+    unless CHURNS === @churn_limit
+      fail "Invalid churn limit #{@churn_limit}. Allowed values are #{CHURNS}"
+    end
+
+    #Validate the init
+    unless INITS === init
+      fail "Invalid init value #{init}. Allowed values are #{INITS}"
+    end
+
+    init.times { churn }
   end
 
   #An access point for random numbers.
@@ -25,7 +47,7 @@ class CompositeRng
   #<br>Returns
   #* a churned random number generator.
   def churn
-    (1 + @parent.rand(@churn)).times {@child.rand(256)}
+    (1 + @parent.rand(@churn_limit)).times {@child.rand(256)}
     @child
   end
 

data/lib/composite_rng/version.rb

@@ -1,4 +1,4 @@
 class CompositeRng
   #The CompositeRng version.
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/tests/composite_rng_tests.rb

@@ -11,6 +11,14 @@ class CompositeRngTester < Minitest::Test
   #Track mini-test progress.
   include MinitestVisible
 
+  def test_that_it_checks_parms
+    assert_raises { CompositeRng.new(Random.new, Random.new,  -1, 0) }
+    assert_raises { CompositeRng.new(Random.new, Random.new, 300, 0) }
+
+    assert_raises { CompositeRng.new(Random.new, Random.new, 2,  -1) }
+    assert_raises { CompositeRng.new(Random.new, Random.new, 2, 300) }
+  end
+
   def test_that_it_creates_dice_rolls
     prng = CompositeRng.new(Random.new, Random.new)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_rng
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler