Rename TranspositionTable 'writes' in 'overwrites'
[stockfish] / src / tt.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-2010 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
21 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cmath>
27 #include <cstring>
28
29 #include "movegen.h"
30 #include "tt.h"
31
32 // The main transposition table
33 TranspositionTable TT;
34
35 ////
36 //// Functions
37 ////
38
39 TranspositionTable::TranspositionTable() {
40
41   size = overwrites = 0;
42   entries = 0;
43   generation = 0;
44 }
45
46 TranspositionTable::~TranspositionTable() {
47
48   delete [] entries;
49 }
50
51
52 /// TranspositionTable::set_size sets the size of the transposition table,
53 /// measured in megabytes.
54
55 void TranspositionTable::set_size(size_t mbSize) {
56
57   size_t newSize = 1024;
58
59   // We store a cluster of ClusterSize number of TTEntry for each position
60   // and newSize is the maximum number of storable positions.
61   while ((2 * newSize) * sizeof(TTCluster) <= (mbSize << 20))
62       newSize *= 2;
63
64   if (newSize != size)
65   {
66       size = newSize;
67       delete [] entries;
68       entries = new TTCluster[size];
69       if (!entries)
70       {
71           std::cerr << "Failed to allocate " << mbSize
72                     << " MB for transposition table." << std::endl;
73           Application::exit_with_failure();
74       }
75       clear();
76   }
77 }
78
79
80 /// TranspositionTable::clear overwrites the entire transposition table
81 /// with zeroes. It is called whenever the table is resized, or when the
82 /// user asks the program to clear the table (from the UCI interface).
83 /// Perhaps we should also clear it when the "ucinewgame" command is recieved?
84
85 void TranspositionTable::clear() {
86
87   memset(entries, 0, size * sizeof(TTCluster));
88 }
89
90
91 /// TranspositionTable::store writes a new entry containing a position,
92 /// a value, a value type, a search depth, and a best move to the
93 /// transposition table. Transposition table is organized in clusters of
94 /// four TTEntry objects, and when a new entry is written, it replaces
95 /// the least valuable of the four entries in a cluster. A TTEntry t1 is
96 /// considered to be more valuable than a TTEntry t2 if t1 is from the
97 /// current search and t2 is from a previous search, or if the depth of t1
98 /// is bigger than the depth of t2. A TTEntry of type VALUE_TYPE_EVAL
99 /// never replaces another entry for the same position.
100
101 void TranspositionTable::store(const Key posKey, Value v, ValueType t, Depth d, Move m, Value statV, Value kingD) {
102
103   int c1, c2, c3;
104   TTEntry *tte, *replace;
105   uint32_t posKey32 = posKey >> 32; // Use the high 32 bits as key
106
107   tte = replace = first_entry(posKey);
108   for (int i = 0; i < ClusterSize; i++, tte++)
109   {
110       if (!tte->key() || tte->key() == posKey32) // empty or overwrite old
111       {
112           // Preserve any exsisting ttMove
113           if (m == MOVE_NONE)
114               m = tte->move();
115
116           tte->save(posKey32, v, t, d, m, generation, statV, kingD);
117           return;
118       }
119
120       if (i == 0)  // replace would be a no-op in this common case
121           continue;
122
123       c1 = (replace->generation() == generation ?  2 : 0);
124       c2 = (tte->generation() == generation ? -2 : 0);
125       c3 = (tte->depth() < replace->depth() ?  1 : 0);
126
127       if (c1 + c2 + c3 > 0)
128           replace = tte;
129   }
130   replace->save(posKey32, v, t, d, m, generation, statV, kingD);
131   overwrites++;
132 }
133
134
135 /// TranspositionTable::retrieve looks up the current position in the
136 /// transposition table. Returns a pointer to the TTEntry or NULL
137 /// if position is not found.
138
139 TTEntry* TranspositionTable::retrieve(const Key posKey) const {
140
141   uint32_t posKey32 = posKey >> 32;
142   TTEntry* tte = first_entry(posKey);
143
144   for (int i = 0; i < ClusterSize; i++, tte++)
145       if (tte->key() == posKey32)
146           return tte;
147
148   return NULL;
149 }
150
151
152 /// TranspositionTable::new_search() is called at the beginning of every new
153 /// search. It increments the "generation" variable, which is used to
154 /// distinguish transposition table entries from previous searches from
155 /// entries from the current search.
156
157 void TranspositionTable::new_search() {
158
159   generation++;
160   overwrites = 0;
161 }
162
163
164 /// TranspositionTable::insert_pv() is called at the end of a search
165 /// iteration, and inserts the PV back into the PV. This makes sure
166 /// the old PV moves are searched first, even if the old TT entries
167 /// have been overwritten.
168
169 void TranspositionTable::insert_pv(const Position& pos, Move pv[]) {
170
171   StateInfo st;
172   Position p(pos, pos.thread());
173
174   for (int i = 0; pv[i] != MOVE_NONE; i++)
175   {
176       TTEntry *tte = retrieve(p.get_key());
177       if (!tte || tte->move() != pv[i])
178           store(p.get_key(), VALUE_NONE, VALUE_TYPE_NONE, Depth(-127*OnePly), pv[i], VALUE_NONE, VALUE_NONE);
179       p.do_move(pv[i], st);
180   }
181 }
182
183
184 /// TranspositionTable::extract_pv() extends a PV by adding moves from the
185 /// transposition table at the end. This should ensure that the PV is almost
186 /// always at least two plies long, which is important, because otherwise we
187 /// will often get single-move PVs when the search stops while failing high,
188 /// and a single-move PV means that we don't have a ponder move.
189
190 void TranspositionTable::extract_pv(const Position& pos, Move bestMove, Move pv[], const int PLY_MAX) {
191
192   const TTEntry* tte;
193   StateInfo st;
194   Position p(pos, pos.thread());
195   int ply = 0;
196
197   assert(bestMove != MOVE_NONE);
198
199   pv[ply] = bestMove;
200   p.do_move(pv[ply++], st);
201
202   // Extract moves from TT when possible. We try hard to always
203   // get a ponder move, that's the reason of ply < 2 conditions.
204   while (   (tte = retrieve(p.get_key())) != NULL
205          && tte->move() != MOVE_NONE
206          && (tte->type() == VALUE_TYPE_EXACT || ply < 2)
207          && move_is_legal(p, tte->move())
208          && (!p.is_draw() || ply < 2)
209          && ply < PLY_MAX)
210   {
211       pv[ply] = tte->move();
212       p.do_move(pv[ply++], st);
213   }
214   pv[ply] = MOVE_NONE;
215 }
216
217
218 /// TranspositionTable::full() returns the permill of all transposition table
219 /// entries which have received at least one overwrite during the current search.
220 /// It is used to display the "info hashfull ..." information in UCI.
221
222 int TranspositionTable::full() const {
223
224   double N = double(size) * ClusterSize;
225   return int(1000 * (1 - exp(overwrites * log(1.0 - 1.0/N))));
226 }