Rename ValueType to Bound
[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-2012 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 <cstring>
21 #include <iostream>
22
23 #include "tt.h"
24
25 TranspositionTable TT; // Our global transposition table
26
27 TranspositionTable::TranspositionTable() {
28
29   size = generation = 0;
30   entries = NULL;
31 }
32
33 TranspositionTable::~TranspositionTable() {
34
35   delete [] entries;
36 }
37
38
39 /// TranspositionTable::set_size() sets the size of the transposition table,
40 /// measured in megabytes.
41
42 void TranspositionTable::set_size(size_t mbSize) {
43
44   size_t newSize = 1024;
45
46   // Transposition table consists of clusters and each cluster consists
47   // of ClusterSize number of TTEntries. Each non-empty entry contains
48   // information of exactly one position and newSize is the number of
49   // clusters we are going to allocate.
50   while (2ULL * newSize * sizeof(TTCluster) <= (mbSize << 20))
51       newSize *= 2;
52
53   if (newSize == size)
54       return;
55
56   size = newSize;
57   delete [] entries;
58   entries = new (std::nothrow) TTCluster[size];
59   if (!entries)
60   {
61       std::cerr << "Failed to allocate " << mbSize
62                 << "MB for transposition table." << std::endl;
63       exit(EXIT_FAILURE);
64   }
65   clear();
66 }
67
68
69 /// TranspositionTable::clear() overwrites the entire transposition table
70 /// with zeroes. It is called whenever the table is resized, or when the
71 /// user asks the program to clear the table (from the UCI interface).
72
73 void TranspositionTable::clear() {
74
75   memset(entries, 0, size * sizeof(TTCluster));
76 }
77
78
79 /// TranspositionTable::store() writes a new entry containing position key and
80 /// valuable information of current position. The lowest order bits of position
81 /// key are used to decide on which cluster the position will be placed.
82 /// When a new entry is written and there are no empty entries available in cluster,
83 /// it replaces the least valuable of entries. A TTEntry t1 is considered to be
84 /// more valuable than a TTEntry t2 if t1 is from the current search and t2 is from
85 /// a previous search, or if the depth of t1 is bigger than the depth of t2.
86
87 void TranspositionTable::store(const Key posKey, Value v, Bound t, Depth d, Move m, Value statV, Value kingD) {
88
89   int c1, c2, c3;
90   TTEntry *tte, *replace;
91   uint32_t posKey32 = posKey >> 32; // Use the high 32 bits as key inside the cluster
92
93   tte = replace = first_entry(posKey);
94
95   for (int i = 0; i < ClusterSize; i++, tte++)
96   {
97       if (!tte->key() || tte->key() == posKey32) // Empty or overwrite old
98       {
99           // Preserve any existing ttMove
100           if (m == MOVE_NONE)
101               m = tte->move();
102
103           tte->save(posKey32, v, t, d, m, generation, statV, kingD);
104           return;
105       }
106
107       // Implement replace strategy
108       c1 = (replace->generation() == generation ?  2 : 0);
109       c2 = (tte->generation() == generation || tte->type() == BOUND_EXACT ? -2 : 0);
110       c3 = (tte->depth() < replace->depth() ?  1 : 0);
111
112       if (c1 + c2 + c3 > 0)
113           replace = tte;
114   }
115   replace->save(posKey32, v, t, d, m, generation, statV, kingD);
116 }
117
118
119 /// TranspositionTable::probe() looks up the current position in the
120 /// transposition table. Returns a pointer to the TTEntry or NULL if
121 /// position is not found.
122
123 TTEntry* TranspositionTable::probe(const Key posKey) const {
124
125   uint32_t posKey32 = posKey >> 32;
126   TTEntry* tte = first_entry(posKey);
127
128   for (int i = 0; i < ClusterSize; i++, tte++)
129       if (tte->key() == posKey32)
130           return tte;
131
132   return NULL;
133 }
134
135
136 /// TranspositionTable::new_search() is called at the beginning of every new
137 /// search. It increments the "generation" variable, which is used to
138 /// distinguish transposition table entries from previous searches from
139 /// entries from the current search.
140
141 void TranspositionTable::new_search() {
142   generation++;
143 }