composite_rng 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f396507dbca6e987cfa25c886a4f19d43f97ac65
-  data.tar.gz: 81a4458332e1722aab3a4b6071ef4855445346b4
+  metadata.gz: 7c30e36b6d59c807536035ad3fdbaefa8dccb420
+  data.tar.gz: 3ff2d418c856aa7af2b76af17e5f9d3950caa6d8
 SHA512:
-  metadata.gz: 09c2e901a722205421eb0b18f95b02b81f84ed0bcb45abc34f185876a23da41587369328e4e23a79d07d7f5124775590ccbec3f98c03595ecbf36fe326bc6088
-  data.tar.gz: beb18e79a48d6916c1612a15dfd409b6077e5e240a4458c95949517947a26ab4c5ed2bf1b43d620e361c24014f6222407196d688e90379bd0c71ff52ca0bae03
+  metadata.gz: 8282ef4f619b086e53fc1663cc843008b194f533baa72d0806d499d4ef4e3c5bdad1c50e9a49de39d1825d379c5275d697edc0c00dbe0275214ddfa2c185e7c4
+  data.tar.gz: 495bef03e18c3860c9e50cb023fe50e70b792d66f9d066ee830697e2c290d9668a0a273b4b7ba8b82d609862f1ca98d66bfddaa4c9ad355670b1777dd2120652

data/README.md

@@ -8,37 +8,68 @@ 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 generators used most comply to the following duck characteristics:
+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:
-
-    parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
-    child  = Random.new
-    composite = CompositeRng.new(parent, child)
-    # ...
-    dice_roll = composite(6)
-    # ...
+```ruby
+parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
+child  = Random.new
+composite = CompositeRng.new(parent, child, 42)
+# ...
+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:
-
-    parent = Object.new
-    child  = Random.new
-    composite = CompositeRng.new(parent, child)
-    # ...
-    dice_roll = composite(6)
-    # ...
-
+```ruby
+parent = Object.new
+child  = Random.new
+composite = CompositeRng.new(parent, child)
+# ...
+dice_roll = 1 + composite.rand(6)
+# ...
+```
 This is because the default PRNG exists as methods of Object. Note that (as
 far as I can tell) only one instance of that PRNG exists, so it should only
 be used as parent or child but never both!.
 
-Most PRNGs provide more resources beyond the basic "rand" method. Access to
-these other methods is provided by using the churn method. An example,
-accessing the bytes method of the Random class follows:
+The composite generator also works with custom generator, that support rand(n)
+like my own Fibonacci generator:
+
+```ruby
+parent = Random.new
+child  = FibonacciRng.new(depth: 12)
+composite = CompositeRng.new(parent, child)
+# ...
+dice_roll = 1 + composite.rand(6)
+# ...
+```
 
-    crazy_string = composite.churn.bytes(22) # Get a string of 22 random chars.
+#### Accessing advanced methods with churn
+
+Most PRNGs provide more resources beyond the basic "rand" method. Access to
+these other methods is provided by using the churn method. The churn method
+returns the child PRNG after it has received a suitable period of instruction
+from the parent PRNG. An example, accessing the bytes method of the Random
+class follows:
+```ruby
+# Get a string of 22 random chars.
+crazy_string = composite.churn.bytes(22)
+```
+While this code seems to work, it really is weak tea. The issue is that the
+education process is only carried out once. The following code does a much
+more thorough job:
+```ruby
+# Get a string of 22 random chars.
+crazy_string = 22.times.inject("") { |s| s << composite.churn.bytes(1) }
+```
 
 ## Installation
 
@@ -54,10 +85,19 @@ Or install it yourself as:
 
     $ gem install composite_rng
 
+The composite_rng gem itself is found at: ( https://rubygems.org/gems/composite_rng )
+
 ## Contributing
 
-1. Fork it
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/composite_rng/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 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.

data/irbt.rb

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

data/lib/composite_rng/version.rb

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

data/lib/composite_rng.rb

@@ -1,4 +1,4 @@
-require "composite_rng/version"
+require_relative "composite_rng/version"
 
 #A class of random number generators that work by nesting other PRNGs.
 class CompositeRng

data/{Rakefile → rakefile.rb}

@@ -32,14 +32,7 @@ end
 
 desc "Fire up an IRB session with composite_rng preloaded."
 task :console do
-  require 'irb'
-  require 'irb/completion'
-
-  require './lib/composite_rng'
-  puts "Starting an IRB console for composite_rng."
-
-  ARGV.clear
-  IRB.start
+  system "ruby irbt.rb local"
 end
 
 desc "What version of the composite_rng is this?"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_rng
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,10 +105,11 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - composite_rng.gemspec
+- irbt.rb
 - lib/composite_rng.rb
 - lib/composite_rng/version.rb
+- rakefile.rb
 - reek.txt
 - tests/composite_rng_tests.rb
 homepage: http://teuthida-technologies.com/