glicko2 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3264135c077789c8ce7d6f49a216c3ac50dafeb4
+  data.tar.gz: c621d811f861685e08a85c60d5252e4868231842
+SHA512:
+  metadata.gz: 8d34d1bab836561f0fefb5f58807387af31d7d21adfd31344b547b8d804f75ba16c8ffd5a45d6982a620aca49c9e8374fb5ed93744b9050dea158536c4be0b61
+  data.tar.gz: 27fbeaf711881f18500a5277f2a9571d71bad500976949f73e873c0196cd29347723b382597c8d54e5961ff2751128f6591babb088a1efa60bcdb542da65468a

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.ruby-version
 .yardoc
 Gemfile.lock
 InstalledFiles

data/lib/glicko2.rb

@@ -47,5 +47,6 @@ module Glicko2
 end
 
 require "glicko2/version"
+require "glicko2/normal_distribution"
 require "glicko2/player"
 require "glicko2/rating_period"

data/lib/glicko2/normal_distribution.rb

@@ -0,0 +1,58 @@
+module Glicko2
+  # Glicko ratings are represented with a rating and rating deviation. For this
+  # gem it is assumed that ratings are normally distributed where rating and
+  # rating deviation correspond to mean and standard deviation.
+  class NormalDistribution
+    attr_reader :mean, :standard_deviation
+    alias_method :sd, :standard_deviation
+
+    def initialize(mean, standard_deviation)
+      @mean = mean
+      @standard_deviation = standard_deviation
+    end
+
+    # Calculate the distribution variance
+    #
+    # @return [Numeric]
+    def variance
+      standard_deviation ** 2.0
+    end
+
+    # Calculate the sum
+    #
+    # @param [NormalDistribution] other
+    # @return [NormalDistribution]
+    def +(other)
+      self.class.new(mean + other.mean, Math.sqrt(variance + other.variance))
+    end
+
+    # Calculate the difference
+    #
+    # @param [NormalDistribution] other
+    # @return [NormalDistribution]
+    def -(other)
+      self.class.new(mean - other.mean, Math.sqrt(variance + other.variance))
+    end
+
+    # Calculate the probability density at `x`
+    #
+    # @param [Numeric] x
+    # @return [Numeric]
+    def pdf(x)
+      1.0 / (sd * Math.sqrt(2.0 * Math::PI)) *
+        Math.exp(-(x - mean) ** 2.0 / 2.0 * variance)
+    end
+
+    # Calculate the cumulative distribution at `x`
+    #
+    # @param [Numeric] x
+    # @return [Numeric]
+    def cdf(x)
+      0.5 * (1.0 + Math.erf((x - mean) / (sd * Math.sqrt(2.0))))
+    end
+
+    def to_s
+      "#<NormalDistribution mean=#{mean}, sd=#{sd}>"
+    end
+  end
+end

data/lib/glicko2/player.rb

@@ -22,11 +22,11 @@ module Glicko2
   #
   #   puts player_seed
   #
-  class Player
+  class Player < NormalDistribution
     TOLERANCE = 0.0000001
     MIN_SD = DEFAULT_GLICKO_RATING_DEVIATION / GLICKO_GRADIENT
 
-    attr_reader :mean, :sd, :volatility, :obj
+    attr_reader :volatility, :obj
 
     # Create a {Player} from a seed object, converting from Glicko
     # ratings to Glicko2.
@@ -43,8 +43,7 @@ module Glicko2
     # @param [Numeric] volatility player volatility
     # @param [#rating,#rating_deviation,#volatility] obj seed values object
     def initialize(mean, sd, volatility, obj=nil, config=DEFAULT_CONFIG)
-      @mean = mean
-      @sd = sd
+      super(mean, sd)
       @volatility = volatility
       @obj = obj
       @config = config
@@ -55,7 +54,7 @@ module Glicko2
     #
     # @return [Numeric]
     def g
