-/// The TTEntry is the class of transposition table entries
-///
-/// A TTEntry needs 128 bits to be stored
-///
-/// bit 0-31: key
-/// bit 32-63: data
-/// bit 64-79: value
-/// bit 80-95: depth
-/// bit 96-111: static value
-/// bit 112-127: margin of static value
-///
-/// the 32 bits of the data field are so defined
-///
-/// bit 0-15: move
-/// bit 16-20: not used
-/// bit 21-22: value type
-/// bit 23-31: generation
-
-class TTEntry {
-
-public:
- void save(uint32_t k, Value v, Bound b, Depth d, Move m, int g, Value ev, Value em) {
-
- key32 = (uint32_t)k;
- move16 = (uint16_t)m;
- bound = (uint8_t)b;
- generation8 = (uint8_t)g;
- value16 = (int16_t)v;
- depth16 = (int16_t)d;
- evalValue = (int16_t)ev;
- evalMargin = (int16_t)em;
- }
- void set_generation(int g) { generation8 = (uint8_t)g; }
-
- uint32_t key() const { return key32; }
- Depth depth() const { return (Depth)depth16; }
- Move move() const { return (Move)move16; }
- Value value() const { return (Value)value16; }
- Bound type() const { return (Bound)bound; }
- int generation() const { return (int)generation8; }
- Value eval_value() const { return (Value)evalValue; }
- Value eval_margin() const { return (Value)evalMargin; }
-
-private:
- uint32_t key32;
- uint16_t move16;
- uint8_t bound, generation8;
- int16_t value16, depth16, evalValue, evalMargin;
+namespace Stockfish {
+
+class ThreadPool;
+struct TTEntry;
+struct Cluster;
+
+// There is only one global hash table for the engine and all its threads. For chess in particular, we even allow racy
+// updates between threads to and from the TT, as taking the time to synchronize access would cost thinking time and
+// thus elo. As a hash table, collisions are possible and may cause chess playing issues (bizarre blunders, faulty mate
+// reports, etc). Fixing these also loses elo; however such risk decreases quickly with larger TT size.
+//
+// `probe` is the primary method: given a board position, we lookup its entry in the table, and return a tuple of:
+// 1) whether the entry already has this position
+// 2) a copy of the prior data (if any) (may be inconsistent due to read races)
+// 3) a writer object to this entry
+// The copied data and the writer are separated to maintain clear boundaries between local vs global objects.
+
+
+// A copy of the data already in the entry (possibly collided). `probe` may be racy, resulting in inconsistent data.
+struct TTData {
+ Move move;
+ Value value, eval;
+ Depth depth;
+ Bound bound;
+ bool is_pv;