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