weighted-selection 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47780d3e6fcb74e347d8ed950eee0ff5851ee1f9
+  data.tar.gz: b49111c74cf339346a86ec4d0d233d6bb07e9ad8
+SHA512:
+  metadata.gz: 690c3c510fd6193584ec9e1b27cca8b1a6a1b5103430cc5b1308a8056bb657b83c58087f02e064af18960a7f8a374a58198434de50699f683104135c04525c8d
+  data.tar.gz: 788ac75dd719eddf67084d811090d352f24cd5f0391018572da95af563e1c7491e2e5fb616812a36fea6c1fd7989f4563c4b471ef60db5a0e5af7ec55491fc89

data/LICENSE

@@ -0,0 +1,25 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>
+

data/README.md

@@ -0,0 +1,51 @@
+# Weighted selection
+
+Simple weighted selection of items
+
+## Installation
+Install [RAKE](https://rubygems.org/gems/weighted-selection) via RubyGem:
+
+```
+gem install weighted-selection
+```
+
+## Usage
+
+Import the library and create a new instance
+
+```
+require 'weighted_selection'
+sel = WeightedSelection::Engine.new
+```
+
+## Add items
+
+Add single items to the selecter
+
+```
+sel.add_item(WeightedSelection::Item.new('Item 1', 25)
+sel.add_item(WeightedSelection::Item.new('Item 2', 25)
+```
+
+Or multiple at once
+
+```
+sel.add_items([
+    WeightedSelection::Item.new('Item 3', 25),
+    WeightedSelection::Item.new('Item 4', 25)
+])
+```
+
+## Fetch a sample
+
+Fetch a sample based on the item's weights
+
+```
+sel.select
+```
+
+Or multiple at once
+
+```
+sel.multiple(100)
+```

data/lib/weighted_selection.rb

@@ -0,0 +1,3 @@
+require_relative 'weighted_selection/version'
+require_relative 'weighted_selection/engine'
+require_relative 'weighted_selection/item'

data/lib/weighted_selection/engine.rb

@@ -0,0 +1,43 @@
+module WeightedSelection
+  class Engine
+    def initialize
+      @items = []
+    end
+    def add_item(item)
+      @items.push(item)
+    end
+    def add_items(items)
+      items.each { |item| add_item(item) }
+    end
+    def sample
+      # Hold the weight sum
+      sum = 0
+
+      # Go through the items
+      @items.each { |item| sum += item.weight > 0 ? item.weight : 1 }
+
+      # Get random check-value
+      check = rand(sum)
+
+      # Loop items, again
+      @items.each do |item|
+        check -= item.weight
+        if check <= 0
+          return item
+        end
+      end
+
+      # Select an item at random
+      return items.sample
+    end
+    def multiple(count)
+      output = []
+      for i in 0..count
+        output.push(sample)
+      end
+      return output
+    end
+
+    attr_reader :items
+  end
+end

data/lib/weighted_selection/item.rb

@@ -0,0 +1,9 @@
+module WeightedSelection
+  class Item
+    def initialize(weight, value)
+      @weight = weight
+      @value = value
+    end
+    attr_reader :weight, :value
+  end
+end

data/lib/weighted_selection/version.rb

@@ -0,0 +1,3 @@
+module WeightedSelection
+  VERSION = '1.0.0'
+end

data/test/test_weighted_selection.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'weighted_selection'
+
+class WeightedSelectionTest < MiniTest::Unit::TestCase
+  def test_add_items
+    sel = WeightedSelection::Engine.new
+    sel.add_items([
+                           WeightedSelection::Item.new(50, 'Item 1'),
+                           WeightedSelection::Item.new(50, 'Item 2')
+                       ])
+
+    assert_equal(sel.items.length, 2)
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: weighted-selection
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Felix Lindström
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies: []
+description: Simple, weighted selection of items.
+email:
+- felix.lindstrom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/weighted_selection/engine.rb
+- lib/weighted_selection/item.rb
+- lib/weighted_selection/version.rb
+- lib/weighted_selection.rb
+- test/test_weighted_selection.rb
+homepage: https://github.com/felixlindstrom/weighted-selection
+licenses: []
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple, weighted selection of items.
+test_files:
+- test/test_weighted_selection.rb