capricious 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGES

@@ -0,0 +1,5 @@
+version 0.0.2 
+
+* initial release
+* linear-feedback shift register based PRNG
+* uniform-distribution generator

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,11 @@
+= capricious
+
+Capricious is a library for pseudo-random number generation; it
+is primarily intended for use in simulation. Currently, one
+distribution (uniform) is provided over one underlying pseudo-
+random generator (a linear-feedback shift register), but in the 
+future Capricious will provide more of each.
+
+== Copyright
+
+Copyright (c) 2010 Red Hat, Inc.  See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "capricious"
+    gem.summary = %Q{Pseudorandom number generator classes and support code}
+    gem.description = %Q{Pseudorandom number generator classes and support code, parameterized on a source of randomness and a probability distribution}
+    gem.email = "willb@redhat.com"
+    gem.homepage = "http://github.com/willb/capricious"
+    gem.authors = ["Will Benton"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "capricious #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/capricious.rb

@@ -0,0 +1,21 @@
+# capricious:  random number generators for Ruby
+#
+# Copyright (c) 2010 Red Hat, Inc.
+#
+# Author:  William Benton <willb@redhat.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'capricious/lfsr'
+require 'capricious/sample_sink'
+require 'capricious/uniform'

data/lib/capricious/lfsr.rb

@@ -0,0 +1,110 @@
+# capricious/lfsr.rb:  linear-feedback shift register class
+#
+# Copyright (c) 2010 Red Hat, Inc.
+#
+# Author:  William Benton <willb@redhat.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Capricious
+  # Linear-feedback shift register class
+  class LFSR
+
+    attr_reader :seed
+
+    def LFSR.new_with_seed(seed)
+      LFSR.new(nil, seed)
+    end
+    
+    # initializes
+    def initialize(size=nil, seed=nil)
+      size = size || (0.size * 8)
+      case size
+      when 64
+        @ns = SixtyFourBitShifter
+        class << self ; include SixtyFourBitShifter ; private :shift_reg ; end
+      when 32
+        @ns = ThirtyTwoBitShifter
+        class << self ; include ThirtyTwoBitShifter ; private :shift_reg ; end
+      when 16
+        @ns = SixteenBitShifter
+        class << self ; include SixteenBitShifter ; private :shift_reg ; end
+      else
+        @ns = ThirtyTwoBitShifter
+        class << self ; include ThirtyTwoBitShifter ; private :shift_reg ; end
+      end
+      
+      reset
+    end
+
+    def next
+      shift_reg
+      @reg
+    end
+
+    def next_f
+      self.next
+      @reg.quo(@ns::MASK.to_f)
+    end
+
+    def reset(seed=nil)
+      @seed ||= (seed || Time.now.utc.to_i) & @ns::MASK
+      @reg = @seed
+    end
+  end
+
+  module SixtyFourBitShifter
+    MASK = 0xffffffffffffffff
+    SIZE = 64
+    BITS = [64,63,61,60]
+    BITSELECT = BITS.map {|bit| "@reg[#{SIZE-bit}]"}.join("^")
+    
+    class_eval <<-SHIFT_REG
+    def shift_reg
+      bit = #{BITSELECT}
+      @reg = (@reg >> 1) | (bit << #{SIZE-1})
+    end
+    SHIFT_REG
+  end 
+  
+  module ThirtyTwoBitShifter
+    MASK = 0xffffffff
+    SIZE = 32
+    BITS = [32,31,30,10]
+    BITSELECT = BITS.map {|bit| "@reg[#{SIZE-bit}]"}.join("^")
+    
+    class_eval <<-SHIFT_REG
+    def shift_reg
+      bit = #{BITSELECT}
+      @reg = (@reg >> 1) | (bit << #{SIZE-1})
+    end
+    SHIFT_REG
+  end
+
+  module SixteenBitShifter
+    MASK = 0xffff
+    SIZE = 16
+    BITS = [16,14,13,11]
+    BITSELECT = BITS.map {|bit| "@reg[#{SIZE-bit}]"}.join("^")
+    
+    class_eval <<-SHIFT_REG
+    def shift_reg
+      bit = #{BITSELECT}
+      @reg = (@reg >> 1) | (bit << #{SIZE-1})
+    end
+    SHIFT_REG
+  end
+  
+  nil
+end
+

data/lib/capricious/sample_sink.rb

@@ -0,0 +1,62 @@
+# capricious/sample_sink.rb:  sample aggregator
+#
+# Copyright (c) 2010 Red Hat, Inc.
+#
+# Author:  William Benton <willb@redhat.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Capricious
+  class SampleSink
+    
+    attr_reader :min, :max, :count, :mean
+    
+    def initialize
+      @min = nil
+      @max = nil
+      @count = 0
+      @var = 0.0
+      @mean = 0.0
+      @sum_x2 = 0.0
+    end
+    
+    def put(sample)
+      update_stats(sample)
+      update_estimates(sample)
+      nil
+    end
+    
+    def <<(sample)
+      self.put(sample)
+      self
+    end
+    
+    def stddev
+      Math::sqrt(@var)
+    end
+    
+    private
+    def update_stats(sample)
+      @min = sample if (@min == nil || sample < @min)
+      @max = sample if (@max == nil || sample > @max)
+      @count = @count + 1
+    end
+    
+    def update_estimates(sample)
+      dev = sample - @mean
+      @mean += (dev / @count)
+      @sum_x2 += (dev * (sample - @mean))
+      @var = @sum_x2 / @count
+    end
+  end
+end

data/lib/capricious/uniform.rb

@@ -0,0 +1,43 @@
+# capricious/uniform.rb:  uniform-distribution PRNG, with selectable source-randomness policy
+#
+# Copyright (c) 2010 Red Hat, Inc.
+#
+# Author:  William Benton <willb@redhat.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'capricious/lfsr'
+require 'capricious/sample_sink'
+
+module Capricious
+  class Uniform
+    attr_reader :aggregate, :seed
+    
+    def initialize(seed=nil, policy=LFSR, keep_stats=false)
+      @prng = policy.new_with_seed(seed)
+      @seed = @prng.seed
+      @aggregate = SampleSink.new if keep_stats
+    end
+    
+    def next
+      val = @prng.next_f
+      @aggregate << val if @aggregate
+      val
+    end
+
+    def reset(seed=nil)
+      @prng.reset(seed)
+      @aggregate = SampleSink.new if @aggregate
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'capricious'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/uniform_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module Capricious
+  EXPECTED_MEAN = 0.5
+  EXPECTED_STDDEV = 0.288675134594813
+  SAMPLE_COUNT = 200000
+
+  describe Uniform do
+    def generate_samples(count=SAMPLE_COUNT)
+      count.times {@uniform.next}
+    end
+    
+    before(:each) do
+      @uniform = Capricious::Uniform.new(nil, LFSR, true)
+    end
+    
+    it "should generate numbers in the range (0,1]" do
+      generate_samples
+      @uniform.aggregate.max.should <= 1.0
+      @uniform.aggregate.min.should > 0.0
+    end
+
+    it "should generate uniformly-distributed numbers in the range (0,1], as judged by mean and variance estimates" do
+      generate_samples
+      @uniform.aggregate.mean.should be_close(EXPECTED_MEAN, 0.01)
+      @uniform.aggregate.stddev.should be_close(EXPECTED_STDDEV, 0.01)
+    end
+    
+    it "should generate the same sequence given the same seed" do
+      @uniform2 = Uniform.new(@uniform.seed, LFSR, true)
+      SAMPLE_COUNT.times { @uniform2.next.should == @uniform.next }
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: capricious
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Will Benton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Pseudorandom number generator classes and support code, parameterized on a source of randomness and a probability distribution
+email: willb@redhat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CHANGES
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/capricious.rb
+- lib/capricious/lfsr.rb
+- lib/capricious/sample_sink.rb
+- lib/capricious/uniform.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/uniform_spec.rb
+has_rdoc: true
+homepage: http://github.com/willb/capricious
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pseudorandom number generator classes and support code
+test_files: 
+- spec/spec_helper.rb
+- spec/uniform_spec.rb