fibonacci_rng 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fdabb723bc231c0172f6fa824c8fa6cd6948a78
-  data.tar.gz: 2de8db50e6075474582a78e6475e01b5b591ef14
+  metadata.gz: aeaeffd9970516773ff376f31c7e9b937b40ad1e
+  data.tar.gz: f81169d59987565caf00d8f0f58f5c055193c2ce
 SHA512:
-  metadata.gz: 89eecfb7a41a6e24ce0b1cd9d583f720ff4ff74a12438fa5b4b557bf23de911fe96cf054e63435a72328a57342122b7751afe4bb97181117f258bc0a9ded250f
-  data.tar.gz: 3c2164cb23b043b1be8ed21dbdcc4c129bd3f5da818564c3d658c9944bf9a7dfd4a51918427fc6df8a7f592c2384aa5ee68b81b62d08d4d64aa45554a27a6eb7
+  metadata.gz: 539bd740b23b2466e8832f75138842c4b060154a3a1170686e0a6ee1aac9c6dc3690e3f2bf0f57e48ab976c6424f8eb6b16dd435a8f078fe5627f9109f586c20
+  data.tar.gz: 14948121de4868db91145c8ff37fb45ff91c05fc7ccf08d8085c26de49a67391a507ba686585b2c5c0b67140b19a399d644fe576009704efdeeb43d2a4e6c0ba

data/README.md

@@ -44,7 +44,7 @@ require 'fibonacci_rng'
 Then in an appropriate place in the code:
 
 ```ruby
-@my_rng = FibonacciRng.new(depth, seed)
+@my_rng = FibonacciRng.new(seed, depth, init)
 ```
 
 Where:
@@ -52,6 +52,8 @@ Where:
 * seed is an optional number or string or other object that has a repeatable
 value and responds to the to_s method. Defaults to a value derived from system
 entropy.
+* init is the number of initial training cycles used to seed the generator. The
+allowed range is 1 to 1,000,000. By default the init value is 32*depth+768.
 
 Here is an overview of the available options.
 
@@ -68,6 +70,8 @@ Here is an overview of the available options.
 #Method #4
 @my_rng = FibonacciRng.new(FibonacciRng.new_seed, 12) # Random seed, depth = 12
 
+#Method #5
+@my_rng = FibonacciRng.new(FibonacciRng.new_seed, 12, 100) # Random seed, depth = 12 with 100 passes.
 ```
 In addition, keyword arguments are emulated (as of Version 0.4.0) so these
 additional options also are available:
@@ -77,21 +81,21 @@ additional options also are available:
 responds to the to_s method. Defaults to a value derived from system entropy.
 * init: value -- the number of initial training cycles used to seed the
 generator. The allowed range is 1 to 1,000,000. By default the init value is
-32*depth+768. This setting is only available with keyword arguments.
+32*depth+768.
 
 The following are examples of constructors with keyword arguments.
 
 ```ruby
-#Method #5
+#Method #6
 @my_rng = FibonacciRng.new(seed: 'seed')              # Specified seed = 'seed', depth = 8
 
-#Method #6
+#Method #7
 @my_rng = FibonacciRng.new(seed: 'seed', depth: 12)   # Specified seed = 'seed', depth = 12
 
-#Method #7
+#Method #8
 @my_rng = FibonacciRng.new(depth: 12)                 # Random seed, depth = 12
 
-#Method #8
+#Method #9
 @my_rng = FibonacciRng.new(seed: 'seed', init: 2048)  # Specified seed = 'seed' with 2048 passes.
 
 ```

data/lib/fibonacci_rng/version.rb

@@ -2,5 +2,5 @@
 
 #The class of Fibonacci inspired random number generators.
 class FibonacciRng
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/lib/fibonacci_rng.rb

@@ -27,15 +27,16 @@ class FibonacciRng
   attr_reader :init
 
   #Initialize the PRN generator
-  def initialize(arg_a=nil, arg_b=nil)
+  def initialize(arg_a=nil, arg_b=nil, arg_c=nil)
     #Extract the parameters.
     if arg_a.is_a?(Hash)
-      seed = arg_a[:seed]
+      seed   = arg_a[:seed]
       @depth = arg_a[:depth]
       @init  = arg_a[:init]
     else
-      seed = arg_a
+      seed   = arg_a
       @depth = arg_b
+      @init  = arg_c
     end
 
     #Set up the default parameters if needed.

data/tests/fibinacci_rng_tests.rb

@@ -15,32 +15,44 @@ class FibonacciRngTester < Minitest::Test
     gen = FibonacciRng.new
     assert_equal(8, gen.depth)
     assert_equal(String, gen.seed.class)
+    assert_equal(1024, gen.init)
 
     gen = FibonacciRng.new('seed')
     assert_equal(8, gen.depth)
     assert_equal('seed', gen.seed)
+    assert_equal(1024, gen.init)
 
     gen = FibonacciRng.new('seed', 12)
     assert_equal(12, gen.depth)
     assert_equal('seed', gen.seed)
+    assert_equal(1152, gen.init)
+
+    gen = FibonacciRng.new('seed', 12, 2048)
+    assert_equal(12, gen.depth)
+    assert_equal('seed', gen.seed)
+    assert_equal(2048, gen.init)
   end
 
   def test_building_with_keywords
     gen = FibonacciRng.new(seed: 'seed')
     assert_equal(8, gen.depth)
     assert_equal('seed', gen.seed)
+    assert_equal(1024, gen.init)
 
     gen = FibonacciRng.new(depth: 12)
     assert_equal(12, gen.depth)
     assert_equal(String, gen.seed.class)
+    assert_equal(1152, gen.init)
 
     gen = FibonacciRng.new(seed: 'seed', depth: 12)
     assert_equal(12, gen.depth)
     assert_equal('seed', gen.seed)
+    assert_equal(1152, gen.init)
 
     gen = FibonacciRng.new(depth: 12, seed: 'seed')
     assert_equal(12, gen.depth)
     assert_equal('seed', gen.seed)
+    assert_equal(1152, gen.init)
 
     gen = FibonacciRng.new(seed: 'seed', init: 2048)
     assert_equal('seed', gen.seed)
@@ -113,7 +125,7 @@ class FibonacciRngTester < Minitest::Test
     assert_equal(10, rs.length)
   end
 
-  def test_that_it_makes_unique_sequnces
+  def test_that_it_makes_unique_sequences
     prnga = FibonacciRng.new
     prngb = FibonacciRng.new
 
@@ -128,7 +140,7 @@ class FibonacciRngTester < Minitest::Test
     assert(buffa != buffb)
   end
 
-  def test_that_it_makes_repeatable_sequnces
+  def test_that_it_makes_repeatable_sequences
     prnga = FibonacciRng.new(0)
     prngb = FibonacciRng.new(0)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fibonacci_rng
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest_visible