walker_method 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Cantino
+
+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,51 @@
+# WalkerMethod
+
+Walker's Alias Method is an O(1) algorithm for selecting elements from an array given a weighted distribution.
+
+For example, let's say you want to return `:win` 80% of the time and `:lose` 20% of the time.  You could fill an array with
+8 examples of `:win` and 2 examples `:lose`, then pick a random element.  You could also use ranges, picking a random number
+between 0.0 and 1.0 and returning `:win` when the number is below 0.8, `:lose` otherwise.  But, these algorithms are still O(n).
+You can do better by using a heap or binary search tree.  Walker's Alias Method is better still, with a constant runtime once an O(n)
+pre-computation phase has completed.  For this example, you could do:
+
+    selector = WalkerMethod.new([:win, :lose], [80, 20])
+    selector.random
+
+This implementation is a port of http://code.activestate.com/recipes/576564-walkers-alias-method-for-random-objects-with-diffe/ from Python to Ruby.  There is also a [Node.js implementation](https://github.com/ThoughtLeadr/Walker-Random-Node).
+
+## Speed
+
+It's FAST and simple.  It samples from a 50,000 word frequency dictionary 10,000 times in 1.2 miliseconds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'walker_method'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install walker_method
+
+## Usage
+
+    # Sampling from an English word frequency dictionary care of http://invokeit.wordpress.com/frequency-word-lists
+
+    words = ["you", "the", "i", "to", "a", "and", "it", "of", "that", "in", "is", "me", "what", "this", "for", "my", "on", "your", "we", "have", "do", "no", "don't", "are", "be"]
+    freqs = [4621939, 3957465, 3476773, 2873389, 2551033, 1775393, 1693042, 1531878, 1323823, 1295198, 1242191, 1208959, 1071825, 961194, 898671, 877684, 867296, 834953, 819499, 812625, 799991, 788200, 764177, 743194, 743014]
+
+    selector = WalkerMethod.new(words, weights)
+    selector.random
+    # => "and"
+
+## 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,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/walker_method.rb

@@ -0,0 +1,47 @@
+require "walker_method/version"
+
+class WalkerMethod
+  attr_accessor :prob, :inx, :keys, :weights, :sumw, :length
+
+  def initialize(keys, weights)
+    self.keys = keys
+    self.weights = weights
+    self.sumw = weights.reduce(&:+).to_f
+    self.prob = []
+    self.inx = []
+    self.length = weights.length
+    short = []
+    long = []
+    weights.each do |w|
+      inx << -1
+      prob << w * length / sumw
+    end
+
+    prob.each.with_index do |p, index|
+      short << index if p < 1
+      long << index if p > 1
+    end
+
+    while short.length > 0 && long.length > 0
+      j = short.pop
+      k = long[-1]
+      inx[j] = k
+      prob[k] -= (1 - prob[j])
+      if prob[k] < 1
+        short << k
+        long.pop
+      end
+    end
+
+    def random
+      u = rand
+      j = (rand * length).to_i
+      if u <= prob[j]
+        keys[j]
+      else
+        keys[inx[j]]
+      end
+    end
+  end
+end
+

data/lib/walker_method/version.rb

@@ -0,0 +1,3 @@
+class WalkerMethod
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'walker_method'
+
+RSpec.configure do |config|
+end

data/spec/walker_method_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+describe WalkerMethod do
+  it "should work with two arrays" do
+    sampler = WalkerMethod.new(%w[hello world], [8, 2])
+    samples = Hash.new(0.0)
+    10_000.times do
+      samples[sampler.random] += 1
+    end
+    (samples["hello"] / samples["world"]).should be_within(0.2).of(4.0)
+  end
+end

data/walker_method.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'walker_method/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "walker_method"
+  gem.version       = WalkerMethod::VERSION
+  gem.authors       = ["Andrew Cantino"]
+  gem.email         = ["cantino@gmail.com"]
+  gem.description   = %q{Ruby implementation of Walker's Alias Method for quickly sampling objects with a given probability distribution}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/cantino/walker_method"
+
+  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.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: walker_method
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Cantino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies: []
+description: Ruby implementation of Walker's Alias Method for quickly sampling objects
+  with a given probability distribution
+email:
+- cantino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/walker_method.rb
+- lib/walker_method/version.rb
+- spec/spec_helper.rb
+- spec/walker_method_spec.rb
+- walker_method.gemspec
+homepage: https://github.com/cantino/walker_method
+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.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/spec_helper.rb
+- spec/walker_method_spec.rb