probability_to_friendly_string 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3593585eb866ea1da80396ec1d860a33e0c7910f
+  data.tar.gz: cc800c83ece8650d8845d2b3c4ea52761aca2164
+SHA512:
+  metadata.gz: 3908e471317c8b18de71d56bc5219f9e018c1e237efb5002cb21d2b6589b422cca887331d4a1ee353d7f7502a8adeda76dc7871cc57f54c50fb1e7f939fc371d
+  data.tar.gz: fe35bf7fe7cb03bc58e361c7c515f00426c4849e2eae488e369514ef20f5f59d6d7ffffeff596fee19f94fb39a56bd65aadf4906ec6900a9d88a12fdc894d03b

data/lib/probability_to_friendly_string.rb

@@ -0,0 +1,92 @@
+module ProbabilityToFriendlyString
+    class FriendlyProbability
+        include Comparable
+        attr_reader :numerator, :denominator, :friendlyString
+
+        @@fractionsData = nil
+        def initialize(numerator, denominator, friendlyString = nil)
+            @numerator = numerator
+            @denominator = denominator
+            if friendlyString
+                @friendlyString = friendlyString 
+            else
+                @friendlyString = "%d in %d" % [numerator, denominator]
+            end
+        end
+
+        def self._addFraction(fractionsData, numerator, denominator)
+            fractionsData << [numerator.to_f/denominator, numerator, denominator]
+        end
+        def self._createFractionsData
+            if @@fractionsData
+                return
+            end
+            fractionsData = []
+            (2..10).each do |d|
+                (1..d).each do |n|
+                    if n.gcd(d) == 1
+                        _addFraction(fractionsData, n, d)
+                    end
+                end
+            end
+            [12, 15, 20, 30, 40, 50, 60, 80, 100].each do |d|
+                _addFraction(fractionsData, 1, d)
+                _addFraction(fractionsData, d - 1, d)
+            end
+            @@fractionsData = fractionsData.sort
+        end
+
+        def self.fromProbability(f)
+            if f < 0 or f > 1
+                raise RangeError, "f is less than 0 or greater than 1"
+            end
+            if f == 0
+                return FriendlyProbability.new 0, 1
+            elsif f == 1
+                return FriendlyProbability.new 1, 1
+            elsif f > 0.99
+                return FriendlyProbability.new 99, 100, ">99 in 100"
+            elsif f < 0.01
+                return FriendlyProbability.new 1, 100, "<1 in 100"
+            end
+
+            FriendlyProbability._createFractionsData
+            # index of the least element > f
+            right = @@fractionsData.bsearch_index {|x| x[0] > f}
+            if right
+                left = right - 1
+            else
+                left = @@fractionsData.length - 1
+            end
+            if (left == (@@fractionsData.length - 1) or (left >= 0 and f - @@fractionsData[left][0] < @@fractionsData[right][0] - f))
+                return FriendlyProbability.new @@fractionsData[left][1], @@fractionsData[left][2]
+            else
+                return FriendlyProbability.new @@fractionsData[right][1], @@fractionsData[right][2]
+            end
+        end
+
+        def to_s
+            return "#{@numerator}/#{@denominator} (text: \"#{@friendlyString}\")"
+        end
+
+        def <=>(another_friendly_string)
+            if self.numerator < another_friendly_string.numerator
+                -1
+            elsif self.numerator > another_friendly_string.numerator
+                1
+            end
+            if self.denominator < another_friendly_string.denominator
+                -1
+            elsif self.denominator > another_friendly_string.denominator
+                1
+            end
+            if self.friendlyString < another_friendly_string.friendlyString
+                -1
+            elsif self.friendlyString > another_friendly_string.friendlyString
+                1
+            else
+                0
+            end
+        end
+    end
+end

data/test/friendly_probability_tests.rb

@@ -0,0 +1,32 @@
+require 'test/unit'
+require_relative '../lib/probability_to_friendly_string'
+
+class FriendlyProbabilityTests < Test::Unit::TestCase
+    def test_all_cases
+        directory = File.absolute_path(File.dirname(__FILE__))
+        path = File.join(directory, 'testCases.txt')
+        while !File.exists?(path)
+            directory = File.dirname(directory)
+            path = File.join(directory, 'testCases.txt')
+        end
+        lineNumber = 0
+        File.open(path).each do |fullLine|
+            lineNumber += 1
+            line = fullLine.strip
+            if (line.start_with?('#') or line.empty?)
+                next
+            end
+            parts = line.split(',')
+            case parts.length
+            when 3
+                expected = ProbabilityToFriendlyString::FriendlyProbability.new parts[1].to_i, parts[2].to_i
+            when 4
+                expected = ProbabilityToFriendlyString::FriendlyProbability.new parts[1].to_i, parts[2].to_i, parts[3]
+            else
+                flunk "Line badly formatted: #{line} (line #{lineNumber})"
+            end
+            actual = ProbabilityToFriendlyString::FriendlyProbability.fromProbability(parts[0].to_f)
+            assert_equal expected, actual, "Called on #{parts[0]} (line #{lineNumber})"
+        end
+    end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: probability_to_friendly_string
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Greg Stoll
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies: []
+description: Make probabilities more intuitive by converting them to odds (i.e. 72.3%
+  becomes "5 in 7")
+email: greg@gregstoll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/probability_to_friendly_string.rb
+- test/friendly_probability_tests.rb
+homepage: https://github.com/gregstoll/probabilityToFriendlyString
+licenses:
+- MIT
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Make probabilities more intuitive by converting them to odds
+test_files:
+- test/friendly_probability_tests.rb