fibonacci_rng 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c8a1e946cc05b8a0f7ef15c0f9f332f7170c1a8
-  data.tar.gz: 69703e8ba9a17e3abb5b1cfbd67a91da806e8f7f
+  metadata.gz: a508cef0fdf713686d64af287131073ad0bf5ad9
+  data.tar.gz: 767c9eee52ab193288b848ab9d4ef5090a80ec10
 SHA512:
-  metadata.gz: 9b285d3413bb9e669ca12030af0050672de993c0d65cf188cd25102a02d07b5df08c3091d7bf7d2f216d4d0a2b520243c0172494d62109c6ddeb738d0cda27da
-  data.tar.gz: 07d897637e993f0bb05088f8e336851e9f51177326dac0922de78b1bf63a09cef4e6af9cfe4c612a8dad4367b911e660f97a91340a5bb067f56097471792f9c7
+  metadata.gz: 08463aeda003dc4e564565df6b6d1532a1d5320a21a9c3ede419a1df052a4ad129eb16770ebf955091e3ea9d69fb94af487ac9386c3f2a36f87cdfb2082feb2f
+  data.tar.gz: 9b7b32359d8d61a867f6a2f41ec9c29ef7cf221020393ab0321a38930f4140f3a14eaff947e83ce2b03da7a40c0c639e3aeb5dd0b2bb2d38723f21c61ab30f48

data/README.md

@@ -1,11 +1,18 @@
 # FibonacciRng
 
 This gem implements a random number generator inspired by the famous Fibonacci
-number sequence. This is meant to serve as an example of a lesser or poorly
-implemented random number generator. Until now, the linear congruential and
-middle squares generators have been picked on as poor, so I felt that a new
-contender was required. Proving that this is indeed a poor RNG is left as an
-exercise for the reader!
+number sequence. So far, this generator has performed quite well when compared
+to the built-in Ruby random number generator when tested with:
+
+* A chi-squared test
+* An auto-correlation test
+* An X/Y scatter graph test
+
+At this time I lack the mathematical skill to go beyond these rudimentary
+measures but they are enough to qualify this code for "light" duties.
+
+Proving that this is indeed a good (or poor) RNG is left as an exercise for
+the reader! Hopefully one with greater knowledge of statistics than I.
 
 ## Installation
 
@@ -39,12 +46,35 @@ also get a "random" generator of the default depth (8) and a randomized
 seed. 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
+
+#Method #3
 @my_rng = FibonacciRng.new(seed, 12)                  # Specified seed, depth = 12
+
+#Method #4
 @my_rng = FibonacciRng.new(FibonacciRng.new_seed, 12) # Random seed, depth = 12
 
 ```
+In addition, keyword arguments are emulated (as of Version 0.3.1) so these
+options also are available:
+
+```ruby
+#Method #5
+@my_rng = FibonacciRng.new(seed: seed)                # Specified seed, depth = 8
+
+#Method #6
+@my_rng = FibonacciRng.new(seed: seed, depth: 12)     # Specified seed, depth = 12
+
+#Method #7
+@my_rng = FibonacciRng.new(depth: 12)                 # Random seed, depth = 12
+```
+Note: Mixing positional and keyword arguments will not, in general, work.
+
+#### Generating Pseudo Random Data
 
 To get some data out here are some options:
 
@@ -55,7 +85,7 @@ To get some data out here are some options:
 @my_rng.float         # A "random" float between 0 and less than 1.
 ```
 
-and also available
+and also available are these helpful methods:
 
 ```ruby
 @my_rng.reseed(value) # Reseed the sequence with the new value.
@@ -68,7 +98,7 @@ If more than one stream of numbers is required, it is best to use multiple
 instances of FibonacciRng objects rather than rely on one. This will help avoid
 the two streams of data being correlated.
 
-### Hashing
+#### Hashing
 
 As more as an experiment than anything else, it is also possible to use
 the generator as a primitive hash generator. To do so, create a new
@@ -84,16 +114,34 @@ puts fib.hash_string
 Note that the length of the hash string is a function of the depth of the
 generator used to create it. This is about 5.5 characters per unit of depth.
 
-### Salting
+#### Salting
 
 Another (more practical) use for the Fibonacci generator is the creation of
-salting strings for use in more capable hashing schemes. Here are some possible
+salting strings for use in more capable hashing schemes. Here are four possible
 ways that this can be done:
 
 ```ruby
