enumerable_weighted_sample 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1caa11ffaa50b63e7149ca09a7f9f2c245c74e81
+  data.tar.gz: c35fd8bf89eacdd1174a19ec0a3cea0ac3083888
+SHA512:
+  metadata.gz: 2953706bd28fb4913a847739a9a374e97e4a5a60b4c31874e808c7be9849c8429667e0c6b22df14815ce30e234c9c4ea0f27625b599e348f392688e74b41b3b7
+  data.tar.gz: e1cd1bbde8c3dbb804bc7c4d2c52e7b7f705d77fb401e96230624803f932648032b7f07e329aa9162c586bae0bbf463dcd3a5bad0191eb0d3a7ecb8987b5a079

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Christine Oen
+
+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,85 @@
+# EnumerableWeightedSample
+
+This gem provides access to functions that will produce a random sample based on weights calculated from a given block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumerable_weighted_sample'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerable_weighted_sample
+
+## Usage
+
+Provides access to the following functions:
+```ruby
+
+  # Produce a weighted random sampling based on the weights calculated from a
+  # given block. The weight function must produce positive real numbers.
+  # For more, see Ruby Enumerable#max_by and Efraimidis & Spirakis (2005)
+  # http://ruby-doc.org/core-2.2.1/Enumerable.html#method-i-max_by
+  # http://utopia.duth.gr/~pefraimi/research/data/2007EncOfAlg.pdf
+  #
+  # Parameters
+  #  - count: The number of samples to return. If not provided, will return a
+  #           single sample. Else if specified returns an array of that length.
+  #  - block: Function for retrieving the absolute weight of each object.
+  #
+  # Returns a single item if count is not provided, else an array of samples.
+  def weighted_sample_by(count=nil)
+    wraw = each_with_object({}) { |obj, h| h[obj] = yield(obj) }
+    wsum = wraw.values.inject(&:+)
+    weights = wraw.keys.each_with_object({}) { |obj, h| h[obj] = Float(wraw[obj]) / wsum }
+    results = (count || 1).times.map do
+      weights.max_by { |_obj, weight| rand ** (1.0 / weight) }.first
+    end
+    count.nil? ? results.first : results
+  end
+
+  # Variation to invert the weights. Inverting is a bit subjective. I've gone
+  # with a formula that calculates the difference from the original maximum. In
+  # addition, I'm also adding a constant so that the max retains a nonzero
+  # adjusted weight, and items with perfectly equal input weights converge on
+  # equal final probability.
+  def inverse_weighted_sample_by(count=nil)
+    wraw = each_with_object({}) { |obj, h| h[obj] = yield(obj) }
+    wmax = wraw.values.max
+    weights = {}
+    wraw.keys.each { |obj| weights[obj] = wmax - wraw[obj] + 1 }
+    weighted_sample_by(count) { |obj| weights[obj] }
+  end
+
+  # Weighted sample sugar for objects that respond to #weight
+  def weighted_sample(count=nil)
+    weighted_sample_by(count) { |obj| obj.weight }
+  end
+
+  # Inverse weighted sample sugar for objects that respond to #weight
+  def inverse_weighted_sample(count=nil)
+    inverse_weighted_sample_by(count) { |obj| obj.weight }
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/enumerable_weighted_sample.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enumerable_weighted_sample"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/enumerable_weighted_sample.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumerable_weighted_sample/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enumerable_weighted_sample"
+  spec.version       = EnumerableWeightedSample::VERSION
+  spec.authors       = ["Christine Oen"]
+  spec.email         = ["oen.christine@gmail.com"]
+
+  spec.summary       = %q{Produce a weighted random sampling based on the weights calculated from a given block.}
+  spec.homepage      = "https://github.com/omc/enumerable-weighted-sample"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/enumerable_weighted_sample/version.rb

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

data/lib/enumerable_weighted_sample.rb

@@ -0,0 +1,117 @@
+require "enumerable_weighted_sample/version"
+
+module EnumerableWeightedSample
+
+  # Produce a weighted random sampling based on the weights calculated from a
+  # given block. The weight function must produce positive real numbers.
+  # For more, see Ruby Enumerable#max_by and Efraimidis & Spirakis (2005)
+  # http://ruby-doc.org/core-2.2.1/Enumerable.html#method-i-max_by
+  # http://utopia.duth.gr/~pefraimi/research/data/2007EncOfAlg.pdf
+  #
+  # Parameters
+  #  - count: The number of samples to return. If not provided, will return a
+  #           single sample. Else if specified returns an array of that length.
+  #  - block: Function for retrieving the absolute weight of each object.
+  #
+  # Returns a single item if count is not provided, else an array of samples.
+  def weighted_sample_by(count=nil)
+    wraw = each_with_object({}) { |obj, h| h[obj] = yield(obj) }
+    wsum = wraw.values.inject(&:+)
+    weights = wraw.keys.each_with_object({}) { |obj, h| h[obj] = Float(wraw[obj]) / wsum }
+    results = (count || 1).times.map do
+      weights.max_by { |_obj, weight| rand ** (1.0 / weight) }.first
+    end
+    count.nil? ? results.first : results
+  end
+
+  # Variation to invert the weights. Inverting is a bit subjective. I've gone
+  # with a formula that calculates the difference from the original maximum. In
+  # addition, I'm also adding a constant so that the max retains a nonzero
+  # adjusted weight, and items with perfectly equal input weights converge on
+  # equal final probability.
+  def inverse_weighted_sample_by(count=nil)
+    wraw = each_with_object({}) { |obj, h| h[obj] = yield(obj) }
+    wmax = wraw.values.max
+    weights = {}
+    wraw.keys.each { |obj| weights[obj] = wmax - wraw[obj] + 1 }
+    weighted_sample_by(count) { |obj| weights[obj] }
+  end
+
+  # Weighted sample sugar for objects that respond to #weight
+  def weighted_sample(count=nil)
+    weighted_sample_by(count) { |obj| obj.weight }
+  end
+
+  # Inverse weighted sample sugar for objects that respond to #weight
+  def inverse_weighted_sample(count=nil)
+    inverse_weighted_sample_by(count) { |obj| obj.weight }
+  end
+
+end
+
+
+# Run this file directly for some quick and dirty inline testing
+if $0 == __FILE__
+
+  class Array
+    def summarize
+      each_with_object(Hash.new(0)){|foo,h| h[foo] += 1 }.pretty
+    end
+    def pretty
+      map(&:inspect).join(", ")
+    end
+  end
+
+  class Hash
+    def pretty
+      sort_by{|_k,v|v}.map{|k,v| "#{k}: #{v}" }.join(", ")
+    end
+  end
+
+  class Foo
+    attr_accessor :name, :weight
+    def initialize(name, weight)
+      self.name = name
+      self.weight = weight
+    end
+    def to_s
+      name
+    end
+    def inspect
+      "#{name}: #{weight}"
+    end
+  end
+
+  SAMPLES = 1_000
+
+  things = [
+    Foo.new("foo",   1),
+    Foo.new("bar",   2),
+    Foo.new("baz", 199),
+    Foo.new("bat", 198)
+  ]
+
+  # puts things.inverse_weighted_sample(100).summarize
+
+  puts "input weights:"
+  puts things.pretty
+  puts
+
+  puts "#{SAMPLES}x weighted samples:"
+  weighted_things = things.weighted_sample(SAMPLES)
+  puts weighted_things.map(&:name).summarize
+  puts
+
+  puts "#{SAMPLES}x inverse weighted samples:"
+  inverse_weighted_things = things.inverse_weighted_sample(SAMPLES)
+  puts inverse_weighted_things.map(&:name).summarize
+  puts
+
+  puts "#{SAMPLES}x iterative rebalance:"
+  SAMPLES.times do
+    things.weighted_sample.weight -= 1
+    things.inverse_weighted_sample.weight += 1
+  end
+  puts things.pretty
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: enumerable_weighted_sample
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christine Oen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- oen.christine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enumerable_weighted_sample.gemspec
+- lib/enumerable_weighted_sample.rb
+- lib/enumerable_weighted_sample/version.rb
+homepage: https://github.com/omc/enumerable-weighted-sample
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Produce a weighted random sampling based on the weights calculated from a
+  given block.
+test_files: []