wilson_score 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a66381f037f35b8c6af86cd5c654f243378f620
-  data.tar.gz: 8d56f3a99766730ee9baecbb0c63b39be703fd0b
+  metadata.gz: be14e070c2299eb4ca4bfb98fff17bc037778702
+  data.tar.gz: 811d3aed20e01c0f4498c5ef40ac7129f8322eff
 SHA512:
-  metadata.gz: 50d652c3613f6bba4dd2c685ad8c60943eb8d974276be0cee64c6fb2fab9aee514efb6b64471d9d862d527853d7d6f3cfdcc61a99aa84b376e654e3c5c6fc20f
-  data.tar.gz: 1734379e9da77cef40f164ba86525f98f35c991f0c3ff954e93ec82b459865a42eb5384b92289e7d8db56e618e3e6d974560f7952515f51cc29cfa0567d07199
+  metadata.gz: 640f472abf05bd6f9acc79ee4644136387346a15d409c60d4c0dd5f739da5aaef2e4178bcf79d954822c5e4477676c577eaccde796b8b76f37ea5ade87440925
+  data.tar.gz: ee62a52fc1f1049a4c3c2659afa4621fd651ed2b923c16b4c4d26fea556f753b286e2466f3446d2a7b02c8e459284a8ac6e5f7c1b6c58ec25132d3d3fb2be74a

data/README.md

@@ -20,9 +20,9 @@ WilsonScore.interval(3, 5, 0.95, true)
 
 ## Star Ratings
 
-Imagine you have a rating system with 1 to 5 stars.
+You have a rating system where users can rate products from 1 to 5 stars.
 
-There are two ratings, a 4 star and a 5 star.
+A product has two ratings - one 4 star and one 5 star.
 
 ```ruby
 average_rating = 4.5
@@ -30,9 +30,12 @@ total_ratings = 2
 rating_range = 1..5  # 1 to 5 stars
 confidence = 0.95    # 95%
 
-WilsonScore.rating_interval(average_rating, total_ratings, rating_range, confidence)
+interval = WilsonScore.rating_interval(average_rating, total_ratings, rating_range, confidence)
+lower_bound = interval.first
 ```
 
+Use the lower bound of the interval to sort items.
+
 Again, you can set the last parameter to `true` for continuity correction.
 
 ## Installation

data/lib/wilson_score.rb

@@ -4,18 +4,23 @@ module WilsonScore
 
   # http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval
   def self.interval(k, n, confidence, correction = false)
-    z = pnorm(1 - (1 - confidence) / 2)
+    z = pnorm(1 - (1 - confidence) / 2.0)
     phat = k / n.to_f
+    z2 = z**2
     if correction # continuity correction
-      a = 1.0 / (2 * (n + z**2))
-      b = 2*n*phat + z**2
-      c = z * Math.sqrt(z**2 - 1.0/n + 4*n*phat*(1 - phat) + (4*phat - 2)) + 1
-      ([0, a * (b - c)].max)..([1, a * (b + c)].min)
+      a = 2 * (n + z2)
+      b = 2*n*phat + z2
+      c = z * Math.sqrt(z2 - 1.0/n + 4*n*phat*(1 - phat) + (4*phat - 2)) + 1
+      d = z * Math.sqrt(z2 - 1.0/n + 4*n*phat*(1 - phat) - (4*phat - 2)) + 1
+      # hack for phat = 0 or 1
+      lower = phat == 0 ? 0 : (b - c) / a
+      upper = phat == 1 ? 1 : (b + d) / a
+      ([0, lower].max)..([1, upper].min)
     else
-      a = 1.0 / (1 + z ** 2 / n)
-      b = phat + z ** 2 / (2 * n)
-      c = z * Math.sqrt((phat * (1 - phat) + z ** 2 / (4 * n)) / n)
-      (a * (b - c))..(a * (b + c))
+      a = 1 + z2 / n
+      b = phat + z2 / (2 * n)
+      c = z * Math.sqrt((phat * (1 - phat) + z2 / (4 * n)) / n)
+      ((b - c) / a)..((b + c) / a)
     end
   end
 

data/lib/wilson_score/version.rb

@@ -1,3 +1,3 @@
 module WilsonScore
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/wilson_score_test.rb

@@ -14,6 +14,30 @@ class TestWilsonScore < Minitest::Test
     assert_in_delta 0.9733, interval.last
   end
 
+  def test_continuity_correction_zero_one
+    interval = WilsonScore.interval(0, 1, 0.95, true)
+    assert_in_delta 0, interval.first
+    assert_in_delta 0.9454, interval.last
+  end
+
+  def test_continuity_correction_one_fifty
+    interval = WilsonScore.interval(1, 50, 0.95, true)
+    assert_in_delta 0.0010, interval.first
+    assert_in_delta 0.1201, interval.last
+  end
+
+  def test_continuity_correction_one_one
+    interval = WilsonScore.interval(1, 1, 0.95, true)
+    assert_in_delta 0.0546, interval.first
+    assert_in_delta 1, interval.last
+  end
+
+  def test_continuity_correction_one_three
+    interval = WilsonScore.interval(1, 3, 0.95, true)
+    assert_in_delta 0.0176, interval.first
+    assert_in_delta 0.8747, interval.last
+  end
+
   def test_rating
     interval = WilsonScore.rating_interval(5, 1, 1..5, 0.95)
     assert_in_delta 1.8262, interval.first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wilson_score
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler