weighted_list 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925e9f3a1fba2c35de1dd9825b28702353798b5a4cbdf63e603fab141926577d
-  data.tar.gz: cc4b917a7322de3eeddc18f00910d432d731bc24957a52bce4041a6f17ee996a
+  metadata.gz: deccd69f64bb1d8425b9f5c4ccecf01e9e567cd21cbbde7a0152001cfe33ab39
+  data.tar.gz: 326bb826fcd77d551084ddf77addf7b78710d3e82236684ddb5cb1a29d40eb09
 SHA512:
-  metadata.gz: cefce48130c7db1b3d7a8f2c1b167f5e49ffbad70a7133142f1e70a41ec70326536ad71b1efc4d27f7716330af33af704e57e427f073fb2f268e1faa8ab7bab0
-  data.tar.gz: 3ae2f07dbdf47e3a41d5f31453b242ec0a5bc0cb4596f240aa7ed27e74a81296a236af31337299fb9f48fa8c87c910339b12052f1f201827cc3c9e83bc910831
+  metadata.gz: 93138c4eca3022ec6eea9f299a23b7eaa55d4f79fad3d989e03907db748709703fe7a12dba7ccde3785c25756b39e482d50d1704b77b615277980d30f6581476
+  data.tar.gz: 3d915f260d8cdff3cc23d703f6bfea37e5289316f9e113b663baffbbc6b7fa67d8c4df341075e308a21f3699fc0f9e5c6bef8da25675ac25f52fa1faaf934e68

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weighted_list (0.3.0)
+    weighted_list (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -26,22 +26,30 @@ Or install it yourself as:
 
 ## Usage
 ```ruby
-hash = { eastern: 150, central: 92, mountain: 21, pacific: 53 }
-list = WeightedList[hash]
+collection = { eastern: 150, central: 92, mountain: 21, pacific: 53 }
+# This works too:
+# collection = [[:eastern, 150], [:central, 92], [:mountain, 21], [:pacific, 53]]
+list = WeightedList[collection]
 
+# If you are familiar with Array#sample, none of this will surprise you:
 list.sample # => :pacific
 list.sample(1) # => [:central]
 list.sample(3) # => [:central, :eastern, :pacific]
 list.sample(100) # => [:central, :eastern, :pacific, :mountain]
 
+# It acts like a proper Ruby collection should:
 list.map(&:to_s).map(&:capitalize).sort.join(', ') # => "Central, Eastern, Mountain, Pacific"
 
+# For when you'd like to provide your own entropy or cleanly test deterministically.
 class CustomRandomizer
   def rand(n)
     1.0
   end
 end
 list.sample(2, random: CustomRandomizer.new) # => [:eastern, :central]
+
+# If you want to allow repeats:
+list.sample(4, with_replacement: true) # => [:eastern, :mountain, :eastern, :eastern]
 ```
 
 ## Development

data/lib/weighted_list.rb

@@ -12,21 +12,20 @@ class WeightedList
   end
 
   def initialize(collection)
-    @hash = Normalizer.call(collection)
+    @hash = Normalizer.call(collection.clone)
   end
 
   def each(&block)
     hash.keys.each(&block)
   end
 
-  def sample(quantity = nil, random: Random)
-    @random = random
-    return single_item unless quantity
-    (0...quantity).each_with_object(initial_memo) do |_index, memo|
-      result = Sampler.new(memo[:current_list], random: random).call
-      memo[:chosen].push(result.chosen)
-      memo[:current_list] = result.remaining
-    end[:chosen].compact
+  def sample(quantity = nil, random: Random, with_replacement: false)
+    return select_item(hash, random: random).selected unless quantity
+    quantity.times.each_with_object(initial_memo) do |_index, memo|
+      result = select_item(memo[:current_list], random: random)
+      memo[:selected].push(result.selected)
+      memo[:current_list] = (with_replacement ? hash : result.remaining)
+    end[:selected].compact
   end
 
   private
@@ -34,10 +33,10 @@ class WeightedList
   attr_reader :hash, :random
 
   def initial_memo
-    { chosen: [], current_list: hash }
+    { selected: [], current_list: hash }
   end
 
-  def single_item
-    Sampler.new(hash, random: random).call.chosen
+  def select_item(list, random:)
+    Sampler.new(hash: list, random: random).call
   end
 end

data/lib/weighted_list/normalizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class WeightedList
   class Normalizer
     def self.call(collection)

data/lib/weighted_list/sampler.rb

@@ -2,22 +2,22 @@
 
 class WeightedList
   class Sampler
-    def initialize(hash, random: Random)
-      @hash = hash.clone
+    def initialize(hash:, random:)
+      @hash = hash
       @random = random
     end
 
     def call
-      Result.new(chosen, remaining)
+      Result.new(selected, remaining)
     end
 
     private
 
     attr_reader :hash, :random
 
-    Result = Struct.new(:chosen, :remaining)
+    Result = Struct.new(:selected, :remaining)
 
-    def choose
+    def select
       return if hash.empty?
       current_target = random.rand(total_weight)
 
@@ -27,12 +27,12 @@ class WeightedList
       end
     end
 
-    def chosen
-      @chosen ||= choose
+    def selected
+      @selected ||= select
     end
 
     def remaining
-      hash.reject { |item, _weight| chosen == item }
+      hash.reject { |item, _weight| selected == item }
     end
 
     def total_weight

data/lib/weighted_list/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class WeightedList
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/weighted_list.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['jayson.virissimo@asu.edu']
 
   spec.summary       = 'Sample from a weighted list.'
-  spec.description   = 'Sample from an (enumerable) weighted list without replacement.'
+  spec.description   = 'Randomly sample from an (enumerable) weighted list without replacement.'
   spec.homepage      = 'https://github.com/jaysonvirissimo/weighted_list'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weighted_list
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jayson Virissimo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2018-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Sample from an (enumerable) weighted list without replacement.
+description: Randomly sample from an (enumerable) weighted list without replacement.
 email:
 - jayson.virissimo@asu.edu
 executables: []