#!/usr/bin/ruby
-## $Id$
-
-## Copyright (C) 2006 Daigo Moriwaki <daigo at debian dot org>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-## GNU General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-#
-# This calculates rating scores of every players from CSA files, and outputs a
-# yaml file (players.yaml) that Shogi Server can read.
-#
-# Sample:
-# $ ./mk_rate . > players.yaml
+# $Id$
#
-# The conditions that games and players are rated as following:
-# * Rated games, which were played by both rated players.
-# * Rated players, who logged in the server with a name followed by a trip:
-# "name,trip".
-# * (Rated) players, who played more than $GAMES_LIMIT [15] (rated) games.
+# Author:: Daigo Moriwaki
+# Homepage:: http://sourceforge.jp/projects/shogi-server/
+#
+#--
+# Copyright (C) 2006-2009 Daigo Moriwaki <daigo at debian dot org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#++
+#
+# == Synopsis
+#
+# mk_rate reads CSA files, calculates rating scores of each player, and then
+# outputs a yaml file (players.yaml) that Shogi-server can recognize.
+#
+# == Usage
+#
+# ./mk_rate [options] DIR..
+#
+# DIR::
+# CSA files are recursively looked up the directories.
#
+# --base-date::
+# a base time point for this calicuration (default now). Ex. '2009-10-31'
#
-# PREREQUIRE
-# ==========
+# --half-life::
+# n [days] (default 60)
+#
+# --half-life-ignore::
+# m [days] (default 7)
+# after m days, the half-life effect works
#
-# Sample Commands to isntall prerequires will work for Debian.
+# --fixed-rate-player::
+# player whose rate is fixed at the rate
+#
+# --fixed-rate::
+# rate
+#
+# --skip-draw-games::
+# skip draw games. [default: draw games are counted in as 0.5 win and 0.5
+# lost.]
+#
+# --help::
+# show this message
+#
+# == PREREQUIRE
+#
+# Sample Command lines that isntall prerequires will work on Debian.
+#
+# * Ruby 1.8.7
+#
+# $ sudo aptitude install ruby1.8
#
# * Rubygems
+#
# $ sudo aptitude install rubygems
#
-# * Ruby bindings for the GNU Scientific Library (GSL)
+# * Ruby bindings for the GNU Scientific Library (GSL[http://rb-gsl.rubyforge.org/])
+#
# $ sudo aptitude install libgsl-ruby1.8
-# Or, download it from http://rb-gsl.rubyforge.org/ .
#
-# * RGL: Ruby Graph Library
+# * RGL: {Ruby Graph Library}[http://rubyforge.org/projects/rgl/]
+#
# $ sudo gem install rgl
-# Or, download it from http://rubyforge.org/projects/rgl/ .
+#
+# == Run
+#
+# $ ./mk_rate . > players.yaml
+#
+# or, if you do not want the file to be update in case of errors,
+#
+# $ ./mk_rate . && ./mk_rate . > players.yaml
+#
+# == How players are rated
+#
+# The conditions that games and players are rated as following:
+#
+# * Rated games, which were played by both rated players.
+# * Rated players, who logged in the server with a name followed by a trip: "name,trip".
+# * (Rated) players, who played more than $GAMES_LIMIT [15] (rated) games.
#
require 'yaml'
require 'time'
+require 'getoptlong'
require 'gsl'
require 'rubygems'
require 'rgl/adjacency'
$stderr.puts "f: %s -> %f" % [f.to_a.inspect, f.nrm2] if $DEBUG
# GSL::Linalg::LU.solve or GSL::Linalg::HH.solve would be available instead.
- a = GSL::Linalg::SV.solve(j, f)
+ #a = GSL::Linalg::HH.solve(j, f)
+ a, = GSL::MultiFit::linear(j, f)
a = self.class.average(a)
# $stderr.puts "a: %s -> %f" % [a.to_a.inspect, a.nrm2] if $DEBUG
end
##
+ # Translate by value
+ #
+ def translate!(value)
+ @rate += value
+ end
+
+ ##
# Make the values of @rate integer.
#
def integer!
end
##
- # Removes a delete_index'th player and returns a new object.
+ # Removes players in a rows such as [1,3,5], and then returns a new
+ # object.
#
- def delete_row(delete_index)
+ def delete_rows(rows)
+ rows = rows.sort.reverse
+
copied_cols = []
(0...size).each do |i|
- next if i == delete_index
+ next if rows.include?(i)
row = @matrix.row(i).clone
- row.delete_at(delete_index)
+ rows.each do |j|
+ row.delete_at(j)
+ end
copied_cols << row
end
if copied_cols.size == 0
else
new_matrix = GSL::Matrix[*copied_cols]
end
- new_keys = @keys.clone
- new_keys.delete_at(delete_index)
- return WinLossMatrix.new(new_keys, new_matrix)
- end
- ##
- # Removes players in a rows; [1,3,5]
- #
- def delete_rows(rows)
- obj = self
- rows.sort.reverse.each do |index|
- obj = obj.delete_row(index)
+ new_keys = @keys.clone
+ rows.each do |j|
+ new_keys.delete_at(j)
end
- obj
+
+ return WinLossMatrix.new(new_keys, new_matrix)
end
##
# Half-life effect
# After NHAFE_LIFE days value will get half.
# 0.693 is constant, where exp(0.693) ~ 0.5
-NHALF_LIFE=60
def half_life(days)
- if days < 7
+ if days < $options["half-life-ignore"]
return 1.0
else
- Math::exp(-0.693/NHALF_LIFE*(days-7))
+ Math::exp(-0.693/$options["half-life"]*(days-$options["half-life-ignore"]))
end
end
def _add_win_loss(winner, loser, time)
- how_long_days = (Time.now - time)/(3600*24)
+ how_long_days = ($options["base-date"] - time)/(3600*24)
$players[winner] ||= Hash.new { GSL::Vector[0,0] }
$players[loser] ||= Hash.new { GSL::Vector[0,0] }
$players[winner][loser] += GSL::Vector[1.0*half_life(how_long_days),0]
$players[loser][winner] += GSL::Vector[0,1.0*half_life(how_long_days)]
end
+def _add_draw(player1, player2, time)
+ how_long_days = ($options["base-date"] - time)/(3600*24)
+ $players[player1] ||= Hash.new { GSL::Vector[0,0] }
+ $players[player2] ||= Hash.new { GSL::Vector[0,0] }
+ $players[player1][player2] += GSL::Vector[0.5*half_life(how_long_days),0.5*half_life(how_long_days)]
+ $players[player2][player1] += GSL::Vector[0.5*half_life(how_long_days),0.5*half_life(how_long_days)]
+end
+
def _add_time(player, time)
$players_time[player] = time if $players_time[player] < time
end
elsif black_mark == LOSS_MARK && white_mark == WIN_MARK
_add_win_loss(white_name, black_name, time)
elsif black_mark == DRAW_MARK && white_mark == DRAW_MARK
- return
+ if $options["skip-draw-games"]
+ return
+ else
+ _add_draw(black_name, white_name, time)
+ end
else
raise "Never reached!"
end
id.gsub(/@.*?\+/,"+")
end
-def grep(file)
- str = File.open(file).read
-
- if /^N\+(.*)$/ =~ str then black_name = $1.strip end
- if /^N\-(.*)$/ =~ str then white_name = $1.strip end
-
- if /^'summary:(.*)$/ =~ str
- state, p1, p2 = $1.split(":").map {|a| a.strip}
- return if state == "abnormal"
- p1_name, p1_mark = p1.split(" ")
- p2_name, p2_mark = p2.split(" ")
- if p1_name == black_name
- black_name, black_mark = p1_name, p1_mark
- white_name, white_mark = p2_name, p2_mark
- elsif p2_name == black_name
- black_name, black_mark = p2_name, p2_mark
- white_name, white_mark = p1_name, p1_mark
- else
- raise "Never reach!: #{black} #{white} #{p3} #{p2}"
- end
+# Parse a game result line
+#
+def parse(line)
+ time, state, black_mark, black_id, white_id, white_mark, file = line.split("\t")
+ unless time && state && black_mark && black_id &&
+ white_id && white_mark && file
+ $stderr.puts "Failed to parse the line : #{line}"
+ return
end
- if /^'\$END_TIME:(.*)$/ =~ str
- time = Time.parse($1.strip)
+
+ return if state == "abnormal"
+ time = Time.parse(time)
+ return if $options["base-date"] < time
+ black_id = identify_id(black_id)
+ white_id = identify_id(white_id)
+
+ if black_id && white_id && (black_id != white_id) &&
+ black_mark && white_mark
+ add(black_mark, black_id, white_id, white_mark, time)
end
- if /^'rating:(.*)$/ =~ str
- black_id, white_id = $1.split(":").map {|a| a.strip}
- black_id = identify_id(black_id)
- white_id = identify_id(white_id)
- if black_id && white_id && (black_id != white_id)
- add(black_mark, black_id, white_id, white_mark, time)
+end
+
+def validate(yaml)
+ yaml["players"].each do |group_key, group|
+ group.each do |player_key, player|
+ rate = player['rate']
+ next unless rate
+ if rate > 10000 || rate < -10000
+ return false
+ end
end
end
+ return true
end
-def usage
- $stderr.puts <<-EOF
-USAGE: #{$0} dir [...]
- EOF
- exit 1
+def usage(io)
+ io.puts <<EOF
+USAGE: #{$0} [options] DIR..
+ DIR where CSA files are looked up recursively
+OPTOINS:
+ --base-date a base time point for this calicuration (default now). Ex. '2009-10-31'
+ --half-life n [days] (default 60)
+ --half-life-ignore m [days] (default 7)
+ after m days, half-life effect works
+ --fixed-rate-player player whose rate is fixed at the rate
+ --fixed-rate rate
+ --skip-draw-games skip draw games. [default: draw games are counted in
+ as 0.5 win and 0.5 lost]
+ --help show this message
+EOF
end
def main
- usage if ARGV.empty?
- while dir = ARGV.shift do
- Dir.glob( File.join(dir, "**", "*.csa") ) {|f| grep(f)}
+ $options = Hash::new
+ parser = GetoptLong.new(
+ ["--base-date", GetoptLong::REQUIRED_ARGUMENT],
+ ["--half-life", GetoptLong::REQUIRED_ARGUMENT],
+ ["--half-life-ignore", GetoptLong::REQUIRED_ARGUMENT],
+ ["--help", "-h", GetoptLong::NO_ARGUMENT],
+ ["--fixed-rate-player", GetoptLong::REQUIRED_ARGUMENT],
+ ["--fixed-rate", GetoptLong::REQUIRED_ARGUMENT],
+ ["--skip-draw-games", GetoptLong::NO_ARGUMENT])
+ parser.quiet = true
+ begin
+ parser.each_option do |name, arg|
+ name.sub!(/^--/, '')
+ $options[name] = arg.dup
+ end
+ if ( $options["fixed-rate-player"] && !$options["fixed-rate"]) ||
+ (!$options["fixed-rate-player"] && $options["fixed-rate"]) ||
+ ( $options["fixed-rate-player"] && $options["fixed-rate"].to_i <= 0)
+ usage($stderr)
+ exit 1
+ end
+ rescue
+ usage($stderr)
+ raise parser.error_message
+ end
+ if $options["help"]
+ usage($stdout)
+ exit 0
+ end
+ if $options["base-date"]
+ $options["base-date"] = Time::parse $options["base-date"]
+ else
+ $options["base-date"] = Time.now
+ end
+ $options["half-life"] ||= 60
+ $options["half-life"] = $options["half-life"].to_i
+ $options["half-life-ignore"] ||= 7
+ $options["half-life-ignore"] = $options["half-life-ignore"].to_i
+ $options["fixed-rate"] = $options["fixed-rate"].to_i if $options["fixed-rate"]
+
+ if ARGV.empty?
+ while line = $stdin.gets do
+ parse line.strip
+ end
+ else
+ while file = ARGV.shift do
+ File.open(file) do |f|
+ f.each_line do |line|
+ parse line.strip
+ end
+ end
+ end
end
yaml = {}
rating.average!(Rating::AVERAGE_RATE)
rating.integer!
+ if $options["fixed-rate-player"]
+ # first, try exact match
+ index = win_loss_matrix.keys.index($options["fixed-rate-player"])
+ # second, try regular match
+ unless index
+ win_loss_matrix.keys.each_with_index do |p, i|
+ if %r!#{$options["fixed-rate-player"]}! =~ p
+ index = i
+ end
+ end
+ end
+ if index
+ the_rate = rating.rate[index]
+ rating.translate!($options["fixed-rate"] - the_rate)
+ end
+ end
+
win_loss_matrix.keys.each_with_index do |p, i| # player_id, index#
win = win_loss_matrix.matrix.row(i).sum
loss = win_loss_matrix.matrix.col(i).sum
'win' => v[0],
'loss' => v[1]}
end
+ unless validate(yaml)
+ $stderr.puts "Aborted. It did not result in valid ratings."
+ $stderr.puts yaml.to_yaml if $DEBUG
+ exit 10
+ end
puts yaml.to_yaml
end