weighted_sampler 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484d62fd78bfc61f3f7955dba454d3ebbbe836ca2f05d6cf62c4a8b347b17760
-  data.tar.gz: 744ec53a149444fb29f0ea5a7b4399848726d361bfca04ad9cd710bb7a61fe68
+  metadata.gz: 158c6fdf6276d125dceac092e5d11517f69145f1d729eeffadb253839abe3ea5
+  data.tar.gz: 6b292492376053962087caa4df673926c038ac9825cc6738a13c9343ead610d6
 SHA512:
-  metadata.gz: '0818c61256774eebbc72865028b4ba6e975d044a72f669f5120da8cbddb776d06af5534be4ca5d23c2329792a01bde97155b6e617eadfe2ff0115dbe13c16714'
-  data.tar.gz: d9d0b7efa00aa2f95bc6a54e8c018e6d7c5a70a9bfaf9935fe7b3c03959b15bfa028fce0810e8b1cca3b6c774061266cc3dfb48078f3320f51bc4aec781f50dc
+  metadata.gz: 306c3bff850c31a4c1ece1a4a58e4f9fd3f88206ebfd27041b65fc4338123148bf7cca0bfcaf1fe141cef08d67ee902c0e534857f45be482ffff79591b143297
+  data.tar.gz: 29834db848343e4fc07b57540ca64dd85bd2fb36a2443f1d6b7b42b4f7415ebd85dcf5f95106b19cfb9549fced2d0460117823331e280f0659358f2c197b7593

data/README.md

@@ -110,20 +110,44 @@ Please, note that if `seed` is not provided, sampler will use generic `rand` fun
 
 ### Performance
 
+Once initialized, solution complexity is `O(n)`. [`Array#index`](https://ruby-doc.org/core/Array.html#method-i-index) is used to find a `rand` match to intervals (see [Math](#Math) section below).
+
+### Math
+
+Consider normalized probabilities `P0, P1, .., Pn, 𝚺Pi = 1, 0 <= i <= n`
+
+To select random index `i` with these probabilities we convert them into half-open intervals `[0, P0)`, `[P0, P1)`, `[P0+P1, P2)` ... `[𝚺Pi, 1), 0 <= i < n` and place on a half-open interval `[0, 1)`
+
+```
+[<- P1 ->)[<-  P2  ->)    ...         [<-   Pn   ->)
+[--------------------------------------------------)
+0                   ^- rand (sample pick)          1
+```
+
+As you can see any random value from `[0, 1)` will hit into one of the half-open intervals with probability equal to the "length" of the interval
+
+`rand` (seeded or not) will does exactly what is needed and returns a value in the same half-open interval `[0, 1)`
+
+*NOTE about Terminilogy and beauty in Ruby:* in ruby [Range](https://ruby-doc.org/core/Range.html) class with `...`   definition is equivalent to [half-open interval in the end](https://en.wikipedia.org/wiki/Interval_(mathematics)#Terminology) (i.e. `[0...1]` in Ruby is `[0, 1)` in math
+
+*NOTE about precision and computer algebra ugliness:* in programming we cannot be sure that `𝚺Pi` will end up exactly equivalent to 1. And I do not like idea to use Ruby's [Rational](https://ruby-doc.org/core/Rational.html) due to performance implications and not much benefitss here
+
+That's why `ERROR_ALLOWANCE = 10**-8` is accepted in normalization logic in WeightedSampler
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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).
+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://gitlab.com/[USERNAME]/weighted_sampler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/[USERNAME]/weighted_sampler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT)
 
 ## Code of Conduct
 
-Everyone interacting in the WeightedSampler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/weighted_sampler/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the WeightedSampler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/weighted_sampler/blob/master/CODE_OF_CONDUCT.md)

data/lib/weighted_sampler.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'weighted_sampler/version'
-require 'pry'
 module WeightedSampler
 
   # sum of floats are never stable enough to guarantee exact equality to 1

data/lib/weighted_sampler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WeightedSampler
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weighted_sampler
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Oleksiy Babich
@@ -53,30 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: "\n    Weighted Sampler helps you to pick a random samples from a collection
-  with defined probabilities or weights\n\n    You can pass an Array or a Hash with
-  desired probabilities\n    and use Module or Class API to pick samples\n  "
+  with defined probabilities or weights.\n    You can pass an Array or a Hash with
+  desired probabilities\n    and use Module or Class API to pick samples.\n\n    Please,
+  see documentation in the repo https://gitlab.com/alexey_b/weighted_sampler\n  "
 email:
 - oleksiy@oleksiy.od.ua
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/weighted_sampler.rb
 - lib/weighted_sampler/version.rb
-- weighted_sampler.gemspec
 homepage: https://gitlab.com/alexey_b/weighted_sampler
 licenses:
 - MIT

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-*.gem

data/.gitlab-ci.yml

@@ -1,23 +0,0 @@
-image: ruby
-
-stages:
-  - test
-
-before_script:
-  - bundle install
-
-ruby2.3:
-  image: ruby:2.3.7
-  script: rspec
-
-ruby2.4:
-  image: ruby:2.4.4
-  script: rspec
-
-ruby2.5:
-  image: ruby:2.5.1
-  script: rspec
-
-ruby2.6-rc:
-  image: ruby:2.6.0-preview2
-  script: rspec

data/.rspec

@@ -1,3 +0,0 @@
---format progress
---color
---require spec_helper

data/.rubocop.yml

@@ -1,60 +0,0 @@
-AllCops:
-  Exclude:
-    - tmp/**/*
-
-Rails:
-  Enabled: true
-
-# We prefer having assignments inside if-s
-Lint/AssignmentInCondition:
-  Enabled: false
-
-# Longer lines is awesome
-Metrics/LineLength:
-  Max: 160
-
-# Having every class documented is too much
-Style/Documentation:
-  Enabled: false
-
-# We do love empty lines
-Layout/EmptyLines:
-  Enabled: false
-
-Layout/EmptyLinesAroundArguments:
-  Enabled: false
-
-Layout/EmptyLinesAroundClassBody:
-  Enabled: false
-
-Layout/EmptyLinesAroundBlockBody:
-  Enabled: false
-
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-# We do love complex code
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-# This is AR-only cop
-Rails/FindEach:
-  Enabled: false
-
-Rails/CreateTableWithTimestamps:
-  Enabled: false

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-script:
-  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at Alexey_Babich2@comcast.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gem 'pry-byebug'
-gem 'simplecov'
-
-# Specify your gem's dependencies in weighted_sampler.gemspec
-gemspec

data/Gemfile.lock

@@ -1,53 +0,0 @@
-PATH
-  remote: .
-  specs:
-    weighted_sampler (1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (10.0.2)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    json (2.1.0)
-    method_source (0.9.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  pry-byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov
-  weighted_sampler!
-
-BUNDLED WITH
-   1.16.1

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'weighted_sampler'
-
-# 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(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/weighted_sampler.gemspec

@@ -1,34 +0,0 @@
-
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'weighted_sampler/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'weighted_sampler'
-  spec.version       = WeightedSampler::VERSION
-  spec.authors       = ['Oleksiy Babich']
-  spec.email         = ['oleksiy@oleksiy.od.ua']
-
-  spec.summary       = 'Weighted Sampler helps you to pick a random samples from a collection with defined probabilities or weights'
-  spec.description   = %(
-    Weighted Sampler helps you to pick a random samples from a collection with defined probabilities or weights
-
-    You can pass an Array or a Hash with desired probabilities
-    and use Module or Class API to pick samples
-  )
-  spec.homepage      = 'https://gitlab.com/alexey_b/weighted_sampler'
-  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.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end