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