Remove some comments in timeman.cpp
[stockfish] / src / timeman.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2014 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include <algorithm>
21 #include <cfloat>
22 #include <cmath>
23
24 #include "search.h"
25 #include "timeman.h"
26 #include "uci.h"
27
28 namespace {
29
30   enum TimeType { OptimumTime, MaxTime };
31
32   const int MoveHorizon   = 50;   // Plan time management at most this many moves ahead
33   const double MaxRatio   = 7.0;  // When in trouble, we can step over reserved time with this ratio
34   const double StealRatio = 0.33; // However we must not steal time from remaining moves over this ratio
35
36   const double xscale     = 9.3;
37   const double xshift     = 59.8;
38   const double skewfactor = 0.172;
39
40
41   // move_importance() is a skew-logistic function based on naive statistical
42   // analysis of "how many games are still undecided after n half-moves". Game
43   // is considered "undecided" as long as neither side has >275cp advantage.
44   // Data was extracted from CCRL game database with some simple filtering criteria.
45
46   double move_importance(int ply) {
47
48     return pow((1 + exp((ply - xshift) / xscale)), -skewfactor) + DBL_MIN; // Ensure non-zero
49   }
50
51   template<TimeType T>
52   int remaining(int myTime, int movesToGo, int currentPly, int slowMover)
53   {
54     const double TMaxRatio   = (T == OptimumTime ? 1 : MaxRatio);
55     const double TStealRatio = (T == OptimumTime ? 0 : StealRatio);
56
57     double thisMoveImportance = (move_importance(currentPly) * slowMover) / 100;
58     double otherMovesImportance = 0;
59
60     for (int i = 1; i < movesToGo; ++i)
61         otherMovesImportance += move_importance(currentPly + 2 * i);
62
63     double ratio1 = (TMaxRatio * thisMoveImportance) / (TMaxRatio * thisMoveImportance + otherMovesImportance);
64     double ratio2 = (thisMoveImportance + TStealRatio * otherMovesImportance) / (thisMoveImportance + otherMovesImportance);
65
66     return int(myTime * std::min(ratio1, ratio2));
67   }
68
69 } // namespace
70
71
72 void TimeManager::init(const Search::LimitsType& limits, int currentPly, Color us)
73 {
74   /* We support four different kinds of time controls:
75
76       increment == 0 && movesToGo == 0 means: x basetime  [sudden death!]
77       increment == 0 && movesToGo != 0 means: x moves in y minutes
78       increment >  0 && movesToGo == 0 means: x basetime + z increment
79       increment >  0 && movesToGo != 0 means: x moves in y minutes + z increment
80   */
81
82   int hypMTG, hypMyTime, t1, t2;
83
84   // Read uci parameters
85   int moveOverhead    = Options["Move Overhead"];
86   int minThinkingTime = Options["Minimum Thinking Time"];
87   int slowMover       = Options["Slow Mover"];
88
89   // Initialize unstablePvFactor to 1 and search times to maximum values
90   unstablePvFactor = 1;
91   optimumSearchTime = maximumSearchTime = std::max(limits.time[us], minThinkingTime);
92
93   // We calculate optimum time usage for different hypothetical "moves to go"-values and choose the
94   // minimum of calculated search time values. Usually the greatest hypMTG gives the minimum values.
95   for (hypMTG = 1; hypMTG <= (limits.movestogo ? std::min(limits.movestogo, MoveHorizon) : MoveHorizon); ++hypMTG)
96   {
97       // Calculate thinking time for hypothetical "moves to go"-value
98       hypMyTime =  limits.time[us]
99                  + limits.inc[us] * (hypMTG - 1)
100                  - moveOverhead * (2 + std::min(hypMTG, 40));
101
102       hypMyTime = std::max(hypMyTime, 0);
103
104       t1 = minThinkingTime + remaining<OptimumTime>(hypMyTime, hypMTG, currentPly, slowMover);
105       t2 = minThinkingTime + remaining<MaxTime>(hypMyTime, hypMTG, currentPly, slowMover);
106
107       optimumSearchTime = std::min(optimumSearchTime, t1);
108       maximumSearchTime = std::min(maximumSearchTime, t2);
109   }
110
111   if (Options["Ponder"])
112       optimumSearchTime += optimumSearchTime / 4;
113
114   // Make sure that maxSearchTime is not over absoluteMaxSearchTime
115   optimumSearchTime = std::min(optimumSearchTime, maximumSearchTime);
116 }