-salt_string = FibonacciRng.new.hash_string
-salt_string = FibonacciRng.new(FibonacciRng.new_seed, 12).hash_string()
+#Method #1
+salt_string = FibonacciRng.new.hash_string  #Thread safe.
+
+#Method #2
+salt_string = FibonacciRng.new(depth: 12).hash_string  #Thread safe.
+
+#Method #3
+Thread.current[:salter] = FibonacciRng.new   #Need a separate generator for each thread.
+# Much intervening code omitted.
+salter = Thread.current[:salter]
+salter << Time.now.to_s  # Note that unique time values are NOT needed.
+salt_string = salter.hash_string
+
+#Method #4
+Thread.current[:salter] = FibonacciRng.new   #Need a separate generator for each thread.
+# Much intervening code omitted.
+salter = Thread.current[:salter]
+salter.spin
+salt_string = salter.hash_string
 ```
+
 Each time any of these is run, a different salt string will be generated.
 
 ## Contributing
@@ -103,3 +151,11 @@ Each time any of these is run, a different salt string will be generated.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+#### Plan B
+
+Go to the GitHub repository and raise an issue calling attention to some
+aspect that could use some TLC or a suggestion or an idea. Apply labels
+to the issue that match the point you are trying to make. Then follow
+your issue and keep up-to-date as it is worked on. All input are greatly
+appreciated.

data/fibonacci_rng.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Camilleri"]
   spec.email         = ["peter.c.camilleri@gmail.com"]
   spec.homepage      = "http://teuthida-technologies.com/"
-  spec.description   = "A Fibonacci inspired pseudo random number generator. Just try and prove that it sucks! ;-)"
+  spec.description   = "A Fibonacci inspired pseudo random number generator. Suitable for light duties."
   spec.summary       = "A Fibonacci inspired pseudo random number generator."
   spec.license       = "MIT"
 

data/lib/fibonacci_rng/version.rb

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

data/lib/fibonacci_rng.rb

@@ -25,10 +25,11 @@ class FibonacciRng
     old
   end
 
-  CHOP = 0x1FFFFFFF
-  BYTE = 0xFF
-  WORD = 0xFFFF
-  BASE = (CHOP+1).to_f
+  CHOP   = 0x1FFFFFFF
+  BYTE   = 0xFF
+  WORD   = 0xFFFF
+  BASE   = (CHOP+1).to_f
+  DEPTHS = 2..99
 
   #The depth of the Fibonacci array.
   attr_reader :depth
@@ -37,9 +38,26 @@ class FibonacciRng
   attr_reader :seed
 
   #Initialize the PRN generator
-  def initialize(seed=FibonacciRng.new_seed, depth=8)
-    fail "Invalid depth value (2..99)." unless (2..99) === depth
-    @depth = depth
+  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]
+    else
+      seed = arg_a
+      @depth = arg_b
+    end
+
+    #Set up the default parameters if needed.
+    seed   ||= FibonacciRng.new_seed
+    @depth ||= 8
+
+    #Validate the depth.
+    unless DEPTHS === depth
+      fail "Invalid depth value #{depth}. Allowed values are #{DEPTHS}"
+    end
+
+    #Build the generator.
     srand(seed)
   end
 
@@ -144,7 +162,7 @@ class FibonacciRng
 
   #Do the work of reseeding the PRNG
   def do_reseed(indxsrc, seedsrc)
-    (128*@depth).times do
+    (32*@depth+768).times do
       @buffer[indxsrc.next] += seedsrc.next
       do_spin
     end

data/tests/fibinacci_rng_tests.rb

@@ -11,6 +11,37 @@ class FibonacciRngTester < Minitest::Test
   #Track mini-test progress.
   include MinitestVisible
 
+  def test_how_we_build_generators
+    gen = FibonacciRng.new
+    assert_equal(8, gen.depth)
+    assert_equal(String, gen.seed.class)
+
+    gen = FibonacciRng.new('seed')
+    assert_equal(8, gen.depth)
+    assert_equal('seed', gen.seed)
+
+    gen = FibonacciRng.new('seed', 12)
+    assert_equal(12, gen.depth)
+    assert_equal('seed', gen.seed)
+  end
+
+  def test_building_with_keywords
+    gen = FibonacciRng.new(seed: 'seed')
+    assert_equal(8, gen.depth)
+    assert_equal('seed', gen.seed)
+
+    gen = FibonacciRng.new(depth: 12)
+    assert_equal(12, gen.depth)
+    assert_equal(String, gen.seed.class)
+
+    gen = FibonacciRng.new(seed: 'seed', depth: 12)
+    assert_equal(12, gen.depth)
+    assert_equal('seed', gen.seed)
+
+    gen = FibonacciRng.new(depth: 12, seed: 'seed')
+    assert_equal(12, gen.depth)
+    assert_equal('seed', gen.seed)
+  end
 
   def test_that_rejects_bad_parms
     assert_raises { FibonacciRng.new('seed', 1) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fibonacci_rng
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest_visible
@@ -94,8 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.1
-description: A Fibonacci inspired pseudo random number generator. Just try and prove
-  that it sucks! ;-)
+description: A Fibonacci inspired pseudo random number generator. Suitable for light
+  duties.
 email:
 - peter.c.camilleri@gmail.com
 executables: []