History code rewrite (#1122)
[stockfish] / src / search.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 SEARCH_H_INCLUDED
22 #define SEARCH_H_INCLUDED
23
24 #include <atomic>
25 #include <vector>
26
27 #include "misc.h"
28 #include "movepick.h"
29 #include "types.h"
30
31 class Position;
32
33 namespace Search {
34
35 /// Stack struct keeps track of the information we need to remember from nodes
36 /// shallower and deeper in the tree during the search. Each search thread has
37 /// its own array of Stack objects, indexed by the current ply.
38
39 struct Stack {
40   Move* pv;
41   PieceToHistory* history;
42   int ply;
43   Move currentMove;
44   Move excludedMove;
45   Move killers[2];
46   Value staticEval;
47   int statScore;
48   int moveCount;
49 };
50
51
52 /// RootMove struct is used for moves at the root of the tree. For each root move
53 /// we store a score and a PV (really a refutation in the case of moves which
54 /// fail low). Score is normally set at -VALUE_INFINITE for all non-pv moves.
55
56 struct RootMove {
57
58   explicit RootMove(Move m) : pv(1, m) {}
59   bool extract_ponder_from_tt(Position& pos);
60   bool operator==(const Move& m) const { return pv[0] == m; }
61   bool operator<(const RootMove& m) const { // Sort in descending order
62     return m.score != score ? m.score < score
63                             : m.previousScore < previousScore;
64   }
65
66   Value score = -VALUE_INFINITE;
67   Value previousScore = -VALUE_INFINITE;
68   std::vector<Move> pv;
69 };
70
71 typedef std::vector<RootMove> RootMoves;
72
73
74 /// LimitsType struct stores information sent by GUI about available time to
75 /// search the current move, maximum depth/time, if we are in analysis mode or
76 /// if we have to ponder while it's our opponent's turn to move.
77
78 struct LimitsType {
79
80   LimitsType() { // Init explicitly due to broken value-initialization of non POD in MSVC
81     nodes = time[WHITE] = time[BLACK] = inc[WHITE] = inc[BLACK] =
82     npmsec = movestogo = depth = movetime = mate = infinite = ponder = 0;
83   }
84
85   bool use_time_management() const {
86     return !(mate | movetime | depth | nodes | infinite);
87   }
88
89   std::vector<Move> searchmoves;
90   int time[COLOR_NB], inc[COLOR_NB], npmsec, movestogo, depth, movetime, mate, infinite, ponder;
91   int64_t nodes;
92   TimePoint startTime;
93 };
94
95
96 /// SignalsType struct stores atomic flags updated during the search, typically
97 /// in an async fashion e.g. to stop the search by the GUI.
98
99 struct SignalsType {
100   std::atomic_bool stop, stopOnPonderhit;
101 };
102
103 extern SignalsType Signals;
104 extern LimitsType Limits;
105
106 void init();
107 void clear();
108 template<bool Root = true> uint64_t perft(Position& pos, Depth depth);
109
110 } // namespace Search
111
112 #endif // #ifndef SEARCH_H_INCLUDED