loaded_die 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 362b5a5dc03dcbf3580aeb5501c964cb273a183ce9ab3763bc9840288f4e4b95
+  data.tar.gz: e5e901d9a0611c2579d33595569658d112736f89714655db4b161349c5f00d24
+SHA512:
+  metadata.gz: 5510423a7c21354514d3a035f77b7c518d2ed563ac315dc1d1ebba6f10459201416a5ed427cadb9c78c957a94a591a9766c75dabe8b15ca96911e8aed413350b
+  data.tar.gz: 5d8ccf6c0f9713cf6e1d3bf1b45ba63d7c026d7e41523e0c61211163815173cdeff20341b5c4518350674ecc0f67565de16f29dd1f063a7dc2d347e9084c01f7

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2018 Aaron Beckerman
+
+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.rdoc

@@ -0,0 +1,57 @@
+= Loaded Die
+
+Loaded Die is a Ruby library that makes it easy to randomly choose from a set
+of options when some options are more likely than others.
+
+
+== Usage
+
+This is the basic pattern: First, you load the library. Then you create an
+instance of LoadedDie::Sampler and send the "sample" message to it as many
+times as you like.
+
+Let's say you want to choose randomly from three strings: "A", "B", and "C".
+You want "A" and "B" to be equally likely, and "C" to be twice as likely as one
+of them. That means "A" should be 25% likely, B should be 25% likely, and C
+should be 50% likely.
+
+You can create your sampler like this:
+
+  require 'loaded_die'
+  sampler = LoadedDie::Sampler.new('A' => 0.25, 'B' => 0.25, 'C' => 0.5)
+
+And then sample from it like this:
+
+  sampler.sample
+
+But you don't have to be fussy about how you represent probabilities. That is,
+you don't need to represent them as numbers between 0 and 1 such that they sum
+up to 1. Their relative values are what matter. So you could also create your
+sampler like this:
+
+  sampler = LoadedDie::Sampler.new('A' => 1, 'B' => 1, 'C' => 2)
+
+You can specify the random number generator that sample uses. To do this,
+supply as the argument a hash with your random number generator under the
+:random key. (This is based on the behavior of Ruby's Array#sample.) Your
+random number generator will be sent the "rand" message with one argument, the
+sum of the weights you specified when creating the sampler. The return value
+must be a number greater than or equal to zero and less than the sum of the
+weights.
+
+  rng = Object.new
+  def rng.rand(n)
+    0
+  end
+  sampler.sample(:random => rng)
+
+
+== Author
+
+This was written by Aaron Beckerman.
+
+
+== Copyright
+
+This code is distributed under the MIT License (also known as the Expat
+License). See the LICENSE.txt file for details.

data/lib/loaded_die.rb

@@ -0,0 +1,52 @@
+module LoadedDie
+  VERSION = '1.0.1'
+
+  class Sampler
+    DEFAULT_RNG = ::Object.new
+    def DEFAULT_RNG.rand(n)
+      ::Kernel.rand * n
+    end
+
+    Segment = ::Struct.new(:maximum, :individual)
+
+    def initialize(population)
+      @compiled = population.inject [] do |accum, (individual, weight)|
+        if weight <= 0
+          raise ::ArgumentError, "non-positive weight #{weight}"
+        end
+        prev_max =
+          if last = accum.last
+            last.maximum
+          else
+            0
+          end
+        accum << Segment.new(prev_max + weight, individual)
+      end
+      nil
+    end
+
+    def length
+      if last = @compiled.last
+        last.maximum
+      else
+        0
+      end
+    end
+
+    def [](point)
+      if point < 0
+        nil
+      elsif choice = @compiled.detect { |segment| point < segment.maximum }
+        choice.individual
+      else
+        nil
+      end
+    end
+
+    def sample(options = {})
+      rng = options.fetch(:random) { DEFAULT_RNG }
+      point = rng.rand(length)
+      self[point]
+    end
+  end
+end

data/loaded_die.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "loaded_die"
+
+Gem::Specification.new do |s|
+  s.name = "loaded_die"
+  s.version = LoadedDie::VERSION
+  s.author = "Aaron Beckerman"
+  s.summary = %q{A library for choosing randomly when some options are more likely than others.}
+  s.description = %q{Loaded Die makes it easy to choose randomly when some options are more likely than others.}
+  s.license = "MIT"
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 1.8.7"
+  s.files = ["LICENSE.txt", "README.rdoc", "loaded_die.gemspec", "lib/loaded_die.rb", "test/loaded_die_test.rb"]
+  s.test_files = ["test/loaded_die_test.rb"]
+  s.executables = []
+  s.require_paths = ["lib"]
+end

data/test/loaded_die_test.rb

@@ -0,0 +1,71 @@
+require 'loaded_die'
+
+String == LoadedDie::VERSION.class or fail
+
+Module == LoadedDie.class or fail
+
+Class == LoadedDie::Sampler.class or fail
+
+begin
+  LoadedDie::Sampler.new(:a => 0)
+rescue ArgumentError
+else
+  fail
+end
+
+begin
+  LoadedDie::Sampler.new(:a => -1)
+rescue ArgumentError
+else
+  fail
+end
+
+lambda do
+  sampler = LoadedDie::Sampler.new({})
+  sampler.respond_to?(:length) or fail
+  sampler.respond_to?(:[]) or fail
+  sampler.respond_to?(:sample) or fail
+end.call
+
+lambda do
+  0 == LoadedDie::Sampler.new({}).length or fail
+  2 == LoadedDie::Sampler.new({ :a => 2 }).length or fail
+  (2 + 3.1) == LoadedDie::Sampler.new({ :a => 2, :b => 3.1 }).length or fail
+end.call
+
+lambda do
+  sampler = LoadedDie::Sampler.new({})
+  nil == sampler[0.42] or fail
+end.call
+
+lambda do
+  sampler = LoadedDie::Sampler.new([[:a, 3], [:b, 2.0], [:c, 5]])
+  nil == sampler[-1.0] or fail
+  :a == sampler[0.0] or fail
+  :a == sampler[2.99] or fail
+  :b == sampler[3] or fail
+  :b == sampler[3.0] or fail
+  :b == sampler[4.99] or fail
+  :c == sampler[5.0] or fail
+  :c == sampler[9.99] or fail
+  nil == sampler[10.0] or fail
+  nil == sampler[11.0] or fail
+end.call
+
+lambda do
+  sampler = LoadedDie::Sampler.new({})
+  nil == sampler.sample or fail
+end.call
+
+lambda do
+  sampler = LoadedDie::Sampler.new([[:a, 3], [:b, 2.0], [:c, 9001]])
+  rng = Object.new
+  def rng.rand(n)
+    (3 + 2.0 + 9001) == n or fail
+    4.99
+  end
+  :b == sampler.sample(:random => rng) or fail
+  [:a, :b, :c].include?(sampler.sample) or fail
+end.call
+
+puts 'Test finished.'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: loaded_die
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Aaron Beckerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-31 00:00:00.000000000 Z
+dependencies: []
+description: Loaded Die makes it easy to choose randomly when some options are more
+  likely than others.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.rdoc
+- lib/loaded_die.rb
+- loaded_die.gemspec
+- test/loaded_die_test.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A library for choosing randomly when some options are more likely than others.
+test_files:
+- test/loaded_die_test.rb