Add simple debug hit rate counter
[stockfish] / src / book.h
1 /*
2   Glaurung, a UCI chess playing engine.
3   Copyright (C) 2004-2008 Tord Romstad
4
5   Glaurung is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9   
10   Glaurung is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14   
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19
20 /*
21   The code in this file is based on the opening book code in PolyGlot
22   by Fabien Letouzey.  PolyGlot is available under the GNU General
23   Public License, and can be downloaded from http://wbec-ridderkerk.nl
24 */
25
26
27 #if !defined(BOOK_H_INCLUDED)
28 #define BOOK_H_INCLUDED
29
30
31 ////
32 //// Includes
33 ////
34
35 #include <string>
36
37 #include "move.h"
38 #include "position.h"
39
40
41 ////
42 //// Types
43 ////
44
45 struct BookEntry {
46   uint64_t key;
47   uint16_t move;
48   uint16_t count;
49   uint16_t n;
50   uint16_t sum;
51 };
52
53 class Book {
54
55 public:
56   // Constructors
57   Book();
58
59   // Open and close book files
60   void open(const std::string &fName);
61   void close();
62
63   // Testing if a book is opened
64   bool is_open() const;
65
66   // The file name of the currently active book
67   const std::string file_name() const;
68
69   // Get a book move for a given position
70   Move get_move(const Position &pos) const;
71
72 private:
73   int find_key(uint64_t key) const;
74   void read_entry(BookEntry &entry, int n) const;
75
76   std::string fileName;
77   FILE *bookFile;
78   int bookSize;
79 };
80
81
82 ////
83 //// Global variables
84 ////
85
86 extern Book OpeningBook;
87
88
89 #endif // !defined(BOOK_H_INCLUDED)