]> git.sesse.net Git - stockfish/blobdiff - src/tt.h
Retire eval margin and gains
[stockfish] / src / tt.h
index 6c7caf75fce19bbab5c55886a26e6d75f27f47c1..fb50ddfcf03b5d75237b9de4e5847234cd69232c 100644 (file)
--- a/src/tt.h
+++ b/src/tt.h
@@ -1,7 +1,7 @@
 /*
   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
-  Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad
+  Copyright (C) 2008-2013 Marco Costalba, Joona Kiiski, Tord Romstad
 
   Stockfish is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#if !defined(TT_H_INCLUDED)
+#ifndef TT_H_INCLUDED
 #define TT_H_INCLUDED
 
 #include "misc.h"
 #include "types.h"
 
-/// The TTEntry is the class of transposition table entries
+/// The TTEntry is the 128 bit transposition table entry, defined as below:
 ///
-/// 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) {
-
-    key32       = (uint32_t)k;
-    move16      = (uint16_t)m;
-    bound       = (uint8_t)b;
-    generation8 = (uint8_t)g;
-    valueUpper = (int16_t)(b & BOUND_UPPER ? v : VALUE_NONE);
-    depthUpper = (int16_t)(b & BOUND_UPPER ? d : DEPTH_NONE);
-    valueLower = (int16_t)(b & BOUND_LOWER ? v : VALUE_NONE);
-    depthLower = (int16_t)(b & BOUND_LOWER ? d : DEPTH_NONE);
-  }
-
-  void update(Value v, Bound b, Depth d, Move m, int g) {
-
-    move16      = (uint16_t)m;
-    bound      |= (uint8_t)b;
-    generation8 = (uint8_t)g;
-
-    if (b & BOUND_UPPER)
-    {
-        valueUpper = (int16_t)v;
-        depthUpper = (int16_t)d;
-    }
-
-    if (b & BOUND_LOWER)
-    {
-        valueLower = (int16_t)v;
-        depthLower = (int16_t)d;
-    }
+/// key: 32 bit
+/// move: 16 bit
+/// bound type: 8 bit
+/// generation: 8 bit
+/// value: 16 bit
+/// depth: 16 bit
+/// static value: 16 bit
+/// static margin: 16 bit
+
+struct TTEntry {
+
+  void save(uint32_t k, Value v, Bound b, Depth d, Move m, int g, Value ev) {
+
+    key32        = (uint32_t)k;
+    move16       = (uint16_t)m;
+    bound8       = (uint8_t)b;
+    generation8  = (uint8_t)g;
+    value16      = (int16_t)v;
+    depth16      = (int16_t)d;
+    evalValue    = (int16_t)ev;
   }
+  void set_generation(uint8_t g) { generation8 = g; }
 
-  void set_generation(int g) { generation8 = (uint8_t)g; }
-
-  uint32_t key() const              { return key32; }
-  Depth depth() const               { return (Depth)depthLower; }
-  Depth depth_upper() const         { return (Depth)depthUpper; }
-  Move move() const                 { return (Move)move16; }
-  Value value() const               { return (Value)valueLower; }
-  Value value_upper() const         { return (Value)valueUpper; }
-  Bound type() const                { return (Bound)bound; }
-  int generation() const            { return (int)generation8; }
+  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 bound() const       { return (Bound)bound8; }
+  int generation() const    { return (int)generation8; }
+  Value eval_value() const  { return (Value)evalValue; }
 
 private:
   uint32_t key32;
   uint16_t move16;
-  uint8_t bound, generation8;
-  int16_t valueLower, depthLower, valueUpper, depthUpper;
-};
-
-
-/// This is the number of TTEntry slots for each cluster
-const int ClusterSize = 4;
-
-
-/// TTCluster consists of ClusterSize number of TTEntries. Size of TTCluster
-/// must not be bigger than a cache line size. In case it is less, it should
-/// be padded to guarantee always aligned accesses.
-
-struct TTCluster {
-  TTEntry data[ClusterSize];
+  uint8_t bound8, generation8;
+  int16_t value16, depth16, evalValue;
 };
 
 
-/// The transposition table class. This is basically just a huge array containing
-/// TTCluster objects, and a few methods for writing and reading entries.
+/// A TranspositionTable consists of a power of 2 number of clusters and each
+/// cluster consists of ClusterSize number of TTEntry. Each non-empty entry
+/// contains information of exactly one position. Size of a cluster shall not be
+/// bigger than a cache line size. In case it is less, it should be padded to
+/// guarantee always aligned accesses.
 
 class TranspositionTable {
 
-  TranspositionTable(const TranspositionTable&);
-  TranspositionTable& operator=(const TranspositionTable&);
+  static const unsigned ClusterSize = 4; // A cluster is 64 Bytes
 
 public:
-  TranspositionTable();
-  ~TranspositionTable();
+ ~TranspositionTable() { free(mem); }
+  void new_search() { ++generation; }
+
+  const TTEntry* probe(const Key key) const;
+  TTEntry* first_entry(const Key key) const;
+  void refresh(const TTEntry* tte) const;
   void set_size(size_t mbSize);
   void clear();
-  void store(const Key posKey, Value v, Bound b, Depth d, Move m);
-  TTEntry* probe(const Key posKey) const;
-  void new_search();
-  TTEntry* first_entry(const Key posKey) const;
-  void refresh(const TTEntry* tte) const;
+  void store(const Key key, Value v, Bound type, Depth d, Move m, Value statV);
 
 private:
-  size_t size;
-  TTCluster* entries;
-  uint8_t generation; // Size must be not bigger then TTEntry::generation8
+  uint32_t hashMask;
+  TTEntry* table;
+  void* mem;
+  uint8_t generation; // Size must be not bigger than TTEntry::generation8
 };
 
 extern TranspositionTable TT;
@@ -139,9 +99,9 @@ extern TranspositionTable TT;
 /// a cluster given a position. The lowest order bits of the key are used to
 /// get the index of the cluster.
 
-inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
+inline TTEntry* TranspositionTable::first_entry(const Key key) const {
 
-  return entries[((uint32_t)posKey) & (size - 1)].data;
+  return table + ((uint32_t)key & hashMask);
 }
 
 
@@ -153,4 +113,4 @@ inline void TranspositionTable::refresh(const TTEntry* tte) const {
   const_cast<TTEntry*>(tte)->set_generation(generation);
 }
 
-#endif // !defined(TT_H_INCLUDED)
+#endif // #ifndef TT_H_INCLUDED