composite_rng 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f340e108ce670dca8fd91ec9089ae5753eae06e
-  data.tar.gz: b992ad5f3defe4e2578090833730107b256bfc89
+  metadata.gz: b708a3140244ee9cd7919bd64f09693ff1e0898e
+  data.tar.gz: c8ab8c08c73c26c0f12bcfbbc4ebfe11237b9762
 SHA512:
-  metadata.gz: 1731dee7aeb11ec2f9006853c038211c89afcaa4a5e4e9f4e6b3f74e24339218d39c2108e270feea0b05aa01a9f6277d365fb27b59e1397d2799f06d314f828d
-  data.tar.gz: cf12a60cc2dba80842ef8f2e73dede341cb0a7e6766f1800a6bec6f16b00fbf3a2dd030f7e380818288f3670120f1d12a18d824985ea45dce084da9176f947a4
+  metadata.gz: c5acd1e444d66764fc2b2d5245be9bf12b8c693ea8d9461260da810628dd7aa8b8c7889474a22f12056977f70622669946f3cfc569f73779a22917d773cc6578
+  data.tar.gz: 33ad85e4dd8525b41ed8d3580b01133696b4ec3574cbce78f81bff40cbd471933e83d5bc5be81f047629d53d102c4b67ae5554a5910922520862439eb7ebbc4c

data/README.md

@@ -1,53 +1,68 @@
 # CompositeRng
 
 The composite (psuedo) random number generator is a container for two other
-(psuedo) random number generators. By working together, these create higher
-quality pseudo-random number streams than either could by itself.
+(psuedo) random number generators. By working together, these generators
+create higher quality pseudo-random number streams than either could create
+by itself.
 
-The two generators do not need to be the same type. In fact it helps to reduce
-any possible correlation between the parent and the child if they are
-completely different sorts of generators. It is really not a good idea for them
-to be either the same instance, or the same type with the same seed, because
-this negates the advantage of compositing generators.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'composite_rng'
+
+And then execute:
+
+    $ bundle
 
-The generators used must comply to the following duck characteristics:
+Or install it yourself as:
+
+    $ gem install composite_rng
 
-    rand(max) - This method must compute a random integer from 0...max
+The composite_rng gem itself is found at: ( https://rubygems.org/gems/composite_rng )
 
-The constructor takes four arguments:
-* The parent PRNG that is used to "educate" the child.
-* The child PRNG that is the actual generator of data.
-* The optional churn_limit factor that controls how much tutoring the child
-can receive. This optional parameter defaults to 16. This value may be read
-back with the churn_limit property. Valid values are 2..256
-* The optional init factor that controls the amount of initial tutoring the
-child receives initially. This defaults to 0 for none. Valid values are 0..256
+##Usage
 
-The following shows how this could work:
 ```ruby
-parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
-child  = Random.new
-composite = CompositeRng.new(parent, child, 42, 11)
-# ...
-dice_roll = 1 + composite.rand(6)
-# ...
+require 'composite_rng'
 ```
 
-It is also possible to use the default PRNG as follows:
+Then in an appropriate place in the code:
+
 ```ruby
-parent = Object.new
+@my_rng = CompositeRng.new(parent, child, churn, init)
+```
+Where:
+* parent is a random number generator used to educate the child.
+* child is the random number generator used to generate the output.
+* churn is the limit on the education process. Default 16, Range 2..256
+* init is the number of initial churns done during initialization. Default 0, Range 0..256
+
+The parent and child generators do not need to be the same type. In fact it
+helps to reduce any possible correlation between the parent and the child
+if they are completely different sorts of generators. It is a really bad
+idea for them to be either the same instance, or the same type with the same
+seed, because this negates the advantage of compositing generators.
+
+To be used in a composite generator, both generators used must implement the
+following method:
+
+    rand(max)
+
+which method must return a pseudo-random integer in 0...max.
+
+The following are examples of this class in action.
+```ruby
+parent = Random.new #Get the built in Mersenne Twister MT19937 PRNG
 child  = Random.new
-composite = CompositeRng.new(parent, child)
+composite = CompositeRng.new(parent, child, 42, 11)
 # ...
 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!.
 
-The composite generator also works with custom generator, that support rand(n)
-like my own Fibonacci generator:
+The composite generator also works with custom generators that support rand(n).
+For example my own Fibonacci generator:
 
 ```ruby
 parent = Random.new
@@ -77,24 +92,6 @@ more thorough job:
 crazy_string = 22.times.inject("") { |s| s << composite.churn.bytes(1) }
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'composite_rng'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install composite_rng
-
-The composite_rng gem itself is found at: ( https://rubygems.org/gems/composite_rng )
-
-The fibonacci_rng code lives at: ( https://github.com/PeterCamilleri/fibonacci_rng )
-
 ## Contributing
 
 #### Plan A

data/irbt.rb

@@ -2,8 +2,6 @@
 # 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."
 

data/lib/composite_rng/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_rng
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler