whole_history_rating 0.1.1 → 0.1.2

data/README.md

@@ -10,6 +10,26 @@ Installation
 
 * gem install whole_history_rating
 
+
+Usage
+-----
+
+    require 'whole_history_rating'
+    
+    @whr = WholeHistoryRating::Base.new
+    
+    # WholeHistoryRating::Base#create_game arguments: black player name, white player name, winner, day number, handicap
+    @whr.create_game("shusaku", "shusai", "B", 1, 0)
+    @whr.create_game("shusaku", "shusai", "W", 2, 0)
+    @whr.create_game("shusaku", "shusai", "W", 3, 0)
+
+    # Iterate the WHR algorithm towards convergence with more players/games, more iterations are needed.
+    @whr.iterate(50)
+    
+    # Results are stored in one triplet for each day: [day_number, elo_rating, uncertainty]
+    @whr.ratings_for_player("shusaku") => [[1, -92, 71], [2, -94, 71], [3, -95, 71], [4, -96, 72]]
+    @whr.ratings_for_player("shusai") => [[1, 92, 71], [2, 94, 71], [3, 95, 71], [4, 96, 72]]
+
 Enjoy!
 
 -Pete

data/lib/whole_history_rating.rb

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

data/lib/whole_history_rating/base.rb

@@ -43,7 +43,7 @@ module WholeHistoryRating
       player.days.map {|d| [d.day, d.elo.round, (d.uncertainty*100).round]}
     end
     
-    def create_game(black, white, winner, time_step, handicap, extras = {})
+    def setup_game(black, white, winner, time_step, handicap, extras = {})
           
       # Avoid self-played games (no info)
       if black == white
@@ -56,6 +56,11 @@ module WholeHistoryRating
       game = Game.new(black_player, white_player, winner, time_step, handicap, extras)
       game
     end
+    
+    def create_game(black, white, winner, time_step, handicap, extras = {})
+      game = setup_game(black, white, winner, time_step, handicap, extras)
+      add_game(game)
+    end
   
     def add_game(game)
       game.white_player.add_game(game)

data/test/whr_test.rb

@@ -6,61 +6,56 @@ 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)
+    
+  def setup_game_with_elo(white_elo, black_elo, handicap)
+    game = @whr.create_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)
+    game = setup_game_with_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)
+    game = setup_game_with_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)
+    game = setup_game_with_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)
+    game = setup_game_with_elo(100, 200, 0)
+    game2 = setup_game_with_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)
+    game = setup_game_with_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)
+    game = setup_game_with_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)
+    game = setup_game_with_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.create_game("shusaku", "shusai", "B", 1, 0)
+    @whr.create_game("shusaku", "shusai", "W", 2, 0)
+    @whr.create_game("shusaku", "shusai", "W", 3, 0)
+    @whr.create_game("shusaku", "shusai", "W", 4, 0)
+    @whr.create_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")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whole_history_rating
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors: