Introduce DistanceFromPV
[stockfish] / src / search.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2021 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #ifndef SEARCH_H_INCLUDED
20 #define SEARCH_H_INCLUDED
21
22 #include <vector>
23
24 #include "misc.h"
25 #include "movepick.h"
26 #include "types.h"
27
28 class Position;
29
30 namespace Search {
31
32 /// Threshold used for countermoves based pruning
33 constexpr int CounterMovePruneThreshold = 0;
34
35
36 /// Stack struct keeps track of the information we need to remember from nodes
37 /// shallower and deeper in the tree during the search. Each search thread has
38 /// its own array of Stack objects, indexed by the current ply.
39
40 struct Stack {
41   Move* pv;
42   PieceToHistory* continuationHistory;
43   int ply;
44   Move currentMove;
45   Move excludedMove;
46   Move killers[2];
47   Value staticEval;
48   int statScore;
49   int moveCount;
50   int distanceFromPv;
51   bool inCheck;
52   bool ttPv;
53   bool ttHit;
54 };
55
56
57 /// RootMove struct is used for moves at the root of the tree. For each root move
58 /// we store a score and a PV (really a refutation in the case of moves which
59 /// fail low). Score is normally set at -VALUE_INFINITE for all non-pv moves.
60
61 struct RootMove {
62
63   explicit RootMove(Move m) : pv(1, m) {}
64   bool extract_ponder_from_tt(Position& pos);
65   bool operator==(const Move& m) const { return pv[0] == m; }
66   bool operator<(const RootMove& m) const { // Sort in descending order
67     return m.score != score ? m.score < score
68                             : m.previousScore < previousScore;
69   }
70
71   Value score = -VALUE_INFINITE;
72   Value previousScore = -VALUE_INFINITE;
73   int selDepth = 0;
74   int tbRank = 0;
75   Value tbScore;
76   std::vector<Move> pv;
77 };
78
79 typedef std::vector<RootMove> RootMoves;
80
81
82 /// LimitsType struct stores information sent by GUI about available time to
83 /// search the current move, maximum depth/time, or if we are in analysis mode.
84
85 struct LimitsType {
86
87   LimitsType() { // Init explicitly due to broken value-initialization of non POD in MSVC
88     time[WHITE] = time[BLACK] = inc[WHITE] = inc[BLACK] = npmsec = movetime = TimePoint(0);
89     movestogo = depth = mate = perft = infinite = 0;
90     nodes = 0;
91   }
92
93   bool use_time_management() const {
94     return time[WHITE] || time[BLACK];
95   }
96
97   std::vector<Move> searchmoves;
98   TimePoint time[COLOR_NB], inc[COLOR_NB], npmsec, movetime, startTime;
99   int movestogo, depth, mate, perft, infinite;
100   int64_t nodes;
101 };
102
103 extern LimitsType Limits;
104
105 void init();
106 void clear();
107
108 } // namespace Search
109
110 #endif // #ifndef SEARCH_H_INCLUDED