rational_choice 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d9c8ce05833c10354ed5a50430c8a2d23c605b8
-  data.tar.gz: 6f3f5990f6484cd086da5226903e79bd2948a643
+  metadata.gz: 75a1742fcfa84e13ef7b67d0a3718676a240f00d
+  data.tar.gz: 49d428dd3e4f9292cd7eec5098422e119216a518
 SHA512:
-  metadata.gz: 09fadb723ab85663042ce147028c5144b62fd80c605b601d638a00285963e7970bd4018e20bbd42404ccba2707f5c026a1e620e83e8535517b6f28e24ec8e07d
-  data.tar.gz: 68b35d64dc97aba4466da942f77dc161eb2b3933dc5a98c77a500239edd042f6031df5c1e9f6ca5b481ad03e689cedb64bae53b508b2079a24a4b98ab317581f
+  metadata.gz: 6d51bbedb0f841e8d14a397a74794a46642806d522dcae325d47e2fde225d4f704908162f0f512af163ff02618e34b682ce37bb63788cadef32e40b59c26fa98
+  data.tar.gz: 1d5cddf81c1fcb5d8086dda58b01213a7e85ef4c956fe6efd6d322f44d095c6cfe4327b48357bb5c3acee9d43cf880695128b9ee337d92477a9de6feac945608

data/README.md

@@ -1,5 +1,7 @@
 # rational_choice
 
+[![Build Status](https://travis-ci.org/WeTransfer/rational_choice.svg?branch=master)](https://travis-ci.org/WeTransfer/rational_choice)
+
 Makes a fuzzy logic choice based on a continuum of values. For when a "yes or no" is not-quite-good-enough.
 
 ## Choice on one dimension of values
@@ -9,7 +11,8 @@ and you know that it can take about 20 maximum. When you decide whether to send
 number 17 to it, you want to take a little margin and only send that connection sometimes, to
 balance the choices - so you want to use a softer bound (a bit of a fuzzy logic).
 
-    will_accept_connection = RationalChoice::Dimension.new(20, 10) # ten connections is always safe
+    # ten connections is always safe
+    will_accept_connection = RationalChoice::Dimension.new(false_at_or_below: 20, true_at_or_above:10)
     if will_accept_connection.choose(server.current_connection_count + 1) # will give you a fuzzy choice
       server.accept(new_client)
     else
@@ -24,8 +27,8 @@ or above the upper bound will always choose `true`.
 
 Useful to give rational choices on multiple values, averaged together.
 
-    num_clients = Dimension.new(200, 100)
-    bandwidth = Dimension.new(2048, 1024)
+    num_clients = Dimension.new(false_at_or_below: 200, true_at_or_above: 100)
+    bandwidth = Dimension.new(false_at_or_below:2048, true_at_or_above: 1024)
     has_capacity = ManyDimensions.new(num_clients, bandwidth)
     
     will_accept_connection = has_capacity.choose(current_client_count, current_bandwidth)

data/lib/rational_choice.rb

@@ -1,7 +1,7 @@
 # Tiny fuzzy-logic gate for making choices based on a continuum of permitted values
 # as opposed to a hard condition.
 module RationalChoice
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
   
   # Gets raised when a multidimensional choice has to be made with a wrong number
   # of values versus the number of dimensions
@@ -14,13 +14,13 @@ module RationalChoice
   class Dimension
     # Initializes a new Dimension to evaluate values
     #
-    # @param false_bound[#to_f, #<=>] the lower bound, at or below which the value will be considered false
-    # @param true_bound[#to_f, #<=>] the upper bound, at or above which the value will be considered true
-    def initialize(false_bound, true_bound)
-      raise DomainError, "Bounds were the same at #{false_bound}" if false_bound == true_bound
+    # @param false_at_or_below[#to_f, #<=>] the lower bound, at or below which the value will be considered false
+    # @param true_at_or_above[#to_f, #<=>] the upper bound, at or above which the value will be considered true
+    def initialize(false_at_or_below: , true_at_or_above:)
+      raise DomainError, "Bounds were the same at #{false_at_or_below}" if false_at_or_below == true_at_or_above
       
-      @lower, @upper = [false_bound, true_bound].sort
-      @flip_sign = [@lower, @upper].sort != [false_bound, true_bound]
+      @lower, @upper = [false_at_or_below, true_at_or_above].sort
+      @flip_sign = [@lower, @upper].sort != [false_at_or_below, true_at_or_above]
     end
     
     # Evaluate a value against the given false and true bound.
@@ -32,7 +32,7 @@ module RationalChoice
     # of the value being true, based on a linear interpolation.
     # For example:
     #
-    #     d = Dimension.new(0, 1)
+    #     d = Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
     #     d.choose(0) # => false
     #     d.choose(1) # => true
     #     d.choose(0.5) #=> will be `true` in 50% of the cases (probability of 0.5)
@@ -43,15 +43,14 @@ module RationalChoice
     # number 17 to it, you want to take a little margin and only send that connection sometimes, to
     # balance the choices - so you want to use a softer bound (a bit of a fuzzy logic).
     #
-    #     will_accept_connection = Dimension.new(20, 10) # ten connections is always safe
+    #     # 10 connactions is doable, 20 connections means contention
+    #     will_accept_connection = Dimension.new(false_at_or_below: 20, true_at_or_above: 10)
     #     will_accept_connection.choose(server.current_connection_count + 1) # will give you a fuzzy choice
     #
     # @param value[#to_f, Comparable] a value to be evaluated (must be coercible to a Float and Comparable)
     # @return [Boolean] the chosen value based on probability and randomness
     def choose(value)
-      choice = if !fuzzy?(value)
-        value >= @upper
-      else
+      choice = if fuzzy?(value)
         # Interpolate the probability of the value being true
         delta = @upper.to_f - @lower.to_f
         v = (value - @lower).to_f
@@ -59,6 +58,9 @@ module RationalChoice
     
         r = Random.new # To override in tests if needed
         r.rand < t
+      else
+        # just seen where it is (below or above)
+        value >= @upper
       end
       choice ^ @flip_sign
     end
@@ -104,7 +106,7 @@ module RationalChoice
       evaluations = values.zip(@dimensions).map { |(v, d)| d.choose(v) }
       num_truthy_choices = evaluations.select{|e| e}.length
       
-      Dimension.new(0, evaluations.length).choose(num_truthy_choices)
+      Dimension.new(false_at_or_below: 0, true_at_or_above: evaluations.length).choose(num_truthy_choices)
     end
   end
 end

data/rational_choice.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rational_choice 1.0.0 ruby lib
+# stub: rational_choice 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rational_choice"
-  s.version = "1.0.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2015-12-06"
+  s.date = "2016-02-07"
   s.description = "Fuzzy logic gate"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [

data/spec/rational_choice/dimension_spec.rb

@@ -4,35 +4,35 @@ describe 'RationalChoice::Dimension' do
   describe '.new' do
     it 'raises a DomainError if the bounds are the same' do
       expect {
-        RationalChoice::Dimension.new(2,2)
+        RationalChoice::Dimension.new(false_at_or_below: 2, true_at_or_above: 2)
       }.to raise_error(/Bounds were the same at 2/)
     end
   end
   
   describe 'with values at or beyound the thresholds' do
     it 'always evaluates to true for values above upper threshold' do
-      d = RationalChoice::Dimension.new(0, 1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       10_000.times do
         expect(d.choose(1.1)).to eq(true)
       end
     end
     
     it 'always evaluates to true for values at upper threshold' do
-      d = RationalChoice::Dimension.new(0, 1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       10_000.times do
         expect(d.choose(1)).to eq(true)
       end
     end
     
     it 'always evaluates to false for values at lower threshold' do
-      d = RationalChoice::Dimension.new(0, 1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       10_000.times do
         expect(d.choose(0)).to eq(false)
       end
     end
     
     it 'always evaluates to false for values below lower threshold' do
-      d = RationalChoice::Dimension.new(0, 1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       10_000.times do
         expect(d.choose(-0.0001)).to eq(false)
       end
@@ -41,7 +41,7 @@ describe 'RationalChoice::Dimension' do
   
   describe 'with values between thresholds creates a sensible choice distribution' do
     it 'for 0.5 on a continuum from 0 to 1' do
-      d = RationalChoice::Dimension.new(0, 1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       expect(d).to be_fuzzy(0.5)
       
       trues = 0
@@ -53,7 +53,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for 0.1 on a continuum from 0 to 1' do
-      d = RationalChoice::Dimension.new(0, 1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       expect(d).to be_fuzzy(0.1)
       
       trues = 0
@@ -65,7 +65,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for 0.5 on a continuum from 1 to 0' do
-      d = RationalChoice::Dimension.new(1, 0)
+      d = RationalChoice::Dimension.new(false_at_or_below: 1, true_at_or_above: 0)
       expect(d).to be_fuzzy(0.5)
       
       falses = 0
@@ -76,7 +76,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for 0.1 on a continuum from 1 to 0' do
-      d = RationalChoice::Dimension.new(1, 0)
+      d = RationalChoice::Dimension.new(false_at_or_below: 1, true_at_or_above: 0)
       expect(d).to be_fuzzy(0.1)
       
       trues = 0
@@ -88,7 +88,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for -0.5 on a continuum from -1 to 0' do
-      d = RationalChoice::Dimension.new(-1, 0)
+      d = RationalChoice::Dimension.new(false_at_or_below: -1, true_at_or_above: 0)
       expect(d).to be_fuzzy(-0.5)
       
       trues = 0
@@ -99,7 +99,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for -0.1 on a continuum from -1 to 0' do
-      d = RationalChoice::Dimension.new(-1, 0)
+      d = RationalChoice::Dimension.new(false_at_or_below: -1, true_at_or_above: 0)
       expect(d).to be_fuzzy(-0.1)
       
       trues = 0
@@ -111,7 +111,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for -0.5 on a continuum from 0 to -1' do
-      d = RationalChoice::Dimension.new(0, -1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: -1)
       expect(d).to be_fuzzy(-0.5)
       
       trues = 0
@@ -122,7 +122,7 @@ describe 'RationalChoice::Dimension' do
     end
     
     it 'for -0.1 on a continuum from 0 to -1' do
-      d = RationalChoice::Dimension.new(0, -1)
+      d = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: -1)
       expect(d).to be_fuzzy(-0.1)
       
       trues = 0

data/spec/rational_choice/many_dimensions_spec.rb

@@ -18,7 +18,7 @@ describe 'RationalChoice::ManyDimensions' do
     end
     
     let(:md) {
-      one_to_zero = RationalChoice::Dimension.new(0, 1)
+      one_to_zero = RationalChoice::Dimension.new(false_at_or_below: 0, true_at_or_above: 1)
       RationalChoice::ManyDimensions.new(one_to_zero, one_to_zero, one_to_zero)
     }
     
@@ -47,7 +47,7 @@ describe 'RationalChoice::ManyDimensions' do
     it 'creates a very uniform distribution of values with random values across the board' do
       truthy = 0
       10_000.times { truthy += 1 if md.choose(rand, rand, rand) } # default rand() is 0..1
-      expect(truthy).to be_within(100).of(10_000 / 2)
+      expect(truthy).to be_within(200).of(10_000 / 2)
     end
   end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rational_choice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-06 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard