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
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.
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.
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/>.
20 #if !defined(TT_H_INCLUDED)
26 /// The TTEntry is the class of transposition table entries
28 /// A TTEntry needs 128 bits to be stored
34 /// bit 96-111: static value
35 /// bit 112-127: margin of static value
37 /// the 32 bits of the data field are so defined
40 /// bit 16-20: not used
41 /// bit 21-22: value type
42 /// bit 23-31: generation
47 void save(uint32_t k, Value v, Bound b, Depth d, Move m, int g) {
52 generation8 = (uint8_t)g;
53 valueUpper = (int16_t)(b & BOUND_UPPER ? v : VALUE_NONE);
54 depthUpper = (int16_t)(b & BOUND_UPPER ? d : DEPTH_NONE);
55 valueLower = (int16_t)(b & BOUND_LOWER ? v : VALUE_NONE);
56 depthLower = (int16_t)(b & BOUND_LOWER ? d : DEPTH_NONE);
59 void update(Value v, Bound b, Depth d, Move m, int g) {
62 generation8 = (uint8_t)g;
64 if (bound == BOUND_EXACT)
65 bound = BOUND_UPPER | BOUND_LOWER; // Drop 'EXACT' flag
69 valueUpper = (int16_t)v;
70 depthUpper = (int16_t)d;
72 if ((bound & BOUND_LOWER) && v < valueLower)
75 valueLower = VALUE_NONE;
76 depthLower = DEPTH_NONE;
82 valueLower = (int16_t)v;
83 depthLower = (int16_t)d;
85 if ((bound & BOUND_UPPER) && v > valueUpper)
88 valueUpper = VALUE_NONE;
89 depthUpper = DEPTH_NONE;
96 void set_generation(int g) { generation8 = (uint8_t)g; }
98 uint32_t key() const { return key32; }
99 Depth depth() const { return (Depth)depthLower; }
100 Depth depth_upper() const { return (Depth)depthUpper; }
101 Move move() const { return (Move)move16; }
102 Value value() const { return (Value)valueLower; }
103 Value value_upper() const { return (Value)valueUpper; }
104 Bound type() const { return (Bound)bound; }
105 int generation() const { return (int)generation8; }
110 uint8_t bound, generation8;
111 int16_t valueLower, depthLower, valueUpper, depthUpper;
115 /// This is the number of TTEntry slots for each cluster
116 const int ClusterSize = 4;
119 /// TTCluster consists of ClusterSize number of TTEntries. Size of TTCluster
120 /// must not be bigger than a cache line size. In case it is less, it should
121 /// be padded to guarantee always aligned accesses.
124 TTEntry data[ClusterSize];
128 /// The transposition table class. This is basically just a huge array containing
129 /// TTCluster objects, and a few methods for writing and reading entries.
131 class TranspositionTable {
133 TranspositionTable(const TranspositionTable&);
134 TranspositionTable& operator=(const TranspositionTable&);
137 TranspositionTable();
138 ~TranspositionTable();
139 void set_size(size_t mbSize);
141 void store(const Key posKey, Value v, Bound b, Depth d, Move m);
142 TTEntry* probe(const Key posKey) const;
144 TTEntry* first_entry(const Key posKey) const;
145 void refresh(const TTEntry* tte) const;
150 uint8_t generation; // Size must be not bigger then TTEntry::generation8
153 extern TranspositionTable TT;
156 /// TranspositionTable::first_entry() returns a pointer to the first entry of
157 /// a cluster given a position. The lowest order bits of the key are used to
158 /// get the index of the cluster.
160 inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
162 return entries[((uint32_t)posKey) & (size - 1)].data;
166 /// TranspositionTable::refresh() updates the 'generation' value of the TTEntry
167 /// to avoid aging. Normally called after a TT hit.
169 inline void TranspositionTable::refresh(const TTEntry* tte) const {
171 const_cast<TTEntry*>(tte)->set_generation(generation);
174 #endif // !defined(TT_H_INCLUDED)