-      @g ||= 1 / Math.sqrt(1 + 3 * sd ** 2 / Math::PI ** 2)
+      @g ||= 1 / Math.sqrt(1 + 3 * variance / Math::PI ** 2)
     end
 
     # Calculate `E(mu, mu_j, phi_j)` as defined in the Glicko2 paper
@@ -71,7 +70,7 @@ module Glicko2
     #
     # @param [Array<Player>] others other participating players.
     # @return [Numeric]
-    def variance(others)
+    def estimated_variance(others)
       return 0.0 if others.length < 1
       others.reduce(0) do |v, other|
         e_other = e(other)
@@ -89,14 +88,14 @@ module Glicko2
     def delta(others, scores)
       others.zip(scores).reduce(0) do |d, (other, score)|
         d + other.g * (score - e(other))
-      end * variance(others)
+      end * estimated_variance(others)
     end
 
     # Calculate `f(x)` as defined in the Glicko2 paper
     #
     # @param [Numeric] x
     # @param [Numeric] d the result of calculating {#delta}
-    # @param [Numeric] v the result of calculating {#variance}
+    # @param [Numeric] v the result of calculating {#estimated_variance}
     # @return [Numeric]
     def f(x, d, v)
       f_part1(x, d, v) - f_part2(x)
@@ -105,12 +104,12 @@ module Glicko2
     # Calculate the new value of the volatility
     #
     # @param [Numeric] d the result of calculating {#delta}
-    # @param [Numeric] v the result of calculating {#variance}
+    # @param [Numeric] v the result of calculating {#estimated_variance}
     # @return [Numeric]
     def volatility1(d, v)
       a = Math::log(volatility ** 2)
-      if d > sd ** 2 + v
-        b = Math.log(d - sd ** 2 - v)
+      if d > variance + v
+        b = Math.log(d - variance - v)
       else
         k = 1
         k += 1 while f(a - k * @config[:volatility_change], d, v) < 0
@@ -162,15 +161,15 @@ module Glicko2
     private
 
     def generate_next_without_games
-      sd_pre = [Math.sqrt(sd ** 2 + volatility ** 2), MIN_SD].min
+      sd_pre = [Math.sqrt(variance + volatility ** 2), MIN_SD].min
       self.class.new(mean, sd_pre, volatility, obj)
     end
 
     def generate_next_with_games(others, scores)
-      _v = variance(others)
+      _v = estimated_variance(others)
       _d = delta(others, scores)
       _volatility = volatility1(_d, _v)
-      sd_pre = Math.sqrt(sd ** 2 + _volatility ** 2)
+      sd_pre = [Math.sqrt(variance + volatility ** 2), MIN_SD].min
       _sd = 1 / Math.sqrt(1 / sd_pre ** 2 + 1 / _v)
       _mean = mean + _sd ** 2 * others.zip(scores).reduce(0) {
         |x, (other, score)| x + other.g * (score - e(other))
@@ -180,7 +179,7 @@ module Glicko2
 
     def f_part1(x, d, v)
       exp_x = Math.exp(x)
-      sd_sq = sd ** 2
+      sd_sq = variance
       (exp_x * (d ** 2 - sd_sq - v - exp_x)) / (2 * (sd_sq + v + exp_x) ** 2)
     end
 

data/lib/glicko2/version.rb

@@ -1,3 +1,3 @@
 module Glicko2
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/normal_distribution_spec.rb

@@ -0,0 +1,69 @@
+require 'minitest_helper'
+
+describe Glicko2::NormalDistribution do
+  describe "#variance" do
+    it "must return the square of the standard deviation" do
+      Glicko2::NormalDistribution.new(1.0, 1.0).variance.must_equal 1.0 ** 2.0
+      Glicko2::NormalDistribution.new(1.0, 2.0).variance.must_equal 2.0 ** 2.0
+      Glicko2::NormalDistribution.new(1.0, 10.0).variance.must_equal 10.0 ** 2.0
+    end
+  end
+
+  describe "#+" do
+    let(:dist1) { Glicko2::NormalDistribution.new(10.0, 0.5) }
+    let(:dist2) { Glicko2::NormalDistribution.new(5.0, 1.0) }
+
+    it "must sum the means" do
+      (dist1 + dist2).mean.must_equal 15.0
+    end
+
+    it "must sqrt the sum of the variances" do
+      (dist1 + dist2).sd.must_equal Math.sqrt(0.5 ** 2.0 + 1.0 ** 2.0)
+    end
+  end
+
+  describe "#-" do
+    let(:dist1) { Glicko2::NormalDistribution.new(10.0, 0.5) }
+    let(:dist2) { Glicko2::NormalDistribution.new(5.0, 1.0) }
+
+    it "must subtract the means" do
+      (dist1 - dist2).mean.must_equal 5.0
+    end
+
+    it "must sqrt the sum of the variances" do
+      (dist1 - dist2).sd.must_equal Math.sqrt(0.5 ** 2.0 + 1.0 ** 2.0)
+    end
+  end
+
+  describe "#pdf" do
+    describe "standard normal" do
+      let(:dist) { Glicko2::NormalDistribution.new(0.0, 1.0) }
+
+      it "must calculate PDF at x" do
+        dist.pdf(-5.0).must_be_close_to 0.00000149, 0.00000001
+        dist.pdf(-2.5).must_be_close_to 0.01752830, 0.00000001
+        dist.pdf(-1.0).must_be_close_to 0.24197072, 0.00000001
+        dist.pdf(0.0).must_be_close_to 0.39894228, 0.00000001
+        dist.pdf(1.0).must_be_close_to 0.24197072, 0.00000001
+        dist.pdf(2.5).must_be_close_to 0.01752830, 0.00000001
+        dist.pdf(5.0).must_be_close_to 0.00000149, 0.00000001
+      end
+    end
+  end
+
+  describe "#cdf" do
+    describe "standard normal" do
+      let(:dist) { Glicko2::NormalDistribution.new(0.0, 1.0) }
+
+      it "must calculate CDF at x" do
+        dist.cdf(-5.0).must_be_close_to 0.00000029, 0.00000001
+        dist.cdf(-2.5).must_be_close_to 0.00620967, 0.00000001
+        dist.cdf(-1.0).must_be_close_to 0.15865525, 0.00000001
+        dist.cdf(0.0).must_be_close_to 0.50000000, 0.00000001
+        dist.cdf(1.0).must_be_close_to 0.84134475, 0.00000001
+        dist.cdf(2.5).must_be_close_to 0.99379033, 0.00000001
+        dist.cdf(5.0).must_be_close_to 0.99999971, 0.00000001
+      end
+    end
+  end
+end

data/spec/player_spec.rb

@@ -66,9 +66,9 @@ describe Glicko2::Player do
     end
   end
 
-  describe "#variance" do
+  describe "#estimated_variance" do
     it "must be close to example" do
-      @player.variance(@others).must_be_close_to 1.7785
+      @player.estimated_variance(@others).must_be_close_to 1.7785
     end
   end
 

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: glicko2
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - James Fargher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Implementation of Glicko2 ratings
@@ -41,39 +38,42 @@ files:
 - Rakefile
 - glicko2.gemspec
 - lib/glicko2.rb
+- lib/glicko2/normal_distribution.rb
 - lib/glicko2/player.rb
 - lib/glicko2/rating_period.rb
 - lib/glicko2/version.rb
 - spec/minitest_helper.rb
+- spec/normal_distribution_spec.rb
 - spec/player_spec.rb
 - spec/rating_period_spec.rb
 - spec/util_spec.rb
 homepage: https://github.com/proglottis/glicko2
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Implementation of Glicko2 ratings
 test_files:
 - spec/minitest_helper.rb
+- spec/normal_distribution_spec.rb
 - spec/player_spec.rb
 - spec/rating_period_spec.rb
 - spec/util_spec.rb
+has_rdoc: