Expose EvalInfo struct to 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-2013 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 <memory>
25 #include <stack>
26 #include <vector>
27
28 #include "evaluate.h"
29 #include "misc.h"
30 #include "position.h"
31 #include "types.h"
32
33 struct SplitPoint;
34
35 namespace Search {
36
37 /// The Stack struct keeps track of the information we need to remember from
38 /// nodes shallower and deeper in the tree during the search. Each search thread
39 /// has its own array of Stack objects, indexed by the current ply.
40
41 struct Stack {
42   SplitPoint* splitPoint;
43   int ply;
44   Move currentMove;
45   Move excludedMove;
46   Move killers[2];
47   Depth reduction;
48   Value staticEval;
49   Value evalMargin;
50   int skipNullMove;
51   int futilityMoveCount;
52   Eval::Info* ei;
53 };
54
55
56 /// RootMove struct is used for moves at the root of the tree. For each root
57 /// move we store a score, a node count, and a PV (really a refutation in the
58 /// case of moves which fail low). Score is normally set at -VALUE_INFINITE for
59 /// all non-pv moves.
60 struct RootMove {
61
62   RootMove(Move m) : score(-VALUE_INFINITE), prevScore(-VALUE_INFINITE) {
63     pv.push_back(m); pv.push_back(MOVE_NONE);
64   }
65
66   bool operator<(const RootMove& m) const { return score > m.score; } // Ascending sort
67   bool operator==(const Move& m) const { return pv[0] == m; }
68
69   void extract_pv_from_tt(Position& pos);
70   void insert_pv_in_tt(Position& pos);
71
72   Value score;
73   Value prevScore;
74   std::vector<Move> pv;
75 };
76
77
78 /// The LimitsType struct stores information sent by GUI about available time
79 /// to search the current move, maximum depth/time, if we are in analysis mode
80 /// or if we have to ponder while is our opponent's side to move.
81
82 struct LimitsType {
83
84   LimitsType() { memset(this, 0, sizeof(LimitsType)); }
85   bool use_time_management() const { return !(mate | movetime | depth | nodes | infinite); }
86
87   int time[COLOR_NB], inc[COLOR_NB], movestogo, depth, nodes, movetime, mate, infinite, ponder;
88 };
89
90
91 /// The SignalsType struct stores volatile flags updated during the search
92 /// typically in an async fashion, for instance to stop the search by the GUI.
93
94 struct SignalsType {
95   bool stopOnPonderhit, firstRootMove, stop, failedLowAtRoot;
96 };
97
98 typedef std::auto_ptr<std::stack<StateInfo> > StateStackPtr;
99
100 extern volatile SignalsType Signals;
101 extern LimitsType Limits;
102 extern std::vector<RootMove> RootMoves;
103 extern Position RootPos;
104 extern Color RootColor;
105 extern Time::point SearchTime;
106 extern StateStackPtr SetupStates;
107
108 extern void init();
109 extern size_t perft(Position& pos, Depth depth);
110 extern void think();
111
112 } // namespace Search
113
114 #endif // !defined(SEARCH_H_INCLUDED)