weighted_shuffle 0.1.0 → 0.2.0

data/.gitignore

@@ -3,3 +3,5 @@ pkg/
 bin/
 .bundle/
 coverage/
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -2,13 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - ruby-head
   - jruby-19mode
-  - jruby-head
-  - rbx-19mode
-  - rbx-head
+  - rbx-2.1.1
 script: bundle exec rspec
-matrix:
-  allow_failures:
-    - rvm: rbx-19mode
-    - rvm: rbx-head

data/README.md

@@ -39,6 +39,10 @@ integrated into ruby Array:
     array.weighted_shuffle
     => [:b, :a]
 
+or with factor
+
+    array.weighted_shuffle factor: 3
+
 ## Contributing
 
 1. Fork it

data/lib/weighted_shuffle/core_ext/array/weighted_shuffle.rb

@@ -1,6 +1,6 @@
 class Array
 
-  def weighted_shuffle
-    WeightedShuffle::Dealer.new(self).weighted_shuffle
+  def weighted_shuffle(options = {})
+    WeightedShuffle::Dealer.new(self).weighted_shuffle options
   end
 end

data/lib/weighted_shuffle/dealer.rb

@@ -3,13 +3,17 @@ require 'active_support/core_ext/enumerable'
 module WeightedShuffle
   class Dealer < Struct.new(:array)
 
-    def weighted_shuffle
+    def weighted_shuffle(options = {})
+      factor = options.delete(:factor)
       a = Marshal.load Marshal.dump(array)
-      sum = a.sum { |k,v| v || 0.0 }
+      unless factor.nil?
+        a.map! { |k, v| [k, v**factor] }
+      end
+      sum = a.sum { |k, v| v || 0.0 }
       b = []
       a.length.times do
         random = SecureRandom.random_number * sum
-        a.each_with_index do |(k,v),j|
+        a.each_with_index do |(k, v), j|
           if random <= v
             b << a.delete_at(j).first
             sum -= v

data/lib/weighted_shuffle/version.rb

@@ -1,4 +1,4 @@
 module WeightedShuffle
   # weighted_shuffle version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/weighted_shuffle/dealer_spec.rb

@@ -3,33 +3,63 @@ require 'spec_helper'
 module WeightedShuffle
   describe Dealer do
     describe '#weighted_shuffle' do
-      [[ [[:a, 1], [:b, 2]], [:a, :b] ],
-       [ [[1, 1], [2, 3]], [1, 2] ],
-       [ [[2.0, 1], [:a, 1.5], ['a', 2.3]], [2.0, :a, 'a'] ]]
-        .each do |input, output|
-
-        it "returns a permutation of #{output} given #{input}" do
-          output.permutation.to_a.should include(
-            Dealer.new(input).weighted_shuffle)
+
+      context 'without factor' do
+        [[ [[:a, 1], [:b, 2]], [:a, :b] ],
+          [ [[1, 1], [2, 3]], [1, 2] ],
+          [ [[1, 1], [2, 0]], [1, 2] ],
+          [ [[1, 1], [2, 0], [3, 0]], [1, 2, 3] ],
+          [ [[2.0, 1], [:a, 1.5], ['a', 2.3]], [2.0, :a, 'a'] ]]
+          .each do |input, output|
+
+          it "returns a permutation of #{output} given #{input}" do
+            expect(output.permutation.to_a).to include(
+              Dealer.new(input).weighted_shuffle)
+          end
+
+          it 'gives correct relative frequency for first position' do
+            weights = input.map(&:last)
+            # calculate probabiities
+            sum = weights.sum
+            probabilities = weights.map { |weight| weight.to_f / sum }
+
+            # establish frequencies
+            size = 1000
+            samples = size.times.map { Dealer.new(input).weighted_shuffle }
+            frequencies = input.map(&:first).map do |e|
+              samples.select { |s| s.first == e }.count.to_f / size
+            end
+
+            # calculate sum of absolute values of differences
+            diff = probabilities.zip(frequencies).map { |p,f| (p - f).abs }.sum
+            expect(diff).to be < 0.1
+          end
         end
+      end
 
-        it 'gives correct relative frequency for first position' do
-          weights = input.map(&:last)
-          # calculate probabiities
-          sum = weights.sum
-          probabilities = weights.map { |e| e.to_f / sum }
+      context 'with factor' do
 
-          # establish frequencies
+        it 'big factor has a big impact' do
+          input = [[1, 1], [2, 1], [3, 1.01]]
+          samples = 10_000.times.map do
+            Dealer.new(input).weighted_shuffle factor: 100_000
+          end
+          expect(samples.map(&:first).count(3)).to eq(samples.size)
+        end
+
+        it 'gives expected relative frequency ' do
+          input = [[:a, 1], [:b, 2]]
           size = 1000
-          sample = size.times.map { Dealer.new(input).weighted_shuffle }
-          frequencies = input.map(&:first)
-            .map do |e|
-              sample.select { |s| s.first == e }.count.to_f / size
-            end
+          samples = size.times.map do
+            Dealer.new(input).weighted_shuffle factor: 2
+          end
+          frequencies = input.map(&:first).map do |e|
+            samples.select { |sample| sample.first == e }.count.to_f / size
+          end
 
-          # calculate sum of absolute values of differences
-          diff = probabilities.zip(frequencies).map { |p,f| (p - f).abs }.sum
-          diff.should < 0.1
+          diff = [1.0 / 5, 4.0 / 5].zip(frequencies).map { |p, f| (p - f).abs }
+            .sum
+          expect(diff).to be < 0.1
         end
       end
     end

data/weighted_shuffle.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.version       = WeightedShuffle::VERSION
   gem.summary       = %q{Fisher-Yates-Shuffle algorithm with weight support}
   gem.description   = <<-EOF
-  An extension to the Fisher-Yates-Shuffle algorithm to support weights.  It
+  An extension to the Fisher-Yates-Shuffle algorithm to support weights. It
   includes a ruby core extension for arrays.
   EOF
   gem.license       = "MIT"
@@ -26,4 +26,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  if ENV['RUBY_VERSION'] =~ /rbx/
+    gem.add_dependency 'rubysl'
+    gem.add_development_dependency 'rubinius-coverage'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weighted_shuffle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 description: ! "  An extension to the Fisher-Yates-Shuffle algorithm to support weights.
-  \ It\n  includes a ruby core extension for arrays.\n"
+  It\n  includes a ruby core extension for arrays.\n"
 email: frank.eckert@boost-project.com
 executables: []
 extensions: []
@@ -103,7 +103,6 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -136,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Fisher-Yates-Shuffle algorithm with weight support

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    weighted_shuffle (0.1.0)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    colorize (0.5.8)
-    coveralls (0.6.7)
-      colorize
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      thor
-    diff-lcs (1.2.4)
-    i18n (0.6.1)
-    mime-types (1.23)
-    multi_json (1.7.6)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    rubygems-tasks (0.2.4)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    thor (0.18.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  coveralls
-  rspec (~> 2.4)
-  rubygems-tasks (~> 0.2)
-  simplecov
-  weighted_shuffle!