d580b54695744fe79a62e6c777adbca4ddafc61c
[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-2012 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #if !defined(SEARCH_H_INCLUDED)
21 #define SEARCH_H_INCLUDED
22
23 #include <cstring>
24 #include <vector>
25
26 #include "misc.h"
27 #include "types.h"
28
29 class Position;
30 struct SplitPoint;
31
32 namespace Search {
33
34 /// The Stack struct keeps track of the information we need to remember from
35 /// nodes shallower and deeper in the tree during the search. Each search thread
36 /// has its own array of Stack objects, indexed by the current ply.
37
38 struct Stack {
39   SplitPoint* sp;
40   int ply;
41   Move currentMove;
42   Move excludedMove;
43   Move killers[2];
44   Depth reduction;
45   Value eval;
46   Value evalMargin;
47   int skipNullMove;
48 };
49
50
51 /// RootMove struct is used for moves at the root of the tree. For each root
52 /// move we store a score, a node count, and a PV (really a refutation in the
53 /// case of moves which fail low). Score is normally set at -VALUE_INFINITE for
54 /// all non-pv moves.
55 struct RootMove {
56
57   RootMove(){} // Needed by sort()
58   RootMove(Move m) : score(-VALUE_INFINITE), prevScore(-VALUE_INFINITE) {
59     pv.push_back(m); pv.push_back(MOVE_NONE);
60   }
61
62   bool operator<(const RootMove& m) const { return score < m.score; }
63   bool operator==(const Move& m) const { return pv[0] == m; }
64
65   void extract_pv_from_tt(Position& pos);
66   void insert_pv_in_tt(Position& pos);
67
68   Value score;
69   Value prevScore;
70   std::vector<Move> pv;
71 };
72
73
74 /// The LimitsType struct stores information sent by GUI about available time
75 /// to search the current move, maximum depth/time, if we are in analysis mode
76 /// or if we have to ponder while is our opponent's side to move.
77
78 struct LimitsType {
79
80   LimitsType() { memset(this, 0, sizeof(LimitsType)); }
81   bool use_time_management() const { return !(movetime | depth | nodes | infinite); }
82
83   int time[2], inc[2], movestogo, depth, nodes, movetime, infinite, ponder;
84 };
85
86
87 /// The SignalsType struct stores volatile flags updated during the search
88 /// typically in an async fashion, for instance to stop the search by the GUI.
89
90 struct SignalsType {
91   bool stopOnPonderhit, firstRootMove, stop, failedLowAtRoot;
92 };
93
94 extern volatile SignalsType Signals;
95 extern LimitsType Limits;
96 extern std::vector<RootMove> RootMoves;
97 extern Position RootPosition;
98 extern Time SearchTime;
99
100 extern void init();
101 extern size_t perft(Position& pos, Depth depth);
102 extern void think();
103
104 } // namespace Search
105
106 #endif // !defined(SEARCH_H_INCLUDED)