Use int16_t in History values
[stockfish] / src / movepick.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2017 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef MOVEPICK_H_INCLUDED
22 #define MOVEPICK_H_INCLUDED
23
24 #include <array>
25
26 #include "movegen.h"
27 #include "position.h"
28 #include "types.h"
29
30 /// StatBoards is a generic 2-dimensional array used to store various statistics
31 template<int Size1, int Size2, typename T = int16_t>
32 struct StatBoards : public std::array<std::array<T, Size2>, Size1> {
33
34   void fill(const T& v) {
35     T* p = &(*this)[0][0];
36     std::fill(p, p + sizeof(*this) / sizeof(*p), v);
37   }
38 };
39
40 /// ButterflyBoards are 2 tables (one for each color) indexed by the move's from
41 /// and to squares, see chessprogramming.wikispaces.com/Butterfly+Boards
42 typedef StatBoards<COLOR_NB, int(SQUARE_NB) * int(SQUARE_NB)> ButterflyBoards;
43
44 /// PieceToBoards are addressed by a move's [piece][to] information
45 typedef StatBoards<PIECE_NB, SQUARE_NB> PieceToBoards;
46
47 /// ButterflyHistory records how often quiet moves have been successful or
48 /// unsuccessful during the current search, and is used for reduction and move
49 /// ordering decisions. It uses ButterflyBoards as backing store.
50 struct ButterflyHistory : public ButterflyBoards {
51
52   void update(Color c, Move m, int bonus) {
53
54     const int D = 324;
55     auto& entry = (*this)[c][from_to(m)];
56
57     assert(abs(bonus) <= D); // Consistency check for below formula
58     assert([&]{
59       int v = entry + bonus * 32 - entry * abs(bonus) / D;
60       return INT16_MIN < v && v < INT16_MAX;
61     }());
62
63     entry += bonus * 32 - entry * abs(bonus) / D;
64
65     assert(abs(entry) <= 32 * D);
66   }
67 };
68
69 /// PieceToHistory is like ButterflyHistory, but is based on PieceToBoards
70 struct PieceToHistory : public PieceToBoards {
71
72   void update(Piece pc, Square to, int bonus) {
73
74     const int D = 936;
75     auto& entry = (*this)[pc][to];
76
77     assert(abs(bonus) <= D); // Consistency check for below formula
78     assert([&]{
79       int v = entry + bonus * 32 - entry * abs(bonus) / D;
80       return INT16_MIN < v && v < INT16_MAX;
81     }());
82
83     entry += bonus * 32 - entry * abs(bonus) / D;
84
85     assert(abs(entry) <= 32 * D);
86   }
87 };
88
89 /// CounterMoveHistory stores counter moves indexed by [piece][to] of the previous
90 /// move, see chessprogramming.wikispaces.com/Countermove+Heuristic
91 typedef StatBoards<PIECE_NB, SQUARE_NB, Move> CounterMoveHistory;
92
93 /// ContinuationHistory is the history of a given pair of moves, usually the
94 /// current one given a previous one. History table is based on PieceToBoards
95 /// instead of ButterflyBoards.
96 typedef StatBoards<PIECE_NB, SQUARE_NB, PieceToHistory> ContinuationHistory;
97
98
99 /// MovePicker class is used to pick one pseudo legal move at a time from the
100 /// current position. The most important method is next_move(), which returns a
101 /// new pseudo legal move each time it is called, until there are no moves left,
102 /// when MOVE_NONE is returned. In order to improve the efficiency of the alpha
103 /// beta algorithm, MovePicker attempts to return the moves which are most likely
104 /// to get a cut-off first.
105
106 class MovePicker {
107 public:
108   MovePicker(const MovePicker&) = delete;
109   MovePicker& operator=(const MovePicker&) = delete;
110   MovePicker(const Position&, Move, Value);
111   MovePicker(const Position&, Move, Depth, const ButterflyHistory*, const PieceToHistory**, Square);
112   MovePicker(const Position&, Move, Depth, const ButterflyHistory*, const PieceToHistory**, Move, Move*);
113   Move next_move(bool skipQuiets = false);
114
115 private:
116   template<GenType> void score();
117   ExtMove* begin() { return cur; }
118   ExtMove* end() { return endMoves; }
119
120   const Position& pos;
121   const ButterflyHistory* mainHistory;
122   const PieceToHistory** contHistory;
123   Move ttMove, countermove, killers[2];
124   ExtMove *cur, *endMoves, *endBadCaptures;
125   int stage;
126   Square recaptureSquare;
127   Value threshold;
128   Depth depth;
129   ExtMove moves[MAX_MOVES];
130 };
131
132 #endif // #ifndef MOVEPICK_H_INCLUDED