Split transposition table lookup in a separate function
[stockfish] / src / tt.cpp
index 01d4365522a772af5a09887106a3372d8044cd6f..1959693258c3d8e0e6dbad995103ed0ee766cbe2 100644 (file)
@@ -6,12 +6,12 @@
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
-  
+
   Glaurung is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
-  
+
   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 /// Constructor
 
 TranspositionTable::TranspositionTable(unsigned mbSize) {
+
   size = 0;
   generation = 0;
   writes = 0;
   entries = 0;
-  this->set_size(mbSize);
+  set_size(mbSize);
 }
 
 
 /// Destructor
 
 TranspositionTable::~TranspositionTable() {
+
   delete [] entries;
 }
 
@@ -53,25 +55,28 @@ TranspositionTable::~TranspositionTable() {
 /// measured in megabytes.
 
 void TranspositionTable::set_size(unsigned mbSize) {
-  unsigned newSize;
 
   assert(mbSize >= 4 && mbSize <= 1024);
 
-  for(newSize = 1024; newSize * 4 * (sizeof(TTEntry)) <= (mbSize << 20);
-      newSize *= 2);
-  newSize /= 2;
+  unsigned newSize = 1024;
 
-  if(newSize != size) {
+  // We store a cluster of 4 TTEntry for each position and newSize is
+  // the maximum number of storable positions
+  for ( ; newSize * 4 * (sizeof(TTEntry)) <= (mbSize << 20); newSize *= 2);
+  newSize /= 2;
+  if (newSize != size)
+  {
     size = newSize;
     delete [] entries;
     entries = new TTEntry[size * 4];
-    if(entries == NULL) {
+    if (!entries)
+    {
       std::cerr << "Failed to allocate " << mbSize
                 << " MB for transposition table."
                 << std::endl;
       exit(EXIT_FAILURE);
     }
-    this->clear();
+    clear();
   }
 }
 
@@ -82,6 +87,7 @@ void TranspositionTable::set_size(unsigned mbSize) {
 /// Perhaps we should also clear it when the "ucinewgame" command is recieved?
 
 void TranspositionTable::clear() {
+
   memset(entries, 0, size * 4 * sizeof(TTEntry));
 }
 
@@ -99,22 +105,30 @@ void TranspositionTable::store(const Position &pos, Value v, Depth d,
                                Move m, ValueType type) {
   TTEntry *tte, *replace;
 
-  tte = replace = entries + int(pos.get_key() & (size - 1)) * 4;
-  for(int i = 0; i < 4; i++) {
-    if((tte+i)->key() == pos.get_key()) {
-      if(m == MOVE_NONE)
-        m = (tte+i)->move();
-      *(tte+i) = TTEntry(pos.get_key(), v, type, d, m, generation);
-      return;
+  tte = replace = first_entry(pos);
+  for (int i = 0; i < 4; i++)
+  {
+    if (!(tte+i)->key()) // still empty
+    {
+        *(tte+i) = TTEntry(pos.get_key(), v, type, d, m, generation);
+        writes++;
+        return;
     }
-    if(replace->generation() == generation) {
-      if((tte+i)->generation() != generation ||
-         (tte+i)->depth() < replace->depth())
-        replace = tte+i;
+    if ((tte+i)->key() == pos.get_key()) // overwrite old
+    {
+        if (m == MOVE_NONE)
+            m = (tte+i)->move();
+
+        *(tte+i) = TTEntry(pos.get_key(), v, type, d, m, generation);
+        return;
     }
-    else if((tte+i)->generation() != generation &&
-            (tte+i)->depth() < replace->depth())
-      replace = tte+i;
+    if (   i == 0  // already is (replace == tte+i), common case
+        || replace->generation() < (tte+i)->generation())
+        continue;
+
+    if (    replace->generation() > (tte+i)->generation()
+        || (tte+i)->depth() < replace->depth())
+        replace = tte+i;
   }
   *replace = TTEntry(pos.get_key(), v, type, d, m, generation);
   writes++;
@@ -122,58 +136,56 @@ void TranspositionTable::store(const Position &pos, Value v, Depth d,
 
 
 /// TranspositionTable::retrieve looks up the current position in the
-/// transposition table, and extracts the value, value type, depth and
-/// best move if the position is found.  The return value is true if
-/// the position is found, and false if it isn't.
-
-bool TranspositionTable::retrieve(const Position &pos, Value *value,
-                                  Depth *d, Move *move,
-                                  ValueType *type) const {
-  TTEntry *tte;
-  bool found = false;
-
-  tte = entries + int(pos.get_key() & (size - 1)) * 4;
-  for(int i = 0; i < 4 && !found ; i++)
-    if((tte+i)->key() == pos.get_key()) {
-      tte = tte + i;
-      found = true;
-    }
-  if(!found) {
-    *move = MOVE_NONE;
-    return false;
-  }
+/// transposition table. Returns a pointer to the TTEntry or NULL
+/// if position is not found.
 
-  *value = tte->value();
-  *type = tte->type();
-  *d = tte->depth();
-  *move = tte->move();
+const TTEntry* TranspositionTable::retrieve(const Position &pos) const {
 
-  return true;
+  TTEntry *tte = first_entry(pos);
+
+  for (int i = 0; i < 4; i++)
+  {
+      tte += i;
+      if (tte->key() == pos.get_key())
+          return tte;
+  }
+  return NULL;
 }
 
 
+/// TranspositionTable::first_entry returns a pointer to the first
+/// entry of a cluster given a position.
+
+inline TTEntry* TranspositionTable::first_entry(const Position &pos) const {
+
+  return entries + (int(pos.get_key() & (size - 1)) << 2);
+}
+
 /// TranspositionTable::new_search() is called at the beginning of every new
 /// search.  It increments the "generation" variable, which is used to
 /// distinguish transposition table entries from previous searches from
 /// entries from the current search.
 
 void TranspositionTable::new_search() {
+
   generation++;
   writes = 0;
 }
 
 
-/// TranspositionTable::insert_pv() is called at the end of a search 
+/// TranspositionTable::insert_pv() is called at the end of a search
 /// iteration, and inserts the PV back into the PV.  This makes sure the
 /// old PV moves are searched first, even if the old TT entries have been
 /// overwritten.
 
 void TranspositionTable::insert_pv(const Position &pos, Move pv[]) {
+
   UndoInfo u;
   Position p(pos);
 
-  for(int i = 0; pv[i] != MOVE_NONE; i++) {
-    this->store(p, VALUE_NONE, Depth(0), pv[i], VALUE_TYPE_NONE);
+  for (int i = 0; pv[i] != MOVE_NONE; i++)
+  {
+    store(p, VALUE_NONE, Depth(0), pv[i], VALUE_TYPE_NONE);
     p.do_move(pv[i], u);
   }
 }
@@ -184,6 +196,7 @@ void TranspositionTable::insert_pv(const Position &pos, Move pv[]) {
 /// It is used to display the "info hashfull ..." information in UCI.
 
 int TranspositionTable::full() {
+
   double N = double(size) * 4.0;
   return int(1000 * (1 - exp(writes * log(1.0 - 1.0/N))));
 }
@@ -195,36 +208,9 @@ TTEntry::TTEntry() {
 }
 
 TTEntry::TTEntry(Key k, Value v, ValueType t, Depth d, Move m,
-                 int generation) {
-  key_ = k;
-  data = (m & 0x7FFFF) | (t << 20) | (generation << 23);
-  value_ = v;
-  depth_ = int16_t(d);
-}
-
+                 int generation) :
+  key_ (k), data((m & 0x7FFFF) | (t << 20) | (generation << 23)),
+  value_(v), depth_(int16_t(d)) {}
 
-/// Functions for extracting data from TTEntry objects.
 
-Key TTEntry::key() const {
-  return key_;
-}
 
-Depth TTEntry::depth() const {
-  return Depth(depth_);
-}
-
-Move TTEntry::move() const {
-  return Move(data & 0x7FFFF);
-}
-
-Value TTEntry::value() const {
-  return Value(value_);
-}
-
-ValueType TTEntry::type() const {
-  return ValueType((data >> 20) & 3);
-}
-
-int TTEntry::generation() const {
-  return (data >> 23);
-}