icu_ratings 1.3.1 → 1.4.0

data/lib/icu_ratings/player.rb

@@ -273,7 +273,9 @@ module ICU
       stable
     end
 
-    def calculate_bonus # :nodoc:
+    def calculate_bonus(allow_new_bonus) # :nodoc:
+      # New in December 2012 - see http://ratings.icu.ie/articles/18 (Part 2).
+      return if !allow_new_bonus && @bonus == 0
       # Rounding is performed in places to emulate the older MSAccess implementation.
       return if @type != :rated || @kfactor <= 24 || @results.size <= 4 || @rating >= 2100
       change = rating_change

data/lib/icu_ratings/tournament.rb

@@ -57,15 +57,20 @@ module ICU
   #
   # See ICU::RatedPlayer and ICU::RatedResult for more details.
   #
-  # The <em>rate!</em> method takes some optional arguments to control the algoritm, for example:
+  # The <em>rate!</em> method takes some optional arguments to control the algorithm, for example:
   #
-  #   t.rate!(max_iterations2: 30)
+  #   t.rate!(max_iterations2: 30, phase_2_bonuses: false)    # these are the recommended options
   #
-  # The complete set of current options is:
+  # The complete set of current options, with their defaults, is:
   #
   # * <em>max_iterations1</em>: the maximum number of re-estimation iterations before the bonus calculation (default <b>30</b>)
   # * <em>max_iterations2</em>: the maximum number of re-estimation iterations after the bonus calculation (default <b>1</b>)
   # * <em>threshold</em>: the maximum difference allowed between re-estimated ratings in a stabe solution (default <b>0.5</b>)
+  # * <em>phase_2_bonuses</em>: allow new bonuses in the second phase of calculation (default <b>true</b>)
+  #
+  # The defaults correspond to the original algorithm. However, it is recommended not to use the defaults for
+  # <em>max_iterations2</em> and <em>phase_2_bonuses</em> but to use <em>30</em> and <em>false</em> instead.
+  # See <a href="http://ratings.icu.ie/articles/18">this article</a> for more details.
   #
   # == Error Handling
   #
@@ -109,7 +114,8 @@ module ICU
     # Rate the tournament. Called after all players and results have been added.
     def rate!(opt={})
       max_iterations1 = opt[:max_iterations1] || 30
-      max_iterations2 = opt[:max_iterations2] || 1
+      max_iterations2 = opt[:max_iterations2] || 1                                      # legacy default - see http://ratings.icu.ie/articles/18 (Part 1)
+      phase_2_bonuses = opt.has_key?(:phase_2_bonuses) ? opt[:phase_2_bonuses] : true   # legacy default - see http://ratings.icu.ie/articles/18 (Part 2)
       threshold = opt[:threshold] || 0.5
       players.each { |p| p.init }
       @iterations1 = performance_ratings(max_iterations1, threshold)
@@ -117,7 +123,7 @@ module ICU
       if !no_bonuses && calculate_bonuses > 0
         players.each { |p| p.rate! }
         @iterations2 = performance_ratings(max_iterations2, threshold)
-        calculate_bonuses
+        calculate_bonuses(phase_2_bonuses)
       else
         @iterations2 = 0
       end
@@ -164,8 +170,8 @@ module ICU
     end
 
     # Calculate bonuses for all players and return the number who got one.
-    def calculate_bonuses
-      @player.values.inject(0) { |t,p| t + (p.calculate_bonus ? 1 : 0) }
+    def calculate_bonuses(allow_new_bonus=true)
+      @player.values.inject(0) { |t,p| t + (p.calculate_bonus(allow_new_bonus) ? 1 : 0) }
     end
   end
 end

data/lib/icu_ratings/version.rb

@@ -2,6 +2,6 @@
 
 module ICU
   class Ratings
-    VERSION = "1.3.1"
+    VERSION = "1.4.0"
   end
 end

data/spec/tournament_spec.rb

@@ -2001,11 +2001,9 @@ module ICU
       it "should produce inconsistent results with default settings" do
         @t.rate!
 
-        @p.new_rating.should be_within(0.5).of(713)  # the original inconsistent calculation
         @p.new_rating.should == @p.performance
 
         @o1.bonus.should == 16
-        @o1.new_rating.should be_within(0.5).of(1013)
         @o2.bonus.should == 0
         @o3.bonus.should == 0
         @o4.bonus.should == 0
@@ -2021,13 +2019,31 @@ module ICU
         @t.iterations2.should == 1
       end
 
-      it "should produce consistent results somehow" do
-        pending "a fix to the algorithm (the number of iterations does not help)"
-
+      it "should produce inconsistent results even with more 2nd phase iterations" do
         @t.rate!(max_iterations2: 30)
 
+        @p.new_rating.should == @p.performance
+
         @o1.bonus.should == 16
-        @o1.new_rating.should be_within(0.5).of(1013)
+        @o2.bonus.should == 0
+        @o3.bonus.should == 0
+        @o4.bonus.should == 0
+        @o5.bonus.should == 0
+        @o6.bonus.should == 0
+
+        ratings = [@o1, @o2, @o3, @o4, @o5, @o6].map { |o| o.bonus == 0 ? o.rating : o.new_rating }
+
+        performance = ratings.inject(0.0){ |m,r| m = m + r } / 6.0 - 400.0 / 3.0
+        performance.should_not be_within(0.5).of(@p.new_rating)
+
+        @t.iterations1.should be > 1
+        @t.iterations2.should be > 1
+      end
+
+      it "should produce consistent results only when new bonuses in phase 2 are disallowed" do
+        @t.rate!(max_iterations2: 30, phase_2_bonuses: false)
+
+        @o1.bonus.should == 0  # no bonus this time because it comes from 2nd phase
         @o2.bonus.should == 0
         @o3.bonus.should == 0
         @o4.bonus.should == 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icu_ratings
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-02 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2472592709794521848
+      hash: 4520836644444600714
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2472592709794521848
+      hash: 4520836644444600714
 requirements: []
 rubyforge_project: icu_ratings
 rubygems_version: 1.8.23