glicko2 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in glicko2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Fargher
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Glicko2
+
+Implementation of Glicko2 ratings.
+
+Based on Mark Glickman's paper http://www.glicko.net/glicko/glicko2.pdf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'glicko2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install glicko2
+
+## Usage
+
+```ruby
+require 'glicko2'
+
+# Objects to store Glicko ratings
+Rating = Struct.new(:rating, :rating_deviation, :volatility)
+rating1 = Rating.new(1400, 30, 0.06)
+rating2 = Rating.new(1550, 100, 0.06)
+
+# Create players based on Glicko ratings
+player1 = Glicko2::Player.from_obj(rating1)
+player2 = Glicko2::Player.from_obj(rating2)
+
+# Rating period with all participating players
+period = Glicko2::RatingPeriod.new [player1, player2]
+
+# Register a game in this rating period
+period.game([player1, player2], [1,2])
+
+# Generate the next rating period with updated players
+next_period = period.generate_next
+
+# Update all Glicko ratings
+next_period.players.each { |p| p.update_obj }
+
+# Output updated Glicko ratings
+puts rating1
+puts rating2
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/*_spec.rb"
+end

data/glicko2.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glicko2/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "glicko2"
+  gem.version       = Glicko2::VERSION
+  gem.authors       = ["James Fargher"]
+  gem.email         = ["proglottis@gmail.com"]
+  gem.description   = %q{Implementation of Glicko2 ratings}
+  gem.summary       = %q{Implementation of Glicko2 ratings}
+  gem.homepage      = "https://github.com/proglottis/glicko2"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('minitest')
+end

data/lib/glicko2.rb

@@ -0,0 +1,153 @@
+require "glicko2/version"
+
+module Glicko2
+  TOLERANCE = 0.0000001
+  DEFAULT_VOLATILITY = 0.06
+  DEFAULT_GLICKO_RATING = 1500.0
+  DEFAULT_GLICKO_RATING_DEVIATION = 350.0
+
+  GLICKO_GRADIENT = 173.7178
+  GLICKO_INTERCEPT = DEFAULT_GLICKO_RATING
+
+  VOLATILITY_CHANGE = 0.5
+
+  class Player
+    attr_reader :mean, :sd, :volatility, :obj
+
+    def self.from_obj(obj)
+      mean = (obj.rating - GLICKO_INTERCEPT) / GLICKO_GRADIENT
+      sd = obj.rating_deviation / GLICKO_GRADIENT
+      new(mean, sd, obj.volatility, obj)
+    end
+
+    def initialize(mean, sd, volatility, obj)
+      @mean = mean
+      @sd = sd
+      @volatility = volatility
+      @obj = obj
+    end
+
+    def g
+      1 / Math.sqrt(1 + 3 * sd ** 2 / Math::PI ** 2)
+    end
+
+    def e(other)
+      1 / (1 + Math.exp(-other.g * (mean - other.mean)))
+    end
+
+    def variance(others)
+      return 0.0 if others.length < 1
+      others.reduce(0) do |v, other|
+        v + other.g ** 2 * e(other) * (1 - e(other))
+      end ** -1
+    end
+
+    def delta(others, scores)
+      others.zip(scores).reduce(0) do |d, (other, score)|
+        d + other.g * (score - e(other))
+      end * variance(others)
+    end
+
+    def f_part1(x, others, scores)
+      sd_sq = sd ** 2
+      v = variance(others)
+      _x = Math.exp(x)
+      (_x * (delta(others, scores) ** 2 - sd_sq - v - _x)) / (2 * (sd_sq + v + _x) ** 2)
+    end
+ 
+    def f_part2(x)
+      (x - Math::log(volatility ** 2)) / VOLATILITY_CHANGE ** 2
+    end
+ 
+    def f(x, others, scores)
+      f_part1(x, others, scores) - f_part2(x)
+    end
+ 
+    def generate_next(others, scores)
+      if others.length < 1
+        sd_pre = Math.sqrt(sd ** 2 + volatility ** 2)
+        return self.class.new(mean, sd_pre, volatility, obj) if others.length < 1
+      end
+      _v = variance(others)
+      a = Math::log(volatility ** 2)
+      if delta(others, scores) > sd ** 2 + _v
+        b = Math.log(_delta - sd ** 2 - _v)
+      else
+        k = 1
+        k += 1 while f(a - k * VOLATILITY_CHANGE, others, scores) < 0
+        b = a - k * VOLATILITY_CHANGE
+      end
+      fa = f(a, others, scores)
+      fb = f(b, others, scores)
+      while (b - a).abs > TOLERANCE
+        c = a + (a - b) * fa / (fb - fa)
+        fc = f(c, others, scores)
+        if fc * fb < 0
+          a = b
+          fa = fb
+        else
+          fa /= 2.0
+        end
+        b = c
+        fb = fc
+      end
+      volatility1 = Math.exp(a / 2.0)
+      sd_pre = Math.sqrt(sd ** 2 + volatility1 ** 2)
+      sd1 = 1 / Math.sqrt(1 / sd_pre ** 2 + 1 / _v)
+      mean1 = mean + sd1 ** 2 * others.zip(scores).reduce(0) {|x, (other, score)| x + other.g * (score - e(other)) }
+      self.class.new(mean1, sd1, volatility1, obj)
+    end
+
+    def update_obj
+      @obj.rating = GLICKO_GRADIENT * mean + GLICKO_INTERCEPT
+      @obj.rating_deviation = GLICKO_GRADIENT * sd
+      @obj.volatility = volatility
+    end
+
+    def to_s
+      "#<Player mean=#{mean}, sd=#{sd}, volatility=#{volatility}, obj=#{obj}>"
+    end
+  end
+
+  class RatingPeriod
+    def initialize(players)
+      @players = players.reduce({}) { |memo, player| memo[player] = []; memo }
+    end
+
+    def self.ranks_to_score(rank, other)
+      if rank < other
+        1.0
+      elsif rank == other
+        0.5
+      else
+        0.0
+      end
+    end
+
+    def game(game_players, ranks)
+      game_players.zip(ranks).each do |player, rank|
+        game_players.zip(ranks).each do |other, other_rank|
+          next if player == other
+          @players[player] << [other, self.class.ranks_to_score(rank, other_rank)]
+        end
+      end
+    end
+
+    def generate_next
+      p = []
+      @players.each do |player, games|
+        p << player.generate_next(*games.transpose)
+      end
+      self.class.new(p)
+    end
+
+    def players
+      @players.keys
+    end
+
+    def to_s
+      "#<RatingPeriod players=#{@players.keys}"
+    end
+  end
+
+end

data/lib/glicko2/version.rb

@@ -0,0 +1,3 @@
+module Glicko2
+  VERSION = "0.0.1"
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'glicko2'

data/spec/player_spec.rb

@@ -0,0 +1,107 @@
+require 'minitest_helper'
+
+Rating = Struct.new(:rating, :rating_deviation, :volatility)
+
+describe Glicko2::Player do
+  before do
+    @player = Glicko2::Player.from_obj(Rating.new(1500, 200, 0.06))
+    @player1 = Glicko2::Player.from_obj(Rating.new(1400, 30, 0.06))
+    @player2 = Glicko2::Player.from_obj(Rating.new(1550, 100, 0.06))
+    @player3 = Glicko2::Player.from_obj(Rating.new(1700, 300, 0.06))
+    @others = [@player1, @player2, @player3]
+    @scores = [1, 0, 0]
+  end
+
+  describe ".from_obj" do
+    it "must create player from an object as example" do
+      @player.mean.must_be_close_to 0, 0.0001
+      @player.sd.must_be_close_to 1.1513, 0.0001
+      @player.volatility.must_equal 0.06
+    end
+
+    it "must create player from an object as example 1" do
+      @player1.mean.must_be_close_to -0.5756, 0.0001
+      @player1.sd.must_be_close_to 0.1727, 0.0001
+      @player1.volatility.must_equal 0.06
+    end
+
+    it "must create player from an object as example 2" do
+      @player2.mean.must_be_close_to 0.2878, 0.0001
+      @player2.sd.must_be_close_to 0.5756, 0.0001
+      @player2.volatility.must_equal 0.06
+    end
+
+    it "must create player from an object as example 3" do
+      @player3.mean.must_be_close_to 1.1513, 0.0001
+      @player3.sd.must_be_close_to 1.7269, 0.0001
+      @player3.volatility.must_equal 0.06
+    end
+  end
+
+  describe "#g" do
+    it "must be close to example 1" do
+      @player1.g.must_be_close_to 0.9955, 0.0001
+    end
+
+    it "must be close to example 2" do
+      @player2.g.must_be_close_to 0.9531, 0.0001
+    end
+
+    it "must be close to example 3" do
+      @player3.g.must_be_close_to 0.7242, 0.0001
+    end
+  end
+
+  describe "#e" do
+    it "must be close to example 1" do
+      @player.e(@player1).must_be_close_to 0.639
+    end
+
+    it "must be close to example 2" do
+      @player.e(@player2).must_be_close_to 0.432
+    end
+
+    it "must be close to example 3" do
+      @player.e(@player3).must_be_close_to 0.303
+    end
+  end
+
+  describe "#variance" do
+    it "must be close to example" do
+      @player.variance(@others).must_be_close_to 1.7785
+    end
+  end
+
+  describe "#delta" do
+    it "must be close to example" do
+      @player.delta(@others, @scores).must_be_close_to -0.4834
+    end
+  end
+
+  describe "#generate_next" do
+    it "must be close to example" do
+      p = @player.generate_next(@others, @scores)
+      p.mean.must_be_close_to -0.2069, 0.0001
+      p.sd.must_be_close_to 0.8722, 0.0001
+      p.volatility.must_be_close_to 0.05999, 0.00001
+    end
+
+    it "must allow players that did not play and games" do
+      p = @player.generate_next([], [])
+      p.mean.must_equal @player.mean
+      p.volatility.must_equal @player.volatility
+      p.sd.must_be_close_to Math.sqrt(@player.sd ** 2 + @player.volatility ** 2)
+    end
+  end
+
+  describe "#update_obj" do
+    it "must update object to be close to example" do
+      p = @player.generate_next(@others, @scores)
+      p.update_obj
+      obj = p.obj
+      obj.rating.must_be_close_to 1464.06, 0.01
+      obj.rating_deviation.must_be_close_to 151.52, 0.01
+      obj.volatility.must_be_close_to 0.05999, 0.00001
+    end
+  end
+end

data/spec/rating_period_spec.rb

@@ -0,0 +1,48 @@
+require 'minitest_helper'
+
+describe Glicko2::RatingPeriod do
+  before do
+    @player = Glicko2::Player.from_obj(Rating.new(1500, 200, 0.06))
+    @player1 = Glicko2::Player.from_obj(Rating.new(1400, 30, 0.06))
+    @player2 = Glicko2::Player.from_obj(Rating.new(1550, 100, 0.06))
+    @player3 = Glicko2::Player.from_obj(Rating.new(1700, 300, 0.06))
+    @players = [@player, @player1, @player2, @player3]
+    @period = Glicko2::RatingPeriod.new(@players)
+  end
+
+  describe ".new" do
+    it "must assign players" do
+      @period.players.must_include @player
+      @period.players.must_include @player1
+      @period.players.must_include @player2
+      @period.players.must_include @player3
+    end
+  end
+
+  describe ".ranks_to_score" do
+    it "must return 1.0 when rank is less" do
+      Glicko2::RatingPeriod.ranks_to_score(1, 2).must_equal 1.0
+    end
+
+    it "must return 0.5 when rank is equal" do
+      Glicko2::RatingPeriod.ranks_to_score(1, 1).must_equal 0.5
+    end
+
+    it "must return 0.0 when rank is more" do
+      Glicko2::RatingPeriod.ranks_to_score(2, 1).must_equal 0.0
+    end
+  end
+
+  describe "complete rating period" do
+    it "must be close to example" do
+      @period.game([@player, @player1], [1, 2])
+      @period.game([@player, @player2], [2, 1])
+      @period.game([@player, @player3], [2, 1])
+      @period.generate_next.players.each { |p| p.update_obj }
+      obj = @player.obj
+      obj.rating.must_be_close_to 1464.06, 0.01
+      obj.rating_deviation.must_be_close_to 151.52, 0.01
+      obj.volatility.must_be_close_to 0.05999, 0.00001
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: glicko2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Fargher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 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
+email:
+- proglottis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- glicko2.gemspec
+- lib/glicko2.rb
+- lib/glicko2/version.rb
+- spec/minitest_helper.rb
+- spec/player_spec.rb
+- spec/rating_period_spec.rb
+homepage: https://github.com/proglottis/glicko2
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Implementation of Glicko2 ratings
+test_files:
+- spec/minitest_helper.rb
+- spec/player_spec.rb
+- spec/rating_period_spec.rb