fibonacci_rng 0.0.4 → 0.0.5

data/lib/fibonacci_rng/version.rb

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

data/lib/fibonacci_rng.rb

@@ -9,10 +9,26 @@ class FibonacciRng
   @tickle = '0'
 
   #Create the default seed string.
-  def self.seed
+  def self.new_seed
     Time.now.to_s + @tickle.succ!
   end
 
+  #Get a random number from the class based generator. This exists only
+  #for compatibility purposes. It is far better to create instances of
+  #generators than to use a shared, global one.
+  def self.rand(max=0)
+    (@hidden ||= FibonacciRng.new).rand(max)
+  end
+
+  #Initialize the class based generator. This exists only
+  #for compatibility purposes. It is far better to create instances of
+  #generators than to use a shared, global one.
+  def self.srand(seed=FibonacciRng.new_seed, depth=8)
+    old = (@hidden && @hidden.seed)
+    @hidden = FibonacciRng.new(seed, depth)
+    old
+  end
+
   CHOP = 0x1FFFFFFF
   BYTE = 0xFF
   WORD = 0xFFFF
@@ -21,30 +37,48 @@ class FibonacciRng
   #An accessor for the depth!
   attr_reader :depth
 
+  #An accessor for the seed value!
+  attr_reader :seed
+
   #Initialize the PRN generator
-  def initialize(depth=8, seed=FibonacciRng.seed)
+  def initialize(seed=FibonacciRng.new_seed, depth=8)
     fail "Invalid depth value (3..30)." unless (3..30) === depth
     @depth = depth
-    reseed(seed)
+    srand(seed)
   end
 
   #Set up a new seed value
-  def reseed(seed=FibonacciRng.seed)
+  def srand(seed=FibonacciRng.new_seed)
+    @seed = seed
     @buffer = Array.new(@depth+2, 0)
     seedsrc = (seed.to_s + seed.class.to_s + 'Leonardo Pisano').each_byte.cycle
     indxsrc = (0...depth).cycle
     do_reseed(indxsrc, seedsrc)
   end
 
+  #A (mostly) compatible access point for random numbers.
+  def rand(max=0)
+    @hidden ||= FibonacciRng.new
+
+    if max.is_a?(Range)
+      min = max.min
+      @hidden.dice(1 + max.max - min) + min
+    elsif max == 0
+      @hidden.float
+    else
+      @hidden.dice(max.to_i)
+    end
+  end
+
   #Roll a dice.
   def dice(sides)
     limit = ((CHOP+1) / sides) * sides
 
     begin
       do_spin
-    end until @buffer[0] < limit
+    end until (value = @buffer[0]) < limit
 
-    @buffer[0] % sides
+    value % sides
   end
 
   #Get a pseudo random byte
@@ -53,6 +87,13 @@ class FibonacciRng
     @buffer[0] & BYTE
   end
 
+  #Get a string of random bytes
+  def bytes(length)
+    result = ""
+    length.times {result << byte.chr}
+    result
+  end
+
   #Get a pseudo random word
   def word
     do_spin

data/prng.rb

@@ -21,7 +21,7 @@ module PrngTestSuite
     puts "Where:"
     puts "  <locn>  fib code location, either 'gem' or 'local'"
     puts "  <gen>   select a generator, either 'fib' or 'int'"
-    puts "  <test>  select a test, either 'chisq' or 'auto'"
+    puts "  <test>  select a test, either 'chisq', 'auto', or 'scatter'"
     puts "  <max>   the number of bins to test    (2..65535)"
     puts "  <count> the number of samples to test (1..1000000)"
     puts
@@ -44,6 +44,7 @@ end
 require_relative 'tools/internal_rng'
 require_relative 'tools/chi_squared'
 require_relative 'tools/auto_corr'
+require_relative 'tools/scatter_plot'
 
 module PrngTestSuite
 
@@ -60,11 +61,13 @@ module PrngTestSuite
       tester = ChiSquaredTest.new
     elsif ARGV[2] == 'auto'
       tester = AutoCorrelator.new
+    elsif ARGV[2] == 'scatter'
+      tester = ScatterPlot.new
     else
       PrngTestSuite.usage "Error: missing or invalid test parameter."
     end
 
-    unless (2..65535) === (max = ARGV[3].to_i)
+    unless (2..65536) === (max = ARGV[3].to_i)
       PrngTestSuite.usage "Error: missing or invalid max parameter."
     end
 

data/tests/fibinacci_rng_tests.rb

@@ -41,7 +41,6 @@ class CoreTester < MiniTest::Unit::TestCase
     100.times do
       assert((0...65536) === prng.word)
     end
-
   end
 
   def test_that_it_creates_floats
@@ -51,7 +50,34 @@ class CoreTester < MiniTest::Unit::TestCase
       value = prng.float
       assert((value >= 0.0) && (value < 1.0))
     end
+  end
+
+  def test_compatible_global_dice_rolls
+    100.times do
+      assert((0...6) === FibonacciRng.rand(6))
+    end
+  end
 
+  def test_compatible_global_dice_rolls_range
+    100.times do
+      assert((0...6) === FibonacciRng.rand(0...6))
+    end
+  end
+
+  def test_compatible_global_floats
+    100.times do
+      value = FibonacciRng.rand(0)
+      assert((value >= 0.0) && (value < 1.0))
+    end
+  end
+
+  def test_random_string
+    prng = FibonacciRng.new
+
+    rs = prng.bytes(10)
+
+    assert(rs.is_a?(String))
+    assert_equal(10, rs.length)
   end
 
   def test_that_it_makes_unique_sequnces
@@ -70,8 +96,8 @@ class CoreTester < MiniTest::Unit::TestCase
   end
 
   def test_that_it_makes_repeatable_sequnces
-    prnga = FibonacciRng.new(8, 0)
-    prngb = FibonacciRng.new(8, 0)
+    prnga = FibonacciRng.new(0)
+    prngb = FibonacciRng.new(0)
 
     buffa = []
     buffb = []
@@ -83,5 +109,4 @@ class CoreTester < MiniTest::Unit::TestCase
 
     assert(buffa == buffb)
   end
-
 end

data/tools/scatter_plot.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+#A Chi Squared tester
+class ScatterPlot
+
+  #Run a chi squared test on the random number generator.
+  def run(gen, max, count)
+    puts "Starting test"
+    bins = Array.new(max * 2, 0)
+
+
+    count.times do |i|
+      bins[i] = [gen.dice(max)]
+    end
+
+    count.times do |i|
+      bins[i] << gen.dice(max)
+    end
+
+    count.times do |i|
+      puts "#{bins[i][0]}, #{bins[i][1]}"
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fibonacci_rng
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2014-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/Chi Squared.ods
+- docs/Fib_Scatter.png
+- docs/fib corr.png
+- docs/int corr.png
+- docs/scatter.ods
+- docs/scatter_fib.txt
+- docs/scatter_int.txt
 - fibonacci_rng.gemspec
 - lib/fibonacci_rng.rb
 - lib/fibonacci_rng/version.rb
@@ -88,6 +95,7 @@ files:
 - tools/auto_corr.rb
 - tools/chi_squared.rb
 - tools/internal_rng.rb
+- tools/scatter_plot.rb
 homepage: ''
 licenses:
 - MIT