vose 0.1.0

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,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  platforms :ruby do
+    gem 'ruby_gntp'
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thunderbolt Labs, LLC.
+
+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,42 @@
+# Vose: Sample random values from a discrete probability distribution.
+
+Vose is a Ruby implementation of the Vose Alias Method. It allows for
+sampling of random values from a discrite probability distribution or in
+others rolling a loaded die. This implementation is runs in O(1) time after
+after a O(n) initialization.
+
+For more information on the theory, have a look at [Darts, Dice, and Coins: Sampling from a Discrete Distribution](http://www.keithschwarz.com/darts-dice-coins/)
+
+## Installation
+
+To track the latest officially released gem:
+
+    gem 'vose' # for the latest officially released gem
+
+*OR* To track the git repo
+
+    gem 'vose', :git => "git://github.com/thunderboltlabs/vose.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vose
+
+## Usage
+
+    probabilities = [0.4, 0.1, 0.2, 0.3]
+    vose = Vose::AliasMethod.new probalities
+    choice = vose.next
+
+The choice will be an index of the probalities array.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |tt|
+  tt.pattern = 'spec/*_spec.rb'
+  tt.verbose = true 
+  tt.libs << "spec"
+end

data/lib/vose/version.rb

@@ -0,0 +1,3 @@
+module Vose
+  VERSION = "0.1.0"
+end

data/lib/vose.rb

@@ -0,0 +1,81 @@
+require "vose/version"
+
+module Vose
+  class InvalidArgumentException < RuntimeError; end;
+
+  class AliasMethod
+    attr_reader :limit
+
+    def initialize(probabilities)
+      raise InvalidArgumentException if probabilities.empty?
+      raise InvalidArgumentException if probabilities.any?{|p| p < 0}
+
+      @limit = probabilities.length
+      sum = probabilities.reduce(:+)
+
+      scale = limit / sum.to_f
+      scaled_probality = []
+      probabilities.each do |p|
+        scaled_probality << (p * scale)
+      end
+
+      @prob = Array.new(limit) { 0 }
+      @alias = Array.new(limit) { 0 }
+
+      preprocess(scaled_probality)
+    end
+
+    def preprocess(scaled_probality)
+      small_worklist         = []
+      large_worklist         = []
+      small_worklist_counter = 0
+      large_worklist_counter = 0
+
+      scaled_probality.each_with_index do |p,i|
+        if p > 1
+          large_worklist[large_worklist_counter] = i
+          large_worklist_counter+=1
+        else
+          small_worklist[small_worklist_counter] = i
+          small_worklist_counter+=1
+        end
+      end
+
+      while small_worklist_counter != 0 && large_worklist_counter != 0
+        small_worklist_counter-=1
+        large_worklist_counter-=1
+        current_small_worklist_index = small_worklist[small_worklist_counter].to_i
+        current_large_worklist_index = large_worklist[large_worklist_counter].to_i
+
+        @prob[current_small_worklist_index] = scaled_probality[current_small_worklist_index]
+        @alias[current_small_worklist_index] = current_large_worklist_index
+
+        scaled_probality[current_large_worklist_index] = (scaled_probality[current_large_worklist_index] + scaled_probality[current_small_worklist_index]) - 1
+        if scaled_probality[current_large_worklist_index] > 1
+          large_worklist[large_worklist_counter] = k
+          large_worklist_counter+=1
+        else
+          small_worklist[small_worklist_counter] = current_large_worklist_index
+          small_worklist_counter+=1
+        end
+      end
+
+      while small_worklist_counter != 0
+        small_worklist_counter-=1
+        @prob[small_worklist[small_worklist_counter]] = 1
+      end
+
+      while large_worklist_counter != 0
+        large_worklist_counter-=1
+        @prob[large_worklist[large_worklist_counter]] = 1
+      end
+    end
+
+    def next
+      fair_die_roll = @limit * rand
+      i = fair_die_roll.floor
+      p = fair_die_roll - i
+      p <= @prob[i] ? i : @alias[i]
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'vose'
+
+module MiniTest::Assertions
+  def assert_vose_probability(probabilities, results)
+    probabilities.each_with_index do |probablity, i|
+      percentage = results.count(i) / results.size.to_f
+      assert_in_delta probablity, percentage, 0.01
+    end
+  end
+end
+
+Array.infect_an_assertion :assert_vose_probability, :must_match_probability

data/spec/vose_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Vose::AliasMethod do
+  it "complains if the list of probabilities is empty" do
+    probabilities = []
+    lambda { 
+      Vose::AliasMethod.new probabilities
+    }.must_raise(Vose::InvalidArgumentException)
+  end
+
+  it "complinas if the probabilities aren't positive" do
+    probabilities = [-0.5]
+    lambda { 
+      Vose::AliasMethod.new probabilities
+    }.must_raise(Vose::InvalidArgumentException)
+  end  
+
+  it "sets the limit to the lenght of probabilities" do
+    probabilities = [0.1, 0.9]
+    vose = Vose::AliasMethod.new probabilities
+    vose.limit.must_equal 2
+  end
+
+  # Yes, this is a slow test. Consider it an acceptance
+  # level test :) Patches are welcome. Testing rand is hard or
+  # brittle imho.
+  it "allows you choose the next probablity given your inputs" do
+    probabilities = [0.1, 0.5, 0.4]
+    vose = Vose::AliasMethod.new probabilities
+    results = []
+    10000.times { results << vose.next }
+    results.must_match_probability probabilities
+  end
+end

data/vose.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/vose/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["bryanl"]
+  gem.email         = ["bryan@osesm.com"]
+  gem.description   = %q{Vose: Sample random values from a discrete probability distribution.
+}
+  gem.summary       = %q{Vose is a Ruby implementation of the Vose Alias Method. It allows for sampling of random values from a discrite probability distribution or in others words, rolling a loaded die.}
+  gem.homepage      = "https://github.com/thunderboltlabs/vose"
+
+  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          = "vose"
+  gem.require_paths = ["lib"]
+  gem.version       = Vose::VERSION
+
+  gem.add_development_dependency("pry")
+  gem.add_development_dependency("ruby_gntp")
+  gem.add_development_dependency("guard-minitest")
+  gem.add_development_dependency("guard-bundler")
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: vose
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- bryanl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70195541301040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70195541301040
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: &70195541300280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70195541300280
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &70195541299780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70195541299780
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &70195541299320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70195541299320
+description: ! 'Vose: Sample random values from a discrete probability distribution.
+
+'
+email:
+- bryan@osesm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vose.rb
+- lib/vose/version.rb
+- spec/spec_helper.rb
+- spec/vose_spec.rb
+- vose.gemspec
+homepage: https://github.com/thunderboltlabs/vose
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Vose is a Ruby implementation of the Vose Alias Method. It allows for sampling
+  of random values from a discrite probability distribution or in others words, rolling
+  a loaded die.
+test_files:
+- spec/spec_helper.rb
+- spec/vose_spec.rb