fibonacci_rng 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21f5b3081ee28c32daf5ae90cba9e99cb2d7343b
-  data.tar.gz: bfa73f2a5979e51fb5d05ad7df4d801d1d1e62b3
+  metadata.gz: 5fdabb723bc231c0172f6fa824c8fa6cd6948a78
+  data.tar.gz: 2de8db50e6075474582a78e6475e01b5b591ef14
 SHA512:
-  metadata.gz: d5b763aa1e08b9d14677f1b6bf6e8dee8bac807348f368f27dcd2f8025ac1d8e692c71f66859dfb412269fec312b7ea8b978f9ebbc46a4691833ecd69377d562
-  data.tar.gz: 38b70bbf54128e8af1290ca7b98e43b984e04dba4c2d57e0e8f076511aca1acbd8a27a5ef3452793f81d57f5852cf1c831d7b292f66dc049a0e4b034faef0086
+  metadata.gz: 89eecfb7a41a6e24ce0b1cd9d583f720ff4ff74a12438fa5b4b557bf23de911fe96cf054e63435a72328a57342122b7751afe4bb97181117f258bc0a9ded250f
+  data.tar.gz: 3c2164cb23b043b1be8ed21dbdcc4c129bd3f5da818564c3d658c9944bf9a7dfd4a51918427fc6df8a7f592c2384aa5ee68b81b62d08d4d64aa45554a27a6eb7

data/README.md

@@ -29,6 +29,12 @@ Or install it yourself as:
 
     $ gem install fibonacci_rng
 
+The fibonacci_rng gem itself is found at: ( https://rubygems.org/gems/fibonacci_rng )
+
+A C++ version of this generator also exists and may be found at
+( https://github.com/PeterCamilleri/Fibonacci_CPP )
+
+
 ## Usage
 
 ```ruby
@@ -38,23 +44,26 @@ require 'fibonacci_rng'
 Then in an appropriate place in the code:
 
 ```ruby
-@my_rng = FibonacciRng.new(depth, seed_value)
+@my_rng = FibonacciRng.new(depth, seed)
 ```
 
-Where depth is an optional integer value between 2 and 99 and the seed value
-is a number or string or other object that has a repeatable value. You can
-also get a "random" generator of the default depth (8) and a randomized
-seed. Here is an overview of the available options.
+Where:
+* depth is an optional integer value between 2 and 256. Defaults to 8.
+* 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.
+
+Here is an overview of the available options.
 
 ```ruby
 #Method #1
 @my_rng = FibonacciRng.new                            # Random seed, depth = 8
 
 #Method #2
-@my_rng = FibonacciRng.new(seed)                      # Specified seed, depth = 8
+@my_rng = FibonacciRng.new('seed')                    # Specified seed = 'seed', depth = 8
 
 #Method #3
-@my_rng = FibonacciRng.new(seed, 12)                  # Specified seed, depth = 12
+@my_rng = FibonacciRng.new('seed', 12)                # Specified seed = 'seed', depth = 12
 
 #Method #4
 @my_rng = FibonacciRng.new(FibonacciRng.new_seed, 12) # Random seed, depth = 12
@@ -63,17 +72,31 @@ seed. Here is an overview of the available options.
 In addition, keyword arguments are emulated (as of Version 0.4.0) so these
 additional options also are available:
 
+* depth: value -- an integer value between 2 and 256. Defaults to 8.
+* seed: value -- a 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: 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.
+
+The following are examples of constructors with keyword arguments.
+
 ```ruby
 #Method #5
-@my_rng = FibonacciRng.new(seed: seed)                # Specified seed, depth = 8
+@my_rng = FibonacciRng.new(seed: 'seed')              # Specified seed = 'seed', depth = 8
 
 #Method #6
-@my_rng = FibonacciRng.new(seed: seed, depth: 12)     # Specified seed, depth = 12
+@my_rng = FibonacciRng.new(seed: 'seed', depth: 12)   # Specified seed = 'seed', depth = 12
 
 #Method #7
 @my_rng = FibonacciRng.new(depth: 12)                 # Random seed, depth = 12
+
+#Method #8
+@my_rng = FibonacciRng.new(seed: 'seed', init: 2048)  # Specified seed = 'seed' with 2048 passes.
+
 ```
-Note: Mixing positional and keyword arguments will not, in general, work.
+Note: Mixing positional and keyword arguments will not, in general, work. So
+don't do it!
 
 #### Generating Pseudo Random Data
 

data/irbt.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+# An IRB + fibonacci_rng Test bed
+
+require 'irb'
+$force_alias_read_line_module = true
+require 'mini_readline'
+
+puts "Starting an IRB console with fibonacci_rng loaded."
+
+if ARGV[0] == 'local'
+  require_relative 'lib/fibonacci_rng'
+  puts "fibonacci_rng loaded locally: #{FibonacciRng::VERSION}"
+
+  ARGV.shift
+else
+  require 'fibonacci_rng'
+  puts "fibonacci_rng loaded from gem: #{FibonacciRng::VERSION}"
+end
+
+IRB.start

data/lib/fibonacci_rng.rb

@@ -14,7 +14,8 @@ class FibonacciRng
   BYTE   = 0xFF
   WORD   = 0xFFFF
   BASE   = (CHOP+1).to_f
-  DEPTHS = 2..99
+  DEPTHS = 2..256
+  INITS  = 1..1_000_000
 
   #The depth of the Fibonacci array.
   attr_reader :depth
@@ -22,12 +23,16 @@ class FibonacciRng
   #The seed value used by this generator.
   attr_reader :seed
 
+  #The init value used by this generator.
+  attr_reader :init
+
   #Initialize the PRN generator
   def initialize(arg_a=nil, arg_b=nil)
     #Extract the parameters.
     if arg_a.is_a?(Hash)
       seed = arg_a[:seed]
       @depth = arg_a[:depth]
+      @init  = arg_a[:init]
     else
       seed = arg_a
       @depth = arg_b
@@ -38,8 +43,15 @@ class FibonacciRng
     @depth ||= 8
 
     #Validate the depth.
-    unless DEPTHS === depth
-      fail "Invalid depth value #{depth}. Allowed values are #{DEPTHS}"
+    unless DEPTHS === @depth
+      fail "Invalid depth value #{@depth}. Allowed values are #{DEPTHS}"
+    end
+
+    @init ||= 32 * @depth + 768
+
+    #Validate the depth.
+    unless INITS === @init
+      fail "Invalid init value #{@init}. Allowed values are #{INITS}"
     end
 
     #Build the generator.

data/lib/fibonacci_rng/seeder.rb

@@ -27,7 +27,7 @@ class FibonacciRng
 
   #Do the work of reseeding the PRNG
   def do_reseed(indxsrc, seedsrc)
-    (32*@depth+768).times do
+    @init.times do
       @buffer[indxsrc.next] += seedsrc.next
       do_spin
     end

data/lib/fibonacci_rng/version.rb

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

data/rakefile.rb

@@ -16,6 +16,11 @@ task :reek do |t|
   `reek --no-color lib > reek.txt`
 end
 
+desc "Run an IRB Session with fibonacci_rng loaded."
+task :console do
+  system "ruby irbt.rb local"
+end
+
 desc "What version of the Fibonacci is this?"
 task :vers do |t|
   puts

data/tests/fibinacci_rng_tests.rb

@@ -41,6 +41,10 @@ class FibonacciRngTester < Minitest::Test
     gen = FibonacciRng.new(depth: 12, seed: 'seed')
     assert_equal(12, gen.depth)
     assert_equal('seed', gen.seed)
+
+    gen = FibonacciRng.new(seed: 'seed', init: 2048)
+    assert_equal('seed', gen.seed)
+    assert_equal(2048, gen.init)
   end
 
   def test_that_rejects_bad_parms

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fibonacci_rng
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest_visible
@@ -108,6 +108,7 @@ files:
 - README.md
 - fibonacci.reek
 - fibonacci_rng.gemspec
+- irbt.rb
 - lib/fibonacci_rng.rb
 - lib/fibonacci_rng/generator.rb
 - lib/fibonacci_rng/hasher.rb