composite_rng 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTY0YTA0OWM2M2I1MDQ0YTRkNjdkMDU0YmY0OWVhMGE0NDZkMTgwZg==
+  data.tar.gz: !binary |-
+    M2U5MzVlN2UzOWEwNmFiZjU5YmIyZGIyNjlhOTdmN2Q0YWI2ZWViOA==
+SHA512:
+  metadata.gz: !binary |-
+    MDExOGI0YjNlMTM0Njc3YzZhYjA5NDBmZTg0Njc2NDA4ZjBkMjY1ZDE0MDcw
+    MmM4ZTViNzI4YWVmN2NkM2NmYzM0ZjRlZGNlNjI2MzM3ZTQ2YmI1NmI5NTMy
+    YjRmYTI4YjZhY2FkNDhmY2JlM2ViNGUzNDZiZWY2Y2RhNThiMGQ=
+  data.tar.gz: !binary |-
+    ZWViMTI5YWU5MDg2MGFkNzg5NDIxY2EwOTkyYWM3YjhhNWI0NmFjZTQ4MDM4
+    YjhkZjFiYjAxMDNmOWU3ZWI3MWE0NmNlMGY0MGQ2NjJkOWE4ZWFjYjFmY2E3
+    ZDE2YWExOWUxOTlmYTI1ODdkYWRjNTNjMDI0YzdmZGVjOWY1OTA=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in composite_rng.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Camilleri
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# CompositeRng
+
+The composite (psuedo) random number generator is a container for two other
+(psuedo) random number generators. By working together, these create higher
+quality random number streams than either could by itself.
+
+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:
+
+    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)
+    # ...
+
+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)
+    # ...
+
+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:
+
+    crazy_string = composite.churn.bytes(22) # Get a string of 22 random chars.
+
+## 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
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,49 @@
+# coding: utf-8
+require 'rake/testtask'
+require 'rdoc/task'
+require "bundler/gem_tasks"
+
+#Run the fOOrth unit test suite.
+Rake::TestTask.new do |t|
+  #List out all the test files.
+  t.test_files = FileList['tests/**/*.rb']
+  t.verbose = false
+end
+
+#Generate internal documentation with rdoc.
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+
+  #List out all the files to be documented.
+  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt", "README.md")
+
+  #Make all access levels visible.
+  rdoc.options << '--visibility' << 'private'
+
+  #Set a title.
+  rdoc.options << '--title' << 'CompositeRng Docs'
+
+end
+
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+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
+end
+
+desc "What version of the composite_rng is this?"
+task :vers do |t|
+  puts
+  puts "CompositeRng version = #{CompositeRng::VERSION}"
+end

data/composite_rng.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'composite_rng/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "composite_rng"
+  spec.version       = CompositeRng::VERSION
+  spec.authors       = ["Peter Camilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+  spec.description   = "A composable random number generator."
+  spec.summary       = "A composable random number generation class."
+  spec.homepage      = "http://teuthida-technologies.com/"
+  spec.license       = "MIT"
+
+  raw_list = `git ls-files`.split($/)
+  raw_list = raw_list.keep_if {|entry| !entry.start_with?("docs") }
+
+  spec.files         = raw_list
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'reek', "~> 1.3.8"
+  spec.add_development_dependency 'minitest', "~> 4.7.5"
+  spec.add_development_dependency 'rdoc', "~> 4.0.1"
+end

data/lib/composite_rng.rb

@@ -0,0 +1,32 @@
+require "composite_rng/version"
+
+#A class of random number generators that work by nesting other PRNGs.
+class CompositeRng
+
+  #Create a composite PRNG
+  #<br>Parameters
+  #* parent - the starting PRNG
+  #* child - the progeny PRNG
+  #* churn - the amount of churning done.
+  def initialize(parent, child, churn=16)
+    @parent, @child, @churn = parent, child, churn
+  end
+
+  #An access point for random numbers.
+  #<br>Parameters
+  #* max - the range of the numbers to be created.
+  #<br>Returns
+  #* a random value generated according to the max parameter.
+  def rand(max=0)
+    churn.rand(max)
+  end
+
+  #Stir the soup!
+  #<br>Returns
+  #* a churned random number generator.
+  def churn
+    (1 + @parent.rand(@churn)).times {@child.rand(256)}
+    @child
+  end
+
+end

data/lib/composite_rng/version.rb

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

data/reek.txt

@@ -0,0 +1,2 @@
+
+0 total warnings

data/tests/composite_rng_tests.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require_relative '../lib/composite_rng'
+require          'minitest/autorun'
+
+#Test the monkey patches applied to the Object class.
+class CompositeRngTester < MiniTest::Unit::TestCase
+
+  #Special initialize to track rake progress.
+  def initialize(*all)
+    $do_this_only_one_time = "" unless defined? $do_this_only_one_time
+
+    if $do_this_only_one_time != __FILE__
+      puts
+      puts "Running test file: #{File.split(__FILE__)[1]}"
+      $do_this_only_one_time = __FILE__
+    end
+
+    super(*all)
+  end
+
+  def test_that_it_creates_dice_rolls
+    prng = CompositeRng.new(Random.new, Random.new)
+
+    100.times do
+      assert((0...6) === prng.rand(6))
+    end
+  end
+
+  def test_random_string
+    prng = CompositeRng.new(Random.new, Random.new)
+
+    rs = prng.churn.bytes(10)
+
+    assert(rs.is_a?(String))
+    assert_equal(10, rs.length)
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: composite_rng
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Camilleri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: A composable random number generator.
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- composite_rng.gemspec
+- lib/composite_rng.rb
+- lib/composite_rng/version.rb
+- reek.txt
+- tests/composite_rng_tests.rb
+homepage: http://teuthida-technologies.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.4
+signing_key: 
+specification_version: 4
+summary: A composable random number generation class.
+test_files: []
+has_rdoc: