Prefer int to uint8_t when possible
[stockfish] / src / tt.h
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 #if !defined(TT_H_INCLUDED)
22 #define TT_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "depth.h"
29 #include "move.h"
30 #include "value.h"
31
32
33 ////
34 //// Types
35 ////
36
37 /// The TTEntry class is the class of transposition table entries
38 ///
39 /// A TTEntry needs 128 bits to be stored
40 ///
41 /// bit  0-31: key
42 /// bit 32-63: data
43 /// bit 64-79: value
44 /// bit 80-95: depth
45 /// bit 96-111: static value
46 /// bit 112-127: margin of static value
47 ///
48 /// the 32 bits of the data field are so defined
49 ///
50 /// bit  0-16: move
51 /// bit 17-20: not used
52 /// bit 21-22: value type
53 /// bit 23-31: generation
54
55 class TTEntry {
56
57 public:
58   void save(uint32_t k, Value v, ValueType t, Depth d, Move m, int g, Value statV, Value kd) {
59
60       key32 = k;
61       data = (m & 0x1FFFF) | (t << 21) | (g << 23);
62       value16     = int16_t(v);
63       depth16     = int16_t(d);
64       staticValue = int16_t(statV);
65       staticValueMargin  = int16_t(kd);
66   }
67   void set_generation(int g) { data = move() | (type() << 21) | (g << 23); }
68
69   uint32_t key() const { return key32; }
70   Depth depth() const { return Depth(depth16); }
71   Move move() const { return Move(data & 0x1FFFF); }
72   Value value() const { return Value(value16); }
73   ValueType type() const { return ValueType((data >> 21) & 3); }
74   int generation() const { return data >> 23; }
75   Value static_value() const { return Value(staticValue); }
76   Value static_value_margin() const { return Value(staticValueMargin); }
77
78 private:
79   uint32_t key32;
80   uint32_t data;
81   int16_t value16;
82   int16_t depth16;
83   int16_t staticValue;
84   int16_t staticValueMargin;
85 };
86
87
88 /// This is the number of TTEntry slots for each cluster
89 const int ClusterSize = 4;
90
91 /// TTCluster consists of ClusterSize number of TTEntries.
92 /// Size of TTCluster must not be bigger than a cache line size.
93 /// In case it is less, it should be padded to guarantee always aligned accesses.
94
95 struct TTCluster {
96   TTEntry data[ClusterSize];
97 };
98
99
100 /// The transposition table class. This is basically just a huge array
101 /// containing TTCluster objects, and a few methods for writing new entries
102 /// and reading new ones.
103
104 class TranspositionTable {
105
106   TranspositionTable(const TranspositionTable&);
107   TranspositionTable& operator=(const TranspositionTable&);
108
109 public:
110   TranspositionTable();
111   ~TranspositionTable();
112   void set_size(size_t mbSize);
113   void clear();
114   void store(const Key posKey, Value v, ValueType type, Depth d, Move m, Value statV, Value kingD);
115   TTEntry* retrieve(const Key posKey) const;
116   void new_search();
117   TTEntry* first_entry(const Key posKey) const;
118   void refresh(const TTEntry* tte) const;
119
120 private:
121   size_t size;
122   TTCluster* entries;
123   int generation;
124 };
125
126 extern TranspositionTable TT;
127
128
129 /// TranspositionTable::first_entry returns a pointer to the first
130 /// entry of a cluster given a position. The lowest order bits of the key
131 /// are used to get the index of the cluster.
132
133 inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
134
135   return entries[uint32_t(posKey) & (size - 1)].data;
136 }
137
138
139 /// TranspositionTable::refresh updates the 'generation' value of the TTEntry
140 /// to avoid aging. Normally called after a TT hit, before to return.
141
142 inline void TranspositionTable::refresh(const TTEntry* tte) const {
143
144   const_cast<TTEntry*>(tte)->set_generation(generation);
145 }
146
147 #endif // !defined(TT_H_INCLUDED)