random_value_sampler 0.1.2 → 0.1.3

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 random_value_sampler.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brian Percival
+
+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,100 @@
+# RandomValueSampler
+
+Class to allow sampling from very, very simple probability mass functions
+(uniform and arbitrary non-uniform). Values can be any object; 
+for uniform distributions, a Range can be used to specify a range of
+discrete values.
+
+To specify a uniform distribution, only the values need to be specified, and
+can be:
+  - an Array of values (it is assumed the values are distinct, but you may
+    insert duplicates if you know what you're doing and realize you're probably
+    no longer dealing with a truly uniform distribution anymore (but this could
+    be used to "cheat" to generate distributions that are 'nearly' uniform where
+    probability mass is quantized (e.g. a 1/3, 2/3 distribution). This may
+    prove to be a more efficient implementation in such cases as the non-uniform
+    pmf is more computationally demanding).
+  - a ruby Range object; RandomValueSampler honors the inclusion/exclusion of last/end
+    of the Range (as defined by exclude_end? method). the Range must be of
+    numeric type unless you REALLY know what you're doing (e.g. the Xs class
+    example in the Range rdoc won't work).
+  - a single numeric type specifying an upper bound (zero is assumed as 
+    lower bound--both zero and upper bound are included in distribution)
+
+To specify a non-uniform distribution, the values and probability mass
+must be specified. It is not necessary for the probability mass to
+represent a true probability distribution (needn't sum to 1), as the class
+will normalize accordingly. The pmf may be specified as a Hash or an Array:
+  - Hash, where the hash keys are the possible values the random variable
+    can take on; the hash values are the 'frequency counts' or non-normalized
+    probability mass
+  - Array, each element of which is a two-element array. each two element
+    array's first element is the value; the last element is the frequency
+    count for that value
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'random_value_sampler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install random_value_sampler
+
+## Usage
+
+require 'random_value_sampler'
+
+uniform
+
+    # generate a uniform pmf over [1,5]
+    a = RandomValueSampler.new_uniform([1,2,3,4,5])
+
+    # generate a uniform pmf over some words
+    a = RandomValueSampler.new_uniform(["one", "two", "buckle", "my", "shoe"])
+
+    # generate a 'quantized' pmf by using duplicate entries
+    a = RandomValueSampler.new_uniform([1, 2, 2, 3, 3, 3])
+    a = RandomValueSampler.new_uniform(["the", "the", "a", "the", "and", "zyzzyva"])
+
+    # generate a uniform pmf over [1,5] using a Range
+    a = RandomValueSampler.new_uniform(1..5)
+    a = RandomValueSampler.new_uniform(1...6)
+
+    # generate a uniform pmf over [0,5] by specifying upper limit
+    a = RandomValueSampler.new_uniform(5)
+
+non-uniform
+
+    # generate a non-uniform pmf using the Hash form:
+
+    # values are 5 and 10, with probability 0.4 and 0.6, respectively
+    a = RandomValueSampler.new_non_uniform( { 5 => 20, 10 => 30 } )
+
+    # values are "probable", "possible" and "not likely" with probability
+    # 0.75, 0.20 and 0.05, respectively.
+    a = RandomValueSampler.new_non_uniform( { "probable" => 75,
+                                "possible" => 20, 
+                                "not likely" => 5 } )
+
+    # generate a non-uniform pmf using the Array form (same examples as above)
+    a = RandomValueSampler.new_non_uniform( [ [5,20], [10,30] )
+    a = RandomValueSampler.new_non_uniform( [ ["probable",75],
+                                ["possible" => 20], 
+                                ["not likely" => 5 ] ] )
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write new tests and test:
+   bundle exec rake test
+   (NOTE: if you add new test files, please clean up the test rake test...it's a hack right now)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc "run the unit tests"
+task :test do
+  require File.join(File.dirname(File.expand_path(__FILE__)), 'test/random_value_sampler_test')
+end

data/lib/random_value_sampler/version.rb

@@ -0,0 +1,3 @@
+class RandomValueSampler
+  VERSION = "0.1.3"
+end

data/lib/random_value_sampler.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'random_value_sampler/version')
+
 # simple class for generating and sampling from a probability distribution,
 # including implementation of sampling from uniform and arbitrary distributions
 # on discrete random variables, by passing in an object that represents
@@ -40,7 +42,6 @@
 # the sample_unique() method will likely run faster.
 #-------------------------------------------------------------------------------
 class RandomValueSampler
-
   # instantiate RandomValueSampler given a probability_function object. the
   # object must respond to:
   #   - sample_from_distribution -> single value sampled from distribution
@@ -235,8 +236,8 @@ class RandomValueSampler
         end
 
         @num_values = vals.length
-        @values = vals
-      else
+        @values = vals.clone
+      else # (Range)
         @num_values = vals.last - vals.first + (vals.exclude_end? ? 0 : 1)
         @values = vals
 

data/random_value_sampler.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.join(File.dirname(File.expand_path(__FILE__)), 'lib/random_value_sampler/version')
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian Percival"]
+  gem.email         = ["bpercival@goodreads.com"]
+  gem.description   = %q{Class for sampling from arbitrary probability distributions}
+  gem.summary       = %q{Class for sampling from arbitrary probability distributions, particular discrete random variables with lookup-table-like PMFs}
+  gem.homepage      = "https://github.com/bmpercy/random_value_sampler"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "random_value_sampler"
+  gem.require_paths = ["lib"]
+  gem.version       = RandomValueSampler::VERSION
+  gem.add_development_dependency 'rake'
+end

data/test/.svn/entries

@@ -0,0 +1,62 @@
+10
+
+dir
+16712
+svn+ssh://bpercival@svn/home/svn/repository/discovereads_archive/code/gems/random_value_sampler/test
+svn+ssh://bpercival@svn/home/svn/repository
+
+
+
+2011-03-18T22:57:57.847457Z
+16598
+bpercival
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+b7929305-2822-0410-b81b-d5ebcc0c7c9f
+
+random_value_sampler_test.rb
+file
+
+
+
+
+2011-03-23T18:17:45.000000Z
+57871a1c82580fe89b7e24f39c979bb4
+2011-03-18T22:57:57.847457Z
+16598
+bpercival
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+42257
+