]> git.sesse.net Git - stockfish/blobdiff - src/book.cpp
Retire Application class
[stockfish] / src / book.cpp
index bd2f48186492c87f7bbc9cef96a45c68fdc08295..95ccd690506251c284dc557905a53d5c1cc6711f 100644 (file)
@@ -1,17 +1,18 @@
 /*
-  Glaurung, a UCI chess playing engine.
-  Copyright (C) 2004-2008 Tord Romstad
+  Stockfish, a UCI chess playing engine derived from Glaurung 2.1
+  Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
+  Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
 
-  Glaurung is free software: you can redistribute it and/or modify
+  Stockfish is free software: you can redistribute it and/or modify
   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,
+
+  Stockfish 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/>.
 */
 ////
 
 #include <cassert>
-#include <cstdio>
 
 #include "book.h"
-#include "mersenne.h"
 #include "movegen.h"
 
-
-////
-//// Global variables
-////
-
-Book OpeningBook;
-
+using namespace std;
 
 ////
 //// Local definitions
@@ -49,8 +42,10 @@ Book OpeningBook;
 
 namespace {
 
-  /// Random numbers from PolyGlot, used to compute book hash keys.
+  // Book entry size in bytes
+  const int EntrySize = 16;
 
+  // Random numbers from PolyGlot, used to compute book hash keys
   const uint64_t Random64[781] = {
     0x9D39247E33776D41ULL, 0x2AF7398005AAA5C7ULL, 0x44DB015024623547ULL,
     0x9C15F73E62A76AE2ULL, 0x75834465489C0C89ULL, 0x3290AC3A203001BFULL,
@@ -315,32 +310,18 @@ namespace {
     0xF8D626AAAF278509ULL
   };
 
+  // Indices to the Random64[] array
+  const int PieceIdx     = 0;
+  const int CastleIdx    = 768;
+  const int EnPassantIdx = 772;
+  const int TurnIdx      = 780;
 
-  /// Indices to the Random64[] array
-  
-  const int RandomPiece = 0;
-  const int RandomCastle = 768;
-  const int RandomEnPassant = 772;
-  const int RandomTurn = 780;
-
-  
-  /// Convert pieces to the range 0..1
-  
-  const int PieceTo12[] = {
-    0, 0, 2, 4, 6, 8, 10, 0, 0, 1, 3, 5, 7, 9, 11
-  };
-
-
-  /// Prototypes
-  
-  uint64_t book_key(const Position &pos);
+  // Local functions
+  uint64_t book_key(const Position& pos);
   uint64_t book_piece_key(Piece p, Square s);
-  uint64_t book_castle_key(const Position &pos);
-  uint64_t book_ep_key(const Position &pos);
-  uint64_t book_color_key(const Position &pos);
-
-  uint64_t read_integer(FILE *file, int size);
-
+  uint64_t book_castle_key(const Position& pos);
+  uint64_t book_ep_key(const Position& pos);
+  uint64_t book_color_key(const Position& pos);
 }
 
 
@@ -348,100 +329,127 @@ namespace {
 //// Functions
 ////
 
-
-/// Constructor
-
+// C'tor. Make random number generation less deterministic, for book moves
 Book::Book() {
-  bookFile = NULL;
-  bookSize = 0;
+
+  for (int i = abs(get_system_time() % 10000); i > 0; i--)
+      RKiss.rand<unsigned>();
 }
 
 
-/// Book::open() opens a book file with a given file name.
+/// Destructor. Be sure file is closed before we leave.
 
-void Book::open(const std::string &fName) {
-  fileName = fName;
-  bookFile = fopen(fileName.c_str(), "rb");
-  if(bookFile != NULL) {
-    if(fseek(bookFile, 0, SEEK_END) == -1) {
-      std::cerr << "Failed to open book file " << fileName << std::endl;
-      exit(EXIT_FAILURE);
-    }
-    bookSize = ftell(bookFile) / 16;
-    if(bookSize == -1) {
-      std::cerr << "Failed to open book file " << fileName << std::endl;
-      exit(EXIT_FAILURE);
-    }
-  }
+Book::~Book() {
+
+  close();
 }
 
 
-/// Book::close() closes the currently open book file.
+/// Book::close() closes the file only if it is open, otherwise
+/// we can end up in a little mess due to how std::ifstream works.
 
 void Book::close() {
-  if(bookFile != NULL && fclose(bookFile) == EOF) {
-    std::cerr << "Failed to close book file" << std::endl;
-    exit(EXIT_FAILURE);
-  }
+
+  if (is_open())
+      ifstream::close();
 }
 
 
-/// Book::is_open() tests whether a book file has been opened.
+/// Book::open() opens a book file with a given file name
+
+void Book::open(const string& fName) {
+
+  // Close old file before opening the new
+  close();
+
+  fileName = fName;
+  ifstream::open(fileName.c_str(), ifstream::in | ifstream::binary);
+
+  if (is_open())
+  {
+      // Get the book size in number of entries
+      seekg(0, ios::end);
+      bookSize = long(tellg()) / EntrySize;
+      seekg(0, ios::beg);
 
-bool Book::is_open() const {
-  return bookFile != NULL && bookSize != 0;
+      if (good())
+          return;
+  }
+  cerr << "Failed to open book file " << fileName << endl;
+  exit(EXIT_FAILURE);
 }
 
 
 /// Book::file_name() returns the file name of the currently active book,
 /// or the empty string if no book is open.
 
-const std::string Book::file_name() const {
-  return this->is_open()? fileName : "";
+const string Book::file_name() { // Not const to compile on HP-UX 11.X
+
+  return is_open() ? fileName : "";
 }
-  
 
-/// Book::get_move() gets a book move for a given position.  Returns
+
+/// Book::get_move() gets a book move for a given position. Returns
 /// MOVE_NONE if no book move is found.
 
-Move Book::get_move(const Position &pos) const {
-  if(this->is_open()) {
-    int bestMove = 0, bestScore = 0, move, score;
-    uint64_t key = book_key(pos);
-    BookEntry entry;
-
-    for(int i = this->find_key(key); i < bookSize; i++) {
-      this->read_entry(entry, i);
-      if(entry.key != key)
-        break;
-      move = entry.move;
-      score = entry.count;
-      assert(score > 0);
-
-      bestScore += score;
-      if(int(genrand_int32() % bestScore) < score)
-        bestMove = move;
-    }
+Move Book::get_move(const Position& pos, bool findBestMove) {
 
-    if(bestMove != 0) {
-      MoveStack moves[256];
-      int n, j;
-      n = generate_legal_moves(pos, moves);
-      for(j = 0; j < n; j++)
-        if((int(moves[j].move) & 07777) == bestMove)
-          return moves[j].move;
-    }
+  if (!is_open() || bookSize == 0)
+      return MOVE_NONE;
+
+  BookEntry entry;
+  int bookMove = MOVE_NONE;
+  unsigned scoresSum = 0, bestScore = 0;
+  uint64_t key = book_key(pos);
+
+  // Choose a book move among the possible moves for the given position
+  for (int idx = find_key(key); idx < bookSize; idx++)
+  {
+      read_entry(entry, idx);
+      if (entry.key != key)
+          break;
+
+      unsigned score = entry.count;
+
+      // If findBestMove is true choose highest rated book move
+      if (findBestMove)
+      {
+          if (score > bestScore)
+          {
+              bestScore = score;
+              bookMove = entry.move;
+          }
+          continue;
+      }
+
+      // Choose book move according to its score. If a move has a very
+      // high score it has more probability to be choosen then a one with
+      // lower score. Note that first entry is always chosen.
+      scoresSum += score;
+      if (RKiss.rand<unsigned>() % scoresSum < score)
+          bookMove = entry.move;
   }
+  if (!bookMove)
+      return MOVE_NONE;
+
+  // Verify the book move is legal
+  MoveStack mlist[MOVES_MAX];
+  MoveStack* last = generate_moves(pos, mlist);
+  for (MoveStack* cur = mlist; cur != last; cur++)
+      if ((int(cur->move) & 07777) == bookMove)
+          return cur->move;
+
   return MOVE_NONE;
 }
 
 
 /// Book::find_key() takes a book key as input, and does a binary search
-/// through the book file for the given key.  The index to the first book
-/// entry with the same key as the input is returned.  When the key is not
+/// through the book file for the given key. The index to the first book
+/// entry with the same key as the input is returned. When the key is not
 /// found in the book file, bookSize is returned.
 
-int Book::find_key(uint64_t key) const {
+int Book::find_key(uint64_t key) {
+
   int left, right, mid;
   BookEntry entry;
 
@@ -451,44 +459,63 @@ int Book::find_key(uint64_t key) const {
 
   assert(left <= right);
 
-  while(left < right) {
-    mid = (left + right) / 2;
-    assert(mid >= left && mid < right);
+  while (left < right)
+  {
+      mid = (left + right) / 2;
 
-    this->read_entry(entry, mid);
+      assert(mid >= left && mid < right);
 
-    if(key <= entry.key)
-      right = mid;
-    else
-      left = mid + 1;
+      read_entry(entry, mid);
+
+      if (key <= entry.key)
+          right = mid;
+      else
+          left = mid + 1;
   }
 
   assert(left == right);
 
-  this->read_entry(entry, left);
-
-  return (entry.key == key)? left : bookSize;
+  read_entry(entry, left);
+  return entry.key == key ? left : bookSize;
 }
 
 
 /// Book::read_entry() takes a BookEntry reference and an integer index as
 /// input, and looks up the opening book entry at the given index in the book
-/// file.  The book entry is copied to the first input parameter.
+/// file. The book entry is copied to the first input parameter.
+
+void Book::read_entry(BookEntry& entry, int idx) {
+
+  assert(idx >= 0 && idx < bookSize);
+  assert(is_open());
 
-void Book::read_entry(BookEntry& entry, int n) const {
-  assert(n >= 0 && n < bookSize);
-  assert(bookFile != NULL);
+  seekg(idx * EntrySize, ios_base::beg);
 
-  if(fseek(bookFile, n*16, SEEK_SET) == -1) {
-    std::cerr << "Failed to read book entry at index " << n << std::endl;
-    exit(EXIT_FAILURE);
+  *this >> entry;
+
+  if (!good())
+  {
+      cerr << "Failed to read book entry at index " << idx << endl;
+      exit(EXIT_FAILURE);
   }
+}
+
+
+/// Book::read_integer() reads size chars from the file stream
+/// and converts them in an integer number.
+
+uint64_t Book::read_integer(int size) {
+
+  char buf[8];
+  uint64_t n = 0;
+
+  read(buf, size);
+
+  // Numbers are stored on disk as a binary byte stream
+  for (int i = 0; i < size; i++)
+      n = (n << 8) + (unsigned char)buf[i];
 
-  entry.key = read_integer(bookFile, 8);
-  entry.move = read_integer(bookFile, 2);
-  entry.count = read_integer(bookFile, 2);
-  entry.n = read_integer(bookFile, 2);
-  entry.sum = read_integer(bookFile, 2);
+  return n;
 }
 
 
@@ -498,81 +525,61 @@ void Book::read_entry(BookEntry& entry, int n) const {
 
 namespace {
 
-  uint64_t book_key(const Position &pos) {
-    uint64_t result = 0ULL;
+  uint64_t book_key(const Position& pos) {
 
-    for(Color c = WHITE; c <= BLACK; c++) {
-      Bitboard b = pos.pieces_of_color(c);
-      Square s;
-      Piece p;
-      while(b != EmptyBoardBB) {
-        s = pop_1st_bit(&b);
-        p = pos.piece_on(s);
-        assert(piece_is_ok(p));
-        assert(color_of_piece(p) == c);
+    uint64_t result = 0;
+    Bitboard b = pos.occupied_squares();
 
-        result ^= book_piece_key(p, s);
-      }
+    while (b)
+    {
+        Square s = pop_1st_bit(&b);
+        result ^= book_piece_key(pos.piece_on(s), s);
     }
 
     result ^= book_castle_key(pos);
     result ^= book_ep_key(pos);
     result ^= book_color_key(pos);
-
     return result;
   }
-        
+
 
   uint64_t book_piece_key(Piece p, Square s) {
-    return Random64[RandomPiece + (PieceTo12[int(p)]^1)*64 + int(s)];
+
+    // Convert pieces to the range 0..11
+    static const int PieceTo12[] = { 0, 0, 2, 4, 6, 8, 10, 0, 0, 1, 3, 5, 7, 9, 11 };
+
+    return Random64[PieceIdx + (PieceTo12[int(p)]^1) * 64 + int(s)];
   }
 
 
-  uint64_t book_castle_key(const Position &pos) {
-    uint64_t result = 0ULL;
+  uint64_t book_castle_key(const Position& pos) {
+
+    uint64_t result = 0;
+
+    if (pos.can_castle_kingside(WHITE))
+        result ^= Random64[CastleIdx + 0];
+
+    if (pos.can_castle_queenside(WHITE))
+        result ^= Random64[CastleIdx + 1];
+
+    if (pos.can_castle_kingside(BLACK))
+        result ^= Random64[CastleIdx + 2];
+
+    if (pos.can_castle_queenside(BLACK))
+        result ^= Random64[CastleIdx + 3];
 
-    if(pos.can_castle_kingside(WHITE))
-      result ^= Random64[RandomCastle+0];
-    if(pos.can_castle_queenside(WHITE))
-      result ^= Random64[RandomCastle+1];
-    if(pos.can_castle_kingside(BLACK))
-      result ^= Random64[RandomCastle+2];
-    if(pos.can_castle_queenside(BLACK))
-      result ^= Random64[RandomCastle+3];
     return result;
   }
 
-  
-  uint64_t book_ep_key(const Position &pos) {
-    return (pos.ep_square() == SQ_NONE)?
-      0ULL : Random64[RandomEnPassant + square_file(pos.ep_square())];
-  }
 
-  
-  uint64_t book_color_key(const Position &pos) {
-    return (pos.side_to_move() == WHITE)? Random64[RandomTurn] : 0ULL;
-  }
-  
-
-  uint64_t read_integer(FILE *file, int size) {
-    uint64_t n = 0ULL;;
-    int i;
-    int b;
-
-    assert(file != NULL);
-    assert(size > 0 && size <= 8);
-
-    for(i = 0; i < size; i++) {
-      b = fgetc(file);
-      if(b == EOF) {
-        std::cerr << "Failed to read " << size << " bytes from book file"
-                  << std::endl;
-        exit(EXIT_FAILURE);
-      }
-      assert(b >= 0 && b < 256);
-      n = (n << 8) | b;
-    }
-    return n;
+  uint64_t book_ep_key(const Position& pos) {
+
+    return pos.ep_square() == SQ_NONE ? 0 : Random64[EnPassantIdx + square_file(pos.ep_square())];
   }
 
+
+  uint64_t book_color_key(const Position& pos) {
+
+    return pos.side_to_move() == WHITE ? Random64[TurnIdx] : 0;
+  }
 }