An VALUE_TYPE_EVAL score cannot overwrite an entry
[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 Marco Costalba
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 "tt.h"
30
31
32 ////
33 //// Functions
34 ////
35
36 /// Constructor
37
38 TranspositionTable::TranspositionTable(unsigned mbSize) {
39
40   size = 0;
41   generation = 0;
42   writes = 0;
43   entries = 0;
44   set_size(mbSize);
45 }
46
47
48 /// Destructor
49
50 TranspositionTable::~TranspositionTable() {
51
52   delete [] entries;
53 }
54
55
56 /// TranspositionTable::set_size sets the size of the transposition table,
57 /// measured in megabytes.
58
59 void TranspositionTable::set_size(unsigned mbSize) {
60
61   assert(mbSize >= 4 && mbSize <= 1024);
62
63   unsigned newSize = 1024;
64
65   // We store a cluster of 4 TTEntry for each position and newSize is
66   // the maximum number of storable positions
67   for ( ; newSize * 4 * (sizeof(TTEntry)) <= (mbSize << 20); newSize *= 2);
68   newSize /= 2;
69   if (newSize != size)
70   {
71     size = newSize;
72     delete [] entries;
73     entries = new TTEntry[size * 4];
74     if (!entries)
75     {
76       std::cerr << "Failed to allocate " << mbSize
77                 << " MB for transposition table."
78                 << std::endl;
79       exit(EXIT_FAILURE);
80     }
81     clear();
82   }
83 }
84
85
86 /// TranspositionTable::clear overwrites the entire transposition table
87 /// with zeroes.  It is called whenever the table is resized, or when the
88 /// user asks the program to clear the table (from the UCI interface).
89 /// Perhaps we should also clear it when the "ucinewgame" command is recieved?
90
91 void TranspositionTable::clear() {
92
93   memset(entries, 0, size * 4 * sizeof(TTEntry));
94 }
95
96
97 /// TranspositionTable::store writes a new entry containing a position,
98 /// a value, a value type, a search depth, and a best move to the
99 /// transposition table.  The transposition table is organized in clusters
100 /// of four TTEntry objects, and when a new entry is written, it replaces
101 /// the least valuable of the four entries in a cluster.  A TTEntry t1 is
102 /// considered to be more valuable than a TTEntry t2 if t1 is from the
103 /// current search and t2 is from a previous search, or if the depth of t1
104 /// is bigger than the depth of t2. A TTEntry of type VALUE_TYPE_EVAL
105 /// never replaces another entry for the same position.
106
107 TTEntry* TranspositionTable::store(const Position &pos, Value v, Depth d,
108                                Move m, ValueType type) {
109   TTEntry *tte, *replace;
110
111   tte = replace = first_entry(pos);
112   for (int i = 0; i < 4; i++, tte++)
113   {
114     if (!tte->key() || tte->key() == pos.get_key()) // empty or overwrite old
115     {
116         // Do not overwrite position entry when VALUE_TYPE_EVAL
117         if (   tte->key()
118             && type == VALUE_TYPE_EVAL)
119             return NULL;
120
121         if (m == MOVE_NONE)
122             m = tte->move();
123
124         *tte = TTEntry(pos.get_key(), v, type, d, m, generation);
125         return tte;
126     }
127     else if (i == 0)  // replace would be a no-op in this common case
128         continue;
129
130     int c1 = (replace->generation() == generation ?  2 : 0);
131     int c2 = (tte->generation() == generation ? -2 : 0);
132     int c3 = (tte->depth() < replace->depth() ?  1 : 0);
133
134     if (c1 + c2 + c3 > 0)
135         replace = tte;
136   }
137   *replace = TTEntry(pos.get_key(), v, type, d, m, generation);
138   writes++;
139   return replace;
140 }
141
142
143 /// TranspositionTable::retrieve looks up the current position in the
144 /// transposition table. Returns a pointer to the TTEntry or NULL
145 /// if position is not found.
146
147 TTEntry* TranspositionTable::retrieve(const Position &pos) const {
148
149   TTEntry *tte = first_entry(pos);
150
151   for (int i = 0; i < 4; i++, tte++)
152   {
153       if (tte->key() == pos.get_key())
154           return tte;
155   }
156   return NULL;
157 }
158
159
160 /// TranspositionTable::first_entry returns a pointer to the first
161 /// entry of a cluster given a position.
162
163 inline TTEntry* TranspositionTable::first_entry(const Position &pos) const {
164
165   return entries + (int(pos.get_key() & (size - 1)) << 2);
166 }
167
168 /// TranspositionTable::new_search() is called at the beginning of every new
169 /// search.  It increments the "generation" variable, which is used to
170 /// distinguish transposition table entries from previous searches from
171 /// entries from the current search.
172
173 void TranspositionTable::new_search() {
174
175   generation++;
176   writes = 0;
177 }
178
179
180 /// TranspositionTable::insert_pv() is called at the end of a search
181 /// iteration, and inserts the PV back into the PV.  This makes sure the
182 /// old PV moves are searched first, even if the old TT entries have been
183 /// overwritten.
184
185 void TranspositionTable::insert_pv(const Position &pos, Move pv[]) {
186
187   StateInfo st;
188   Position p(pos);
189
190   for (int i = 0; pv[i] != MOVE_NONE; i++)
191   {
192     store(p, VALUE_NONE, Depth(-127*OnePly), pv[i], VALUE_TYPE_NONE);
193     p.do_move(pv[i], st);
194   }
195 }
196
197
198 /// TranspositionTable::full() returns the permill of all transposition table
199 /// entries which have received at least one write during the current search.
200 /// It is used to display the "info hashfull ..." information in UCI.
201
202 int TranspositionTable::full() {
203
204   double N = double(size) * 4.0;
205   return int(1000 * (1 - exp(writes * log(1.0 - 1.0/N))));
206 }
207
208
209 /// Constructors
210
211 TTEntry::TTEntry() {
212 }
213
214 TTEntry::TTEntry(Key k, Value v, ValueType t, Depth d, Move m,
215                  int generation) :
216   key_ (k), data((m & 0x1FFFF) | (t << 20) | (generation << 23)),
217   value_(int16_t(v)), depth_(int16_t(d)) {}