X-Git-Url: https://git.sesse.net/?p=stockfish;a=blobdiff_plain;f=src%2Fbook.cpp;h=243583ff18276000a7c5050f0a54ffe330ff0bff;hp=16a0766dfa0cb417947efd0f161813046eb1358b;hb=80dd90f9722ecedb48605a6cd59e2d59a1bb2495;hpb=d3600c39a745179ed6b094b305d0645e83a1ee86 diff --git a/src/book.cpp b/src/book.cpp index 16a0766d..243583ff 100644 --- a/src/book.cpp +++ b/src/book.cpp @@ -1,18 +1,18 @@ /* Stockfish, a UCI chess playing engine derived from Glaurung 2.1 Copyright (C) 2004-2008 Tord Romstad (Glaurung author) - Copyright (C) 2008 Marco Costalba + Copyright (C) 2008-2010 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 the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + 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 . */ @@ -20,38 +20,22 @@ /* The code in this file is based on the opening book code in PolyGlot - by Fabien Letouzey. PolyGlot is available under the GNU General + by Fabien Letouzey. PolyGlot is available under the GNU General Public License, and can be downloaded from http://wbec-ridderkerk.nl */ - -//// -//// Includes -//// - #include +#include #include "book.h" -#include "mersenne.h" #include "movegen.h" - -//// -//// Global variables -//// - -Book OpeningBook; - - -//// -//// Local definitions -//// +using namespace std; namespace { - /// Random numbers from PolyGlot, used to compute book hash keys. - - const uint64_t Random64[781] = { + // Random numbers from PolyGlot, used to compute book hash keys + const Key PolyGlotRandoms[781] = { 0x9D39247E33776D41ULL, 0x2AF7398005AAA5C7ULL, 0x44DB015024623547ULL, 0x9C15F73E62A76AE2ULL, 0x75834465489C0C89ULL, 0x3290AC3A203001BFULL, 0x0FBBAD1F61042279ULL, 0xE83A908FF2FB60CAULL, 0x0D7E765D58755C10ULL, @@ -315,278 +299,231 @@ namespace { 0xF8D626AAAF278509ULL }; + // Offsets to the PolyGlotRandoms[] array of zobrist keys + const Key* ZobPiece = PolyGlotRandoms + 0; + const Key* ZobCastle = PolyGlotRandoms + 768; + const Key* ZobEnPassant = PolyGlotRandoms + 772; + const Key* ZobTurn = PolyGlotRandoms + 780; - /// Indices to the Random64[] array - - const int RandomPiece = 0; - const int RandomCastle = 768; - const int RandomEnPassant = 772; - const int RandomTurn = 780; + // Piece offset is calculated as 64 * (PolyPiece ^ 1) where + // PolyPiece is: BP = 0, WP = 1, BN = 2, WN = 3 ... BK = 10, WK = 11 + const int PieceOfs[] = { 0, 64, 192, 320, 448, 576, 704, 0, + 0, 0, 128, 256, 384, 512, 640 }; - - /// 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 - }; + // book_key() builds up a PolyGlot hash key out of a position + uint64_t book_key(const Position& pos) { + uint64_t result = 0; + Bitboard b = pos.occupied_squares(); - /// Prototypes - - 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); + while (b) + { + Square s = pop_1st_bit(&b); + result ^= ZobPiece[PieceOfs[pos.piece_on(s)] + s]; + } - uint16_t read_integer16(std::ifstream& file); - uint64_t read_integer64(std::ifstream& file); - uint64_t read_integer(std::ifstream& file, int size); -} + if (pos.can_castle(WHITE_OO)) + result ^= ZobCastle[0]; + if (pos.can_castle(WHITE_OOO)) + result ^= ZobCastle[1]; -//// -//// Functions -//// + if (pos.can_castle(BLACK_OO)) + result ^= ZobCastle[2]; + if (pos.can_castle(BLACK_OOO)) + result ^= ZobCastle[3]; -/// Constructor + if (pos.ep_square() != SQ_NONE) + result ^= ZobEnPassant[file_of(pos.ep_square())]; -Book::Book() : bookSize(0) {} + if (pos.side_to_move() == WHITE) + result ^= ZobTurn[0]; + return result; + } +} -/// Book::open() opens a book file with a given file name. -void Book::open(const std::string &fName) { +/// Book c'tor. Make random number generation less deterministic, for book moves +Book::Book() : bookSize(0) { - fileName = fName; - bookFile.open(fileName.c_str(), std::ifstream::in | std::ifstream::binary); - if (!bookFile.is_open()) - return; + for (int i = abs(get_system_time() % 10000); i > 0; i--) + RKiss.rand(); +} - bookFile.seekg(0, std::ios::end); - bookSize = bookFile.tellg() / 16; - bookFile.seekg(0, std::ios::beg); - if (!bookFile.good()) - { - std::cerr << "Failed to open book file " << fileName << std::endl; - exit(EXIT_FAILURE); - } +/// Book destructor. Be sure file is closed before we leave. + +Book::~Book() { + + close(); } -/// Book::close() closes the currently open book file. +/// Book::close() closes the file only if it is open, otherwise the call fails +/// and the failbit internal state flag is set. void Book::close() { if (bookFile.is_open()) bookFile.close(); + + bookName = ""; + bookSize = 0; } -/// Book::is_open() tests whether a book file has been opened. +/// Book::open() opens a book file with a given name -bool Book::is_open() const { - - return bookFile.is_open() && bookSize != 0; -} +void Book::open(const string& fileName) { + // Close old file before opening the new + close(); -/// Book::file_name() returns the file name of the currently active book, -/// or the empty string if no book is open. + bookFile.open(fileName.c_str(), ifstream::in | ifstream::binary |ios::ate); -const std::string Book::file_name() const { + // Silently return when asked to open a non-exsistent file + if (!bookFile.is_open()) + return; - return bookFile.is_open() ? fileName : ""; -} - - -/// 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; - } + // Get the book size in number of entries, we are already at the file end + bookSize = long(bookFile.tellg()) / sizeof(BookEntry); - 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 (!bookFile.good()) + { + cerr << "Failed to open book file " << fileName << endl; + exit(EXIT_FAILURE); } - return MOVE_NONE; + + // Set only if successful + bookName = fileName; } -/// 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 -/// found in the book file, bookSize is returned. +/// Book::probe() gets a book move for a given position. Returns MOVE_NONE +/// if no book move is found. If findBest is true then returns always the +/// highest rated move otherwise chooses randomly based on the move score. -int Book::find_key(uint64_t key) const { - int left, right, mid; - BookEntry entry; +Move Book::probe(const Position& pos, bool findBest) { - // Binary search (finds the leftmost entry) - left = 0; - right = bookSize - 1; + if (!bookSize || !bookFile.is_open()) + return MOVE_NONE; - assert(left <= right); + BookEntry entry; + unsigned scoresSum = 0, bestScore = 0, bookMove = 0; + uint64_t key = book_key(pos); + int idx = first_entry(key) - 1; - while(left < right) { - mid = (left + right) / 2; - assert(mid >= left && mid < right); + // Choose a book move among the possible moves for the given position + while (++idx < bookSize && (entry = read_entry(idx), entry.key == key)) + { + scoresSum += entry.count; - this->read_entry(entry, mid); + // Choose book move according to its score. If a move has a very + // high score it has higher probability to be choosen than a move + // with lower score. Note that first entry is always chosen. + if ( RKiss.rand() % scoresSum < entry.count + || (findBest && entry.count > bestScore)) + bookMove = entry.move; - if(key <= entry.key) - right = mid; - else - left = mid + 1; + if (entry.count > bestScore) + bestScore = entry.count; } - assert(left == right); - - this->read_entry(entry, left); + if (!bookMove) + return MOVE_NONE; + + // A PolyGlot book move is encoded as follows: + // + // bit 0- 5: destination square (from 0 to 63) + // bit 6-11: origin square (from 0 to 63) + // bit 12-13-14: promotion piece (from KNIGHT == 1 to QUEEN == 4) + // + // Castling moves follow "king captures rook" representation. So in case + // book move is a promotion we have to convert to our representation, in + // all other cases we can directly compare with a Move after having + // masked out special Move's flags that are not supported by PolyGlot. + int promotion = (bookMove >> 12) & 7; + + if (promotion) + bookMove = make_promotion_move(move_from(Move(bookMove)), + move_to(Move(bookMove)), + PieceType(promotion + 1)); + // Verify the book move is legal + for (MoveList ml(pos); !ml.end(); ++ml) + if (unsigned(ml.move() & ~(3 << 14)) == bookMove) // Mask out special flags + return ml.move(); - return (entry.key == key)? left : bookSize; + return MOVE_NONE; } -/// 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. - -void Book::read_entry(BookEntry& entry, int n) const { - - assert(n >= 0 && n < bookSize); - assert(bookFile.is_open()); +/// Book::first_entry() takes a book key as input, and does a binary search +/// through the book file for the given key. The index to the first (leftmost) +/// book entry with the same key as the input is returned. When the key is not +/// found in the book file, bookSize is returned. - bookFile.seekg(n*16, std::ios_base::beg); - if (!bookFile.good()) - { - std::cerr << "Failed to read book entry at index " << n << std::endl; - exit(EXIT_FAILURE); - } - entry.key = read_integer64(bookFile); - entry.move = read_integer16(bookFile); - entry.count = read_integer16(bookFile); - entry.n = read_integer16(bookFile); - entry.sum = read_integer16(bookFile); -} +int Book::first_entry(uint64_t key) { + int left, right, mid; -//// -//// Local definitions -//// + // Binary search (finds the leftmost entry with given key) + left = 0; + right = bookSize - 1; -namespace { + assert(left <= right); - uint64_t book_key(const Position &pos) { - uint64_t result = 0ULL; - - 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); - - result ^= book_piece_key(p, s); - } - } + while (left < right) + { + mid = (left + right) / 2; - result ^= book_castle_key(pos); - result ^= book_ep_key(pos); - result ^= book_color_key(pos); + assert(mid >= left && mid < right); - return result; + if (key <= read_entry(mid).key) + right = mid; + else + left = mid + 1; } - - uint64_t book_piece_key(Piece p, Square s) { - return Random64[RandomPiece + (PieceTo12[int(p)]^1)*64 + int(s)]; - } + assert(left == right); + return read_entry(left).key == key ? left : bookSize; +} - uint64_t book_castle_key(const Position &pos) { - uint64_t result = 0ULL; - 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; - } +/// Book::operator>>() reads sizeof(T) chars from the file's binary byte +/// stream and converts them in a number of type T. +template +Book& Book::operator>>(T& n) { - - uint64_t book_ep_key(const Position &pos) { - return (pos.ep_square() == SQ_NONE)? - 0ULL : Random64[RandomEnPassant + square_file(pos.ep_square())]; - } + n = 0; - - uint64_t book_color_key(const Position &pos) { - return (pos.side_to_move() == WHITE)? Random64[RandomTurn] : 0ULL; - } - + for (size_t i = 0; i < sizeof(T); i++) + n = T((n << 8) + bookFile.get()); - uint16_t read_integer16(std::ifstream& file) { - - uint64_t n = read_integer(file, 2); - assert(n == (uint16_t)n); - return (uint16_t)n; - } + return *this; +} - uint64_t read_integer64(std::ifstream& file) { - - return read_integer(file, 8); - } +/// Book::read_entry() takes an integer index, and returns the BookEntry +/// at the given index in the book file. +BookEntry Book::read_entry(int idx) { - uint64_t read_integer(std::ifstream& file, int size) { + assert(idx >= 0 && idx < bookSize); + assert(bookFile.is_open()); - char buf[8]; - file.read(buf, size); + BookEntry e; - if (!file.good()) - { - std::cerr << "Failed to read " << size << " bytes from book file" - << std::endl; - exit(EXIT_FAILURE); - } - // Numbers are stored in little endian format - uint64_t n = 0ULL; - for (int i = 0; i < size; i++) - n = (n << 8) + (unsigned char)buf[i]; + bookFile.seekg(idx * sizeof(BookEntry), ios_base::beg); + + *this >> e.key >> e.move >> e.count >> e.learn; - return n; + if (!bookFile.good()) + { + cerr << "Failed to read book entry at index " << idx << endl; + exit(EXIT_FAILURE); } + return e; }