]> git.sesse.net Git - stockfish/blob - src/search.h
Standardize Comments
[stockfish] / src / search.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 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 <cstdint>
23 #include <vector>
24
25 #include "misc.h"
26 #include "movepick.h"
27 #include "types.h"
28
29 namespace Stockfish {
30
31 class Position;
32
33 namespace Search {
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   bool inCheck;
51   bool ttPv;
52   bool ttHit;
53   int doubleExtensions;
54   int cutoffCnt;
55 };
56
57
58 // RootMove struct is used for moves at the root of the tree. For each root move
59 // we store a score and a PV (really a refutation in the case of moves which
60 // fail low). Score is normally set at -VALUE_INFINITE for all non-pv moves.
61
62 struct RootMove {
63
64   explicit RootMove(Move m) : pv(1, m) {}
65   bool extract_ponder_from_tt(Position& pos);
66   bool operator==(const Move& m) const { return pv[0] == m; }
67   bool operator<(const RootMove& m) const { // Sort in descending order
68     return m.score != score ? m.score < score
69                             : m.previousScore < previousScore;
70   }
71
72   Value score = -VALUE_INFINITE;
73   Value previousScore = -VALUE_INFINITE;
74   Value averageScore = -VALUE_INFINITE;
75   Value uciScore = -VALUE_INFINITE;
76   bool scoreLowerbound = false;
77   bool scoreUpperbound = false;
78   int selDepth = 0;
79   int tbRank = 0;
80   Value tbScore;
81   std::vector<Move> pv;
82 };
83
84 using RootMoves = std::vector<RootMove>;
85
86
87 // LimitsType struct stores information sent by GUI about available time to
88 // search the current move, maximum depth/time, or if we are in analysis mode.
89
90 struct LimitsType {
91
92   LimitsType() { // Init explicitly due to broken value-initialization of non POD in MSVC
93     time[WHITE] = time[BLACK] = inc[WHITE] = inc[BLACK] = npmsec = movetime = TimePoint(0);
94     movestogo = depth = mate = perft = infinite = 0;
95     nodes = 0;
96   }
97
98   bool use_time_management() const {
99     return time[WHITE] || time[BLACK];
100   }
101
102   std::vector<Move> searchmoves;
103   TimePoint time[COLOR_NB], inc[COLOR_NB], npmsec, movetime, startTime;
104   int movestogo, depth, mate, perft, infinite;
105   int64_t nodes;
106 };
107
108 extern LimitsType Limits;
109
110 void init();
111 void clear();
112
113 } // namespace Search
114
115 } // namespace Stockfish
116
117 #endif // #ifndef SEARCH_H_INCLUDED