whole_history_rating 0.1.0 → 0.1.1

data/README.md

@@ -1,14 +1,14 @@
 
 # Whole History Rating
 
-A system for ranking game players by skill, based on Rémi Coulom's Whole History Rating algorithm.
+A system for ranking game players by skill, based on Rémi Coulom's [Whole History Rating](http://remi.coulom.free.fr/WHR/WHR.pdf) algorithm, with modifications to support handicaps.
 
-Developed for use on [GoShrine](http://goshrine.com), but the code is not go specific.  It can support any two player game, as long as the outcome is a simple win/loss.  An addition to the algorithm is support for handicaps. 
+Developed for use on [GoShrine](http://goshrine.com), but the code is not go specific.  It can support any two player game, as long as the outcome is a simple win/loss. 
 
 Installation
 ------------
 
-* gem install whole-history-rating
+* gem install whole_history_rating
 
 Enjoy!
 

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test_units]
+
+desc "Run basic tests"
+Rake::TestTask.new("test_units") { |t|
+  t.pattern = 'test/*_test.rb'
+  #t.verbose = true
+  t.warning = true
+}

data/lib/whole_history_rating.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 
 module WholeHistoryRating
 
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
   STDOUT.sync = true
 

data/lib/whole_history_rating/base.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-require 'date'
 
 module WholeHistoryRating
 
@@ -14,7 +13,6 @@ module WholeHistoryRating
       @config[:w2] ||= 300.0  # elo^2
       @games = []
       @players = {}
-      @start_date = nil
     end
   
     def print_ordered_ratings
@@ -40,32 +38,22 @@ module WholeHistoryRating
       players[name] || players[name] = Player.new(name, @config)
     end
     
-    def create_game(options)
-      if options['finished_at'].nil?
-        puts "Skipping (not finished) #{options.inspect}"
-        return nil
-      end
-      
-      game_date = Date.parse(options['finished_at'])
-    
-      @start_date ||= game_date
+    def ratings_for_player(name)
+      player = player_by_name(name)
+      player.days.map {|d| [d.day, d.elo.round, (d.uncertainty*100).round]}
+    end
     
+    def create_game(black, white, winner, time_step, handicap, extras = {})
+          
       # Avoid self-played games (no info)
-      if options['w_name'] == options['b_name']
-        puts "Skipping (black name == white name ?) #{options.inspect}"
+      if black == white
+        raise "Invalid game (black player == white player)"
         return nil
       end
     
-      day_num = (game_date - @start_date).to_i
-    
-      #puts "day num = #{day_num}"
-    
-      white_player = player_by_name(options['w_name'])
-      white_player.id = options['w_id']
-      black_player = player_by_name(options['b_name'])
-      black_player.id = options['b_id']
-      game = Game.new(day_num, white_player, black_player, options['winner'], options['handicap'], options['extras'])
-      game.date = game_date
+      white_player = player_by_name(white)
+      black_player = player_by_name(black)
+      game = Game.new(black_player, white_player, winner, time_step, handicap, extras)
       game
     end
   
@@ -78,6 +66,13 @@ module WholeHistoryRating
       @games << game
       game
     end
+    
+    def iterate(count)
+      count.times { run_one_iteration }
+      players.each do |name,player|
+        player.update_uncertainty
+      end     
+    end
   
     def run_one_iteration
       players.each do |name,player|

data/lib/whole_history_rating/game.rb

@@ -1,15 +1,15 @@
 module WholeHistoryRating
   class Game
-    attr_accessor :day, :date, :white_player, :black_player, :handicap, :winner, :wpd, :bpd, :extras
+    attr_accessor :day, :white_player, :black_player, :handicap, :winner, :wpd, :bpd, :extras
   
-    def initialize(day, white_player, black_player, winner, handicap, extras)
-      @day = day
-      @white_player = white_player
-      @black_player = black_player
+    def initialize(black, white, winner, time_step, handicap, extras)
+      @day = time_step
+      @white_player = white
+      @black_player = black
       @winner = winner
       @extras = extras
       @handicap = handicap || 0
-      @handicap_proc = handicap if handicap.is_a?(Proc)
+      @handicap_proc = handicap.is_a?(Proc) ? handicap : nil
     end
   
     def opponents_adjusted_gamma(player)
@@ -64,4 +64,4 @@ module WholeHistoryRating
     end
   
   end
-end
+end

data/lib/whole_history_rating/player.rb

@@ -234,7 +234,6 @@ module WholeHistoryRating
     def add_game(game)
       if days.last.nil? || days.last.day != game.day
         new_pday = PlayerDay.new(self, game.day)
-        new_pday.date = game.date
         if days.empty?
           new_pday.is_first_day = true
           new_pday.gamma = 1

data/lib/whole_history_rating/player_day.rb

@@ -1,7 +1,7 @@
 
 module WholeHistoryRating
   class PlayerDay
-    attr_accessor :won_games, :lost_games, :name, :kyudan, :day, :date, :player, :r, :is_first_day, :uncertainty
+    attr_accessor :won_games, :lost_games, :name, :day, :player, :r, :is_first_day, :uncertainty
     def initialize(player, day)
       @day = day
       @player = player

data/test/whr_test.rb

@@ -0,0 +1,69 @@
+require 'test/unit'
+require 'whole_history_rating'
+
+class WholeHistoryRatingTest < Test::Unit::TestCase
+  
+  def setup
+    @whr = WholeHistoryRating::Base.new
+  end
+  
+  def add_game(black, white, winner, time_step, handicap)
+    game = @whr.create_game(black, white, winner, time_step, handicap)
+    @whr.add_game(game)
+  end
+  
+  def build_test_game_force_elo(white_elo, black_elo, handicap)
+    game = add_game("black", "white", "W", 1, handicap)
+    game.black_player.days[0].elo = black_elo
+    game.white_player.days[0].elo = white_elo
+    game
+  end
+  
+  def test_even_game_between_equal_strength_players_should_have_white_winrate_of_50_percent
+    game = build_test_game_force_elo(500, 500, 0)
+    assert_in_delta 0.0001, 0.5, game.white_win_probability
+  end
+
+  def test_handicap_should_confer_advantage
+    game = build_test_game_force_elo(500, 500, 1)
+    assert game.black_win_probability > 0.5
+  end
+
+  def test_higher_rank_should_confer_advantage
+    game = build_test_game_force_elo(600, 500, 0)
+    assert game.white_win_probability > 0.5
+  end
+  
+  def test_winrates_are_equal_for_same_elo_delta
+    game = build_test_game_force_elo(100, 200, 0)
+    game2 = build_test_game_force_elo(200, 300, 0)
+    assert_in_delta 0.0001, game.white_win_probability, game2.white_win_probability
+  end
+
+  def test_winrates_for_twice_as_strong_player
+    game = build_test_game_force_elo(100, 200, 0)
+    assert_in_delta 0.0001, 0.359935, game.white_win_probability
+  end
+
+  def test_winrates_should_be_inversely_proportional_with_unequal_ranks
+    game = build_test_game_force_elo(600, 500, 0)
+    assert_in_delta 0.0001, game.white_win_probability, 1-game.black_win_probability
+  end
+  
+  def test_winrates_should_be_inversely_proportional_with_handicap
+    game = build_test_game_force_elo(500, 500, 4)
+    assert_in_delta 0.0001, game.white_win_probability, 1-game.black_win_probability
+  end
+    
+  def test_output
+    add_game("shusaku", "shusai", "B", 1, 0)
+    add_game("shusaku", "shusai", "W", 2, 0)
+    add_game("shusaku", "shusai", "W", 3, 0)
+    add_game("shusaku", "shusai", "W", 4, 0)
+    add_game("shusaku", "shusai", "W", 4, 0)
+    @whr.iterate(50)
+    assert_equal [[1, -92, 71], [2, -94, 71], [3, -95, 71], [4, -96, 72]], @whr.ratings_for_player("shusaku")
+    assert_equal [[1, 92, 71], [2, 94, 71], [3, 95, 71], [4, 96, 72]], @whr.ratings_for_player("shusai")
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whole_history_rating
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000Z
+date: 2012-05-20 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides a library and executables that take as input as set
   of games and output a set of skill rankings for the players of those games. The
@@ -23,11 +23,13 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- Rakefile
 - lib/whole_history_rating.rb
 - lib/whole_history_rating/base.rb
 - lib/whole_history_rating/game.rb
 - lib/whole_history_rating/player.rb
 - lib/whole_history_rating/player_day.rb
+- test/whr_test.rb
 - whole_history_rating.gemspec
 homepage: http://github.com/goshrine/whole_history_rating
 licenses: []
@@ -49,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: A pure ruby implementation of Remi Coulom's Whole-History Rating algorithm.