]> git.sesse.net Git - stockfish/blob - src/movepick.cpp
Improve grammar of comments
[stockfish] / src / movepick.cpp
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 #include "movepick.h"
20
21 #include <algorithm>
22 #include <cassert>
23 #include <iterator>
24 #include <utility>
25
26 #include "bitboard.h"
27 #include "position.h"
28
29 namespace Stockfish {
30
31 namespace {
32
33   enum Stages {
34     MAIN_TT, CAPTURE_INIT, GOOD_CAPTURE, REFUTATION, QUIET_INIT, QUIET, BAD_CAPTURE,
35     EVASION_TT, EVASION_INIT, EVASION,
36     PROBCUT_TT, PROBCUT_INIT, PROBCUT,
37     QSEARCH_TT, QCAPTURE_INIT, QCAPTURE, QCHECK_INIT, QCHECK
38   };
39
40   // partial_insertion_sort() sorts moves in descending order up to and including
41   // a given limit. The order of moves smaller than the limit is left unspecified.
42   void partial_insertion_sort(ExtMove* begin, ExtMove* end, int limit) {
43
44     for (ExtMove *sortedEnd = begin, *p = begin + 1; p < end; ++p)
45         if (p->value >= limit)
46         {
47             ExtMove tmp = *p, *q;
48             *p = *++sortedEnd;
49             for (q = sortedEnd; q != begin && *(q - 1) < tmp; --q)
50                 *q = *(q - 1);
51             *q = tmp;
52         }
53   }
54
55 } // namespace
56
57
58 /// Constructors of the MovePicker class. As arguments, we pass information
59 /// to help it return the (presumably) good moves first, to decide which
60 /// moves to return (in the quiescence search, for instance, we only want to
61 /// search captures, promotions, and some checks) and how important a good
62 /// move ordering is at the current node.
63
64 /// MovePicker constructor for the main search
65 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const ButterflyHistory* mh,
66                                                              const CapturePieceToHistory* cph,
67                                                              const PieceToHistory** ch,
68                                                              Move cm,
69                                                              const Move* killers)
70            : pos(p), mainHistory(mh), captureHistory(cph), continuationHistory(ch),
71              ttMove(ttm), refutations{{killers[0], 0}, {killers[1], 0}, {cm, 0}}, depth(d)
72 {
73   assert(d > 0);
74
75   stage = (pos.checkers() ? EVASION_TT : MAIN_TT) +
76           !(ttm && pos.pseudo_legal(ttm));
77 }
78
79 /// MovePicker constructor for quiescence search
80 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const ButterflyHistory* mh,
81                                                              const CapturePieceToHistory* cph,
82                                                              const PieceToHistory** ch,
83                                                              Square rs)
84            : pos(p), mainHistory(mh), captureHistory(cph), continuationHistory(ch), ttMove(ttm), recaptureSquare(rs), depth(d)
85 {
86   assert(d <= 0);
87
88   stage = (pos.checkers() ? EVASION_TT : QSEARCH_TT) +
89           !(   ttm
90             && pos.pseudo_legal(ttm));
91 }
92
93 /// MovePicker constructor for ProbCut: we generate captures with SEE greater
94 /// than or equal to the given threshold.
95 MovePicker::MovePicker(const Position& p, Move ttm, Value th, const CapturePieceToHistory* cph)
96            : pos(p), captureHistory(cph), ttMove(ttm), threshold(th)
97 {
98   assert(!pos.checkers());
99
100   stage = PROBCUT_TT + !(ttm && pos.capture_stage(ttm)
101                              && pos.pseudo_legal(ttm)
102                              && pos.see_ge(ttm, threshold));
103 }
104
105 /// MovePicker::score() assigns a numerical value to each move in a list, used
106 /// for sorting. Captures are ordered by Most Valuable Victim (MVV), preferring
107 /// captures with a good history. Quiets moves are ordered using the history tables.
108 template<GenType Type>
109 void MovePicker::score() {
110
111   static_assert(Type == CAPTURES || Type == QUIETS || Type == EVASIONS, "Wrong type");
112
113   [[maybe_unused]] Bitboard threatenedByPawn, threatenedByMinor, threatenedByRook, threatenedPieces;
114   if constexpr (Type == QUIETS)
115   {
116       Color us = pos.side_to_move();
117
118       threatenedByPawn  = pos.attacks_by<PAWN>(~us);
119       threatenedByMinor = pos.attacks_by<KNIGHT>(~us) | pos.attacks_by<BISHOP>(~us) | threatenedByPawn;
120       threatenedByRook  = pos.attacks_by<ROOK>(~us) | threatenedByMinor;
121
122       // Pieces threatened by pieces of lesser material value
123       threatenedPieces = (pos.pieces(us, QUEEN) & threatenedByRook)
124                        | (pos.pieces(us, ROOK)  & threatenedByMinor)
125                        | (pos.pieces(us, KNIGHT, BISHOP) & threatenedByPawn);
126   }
127
128   for (auto& m : *this)
129       if constexpr (Type == CAPTURES)
130           m.value =  (7 * int(PieceValue[pos.piece_on(to_sq(m))])
131                    + (*captureHistory)[pos.moved_piece(m)][to_sq(m)][type_of(pos.piece_on(to_sq(m)))]) / 16;
132
133       else if constexpr (Type == QUIETS)
134       {
135           Piece     pc   = pos.moved_piece(m);
136           PieceType pt   = type_of(pos.moved_piece(m));
137           Square    from = from_sq(m);
138           Square    to   = to_sq(m);
139
140           // histories
141           m.value =  2 * (*mainHistory)[pos.side_to_move()][from_to(m)];
142           m.value += 2 * (*continuationHistory[0])[pc][to];
143           m.value +=     (*continuationHistory[1])[pc][to];
144           m.value +=     (*continuationHistory[3])[pc][to];
145           m.value +=     (*continuationHistory[5])[pc][to];
146
147           // bonus for checks
148           m.value += bool(pos.check_squares(pt) & to) * 16384;
149
150           // bonus for escaping from capture
151           m.value += threatenedPieces & from ?
152                        (pt == QUEEN && !(to & threatenedByRook)  ? 50000
153                       : pt == ROOK  && !(to & threatenedByMinor) ? 25000
154                       :                !(to & threatenedByPawn)  ? 15000
155                       :                                            0 )
156                       :                                            0 ;
157
158           // malus for putting piece en prise
159           m.value -= !(threatenedPieces & from) ?
160                         (pt == QUEEN ?   bool(to & threatenedByRook)  * 50000
161                                        + bool(to & threatenedByMinor) * 10000
162                                        + bool(to & threatenedByPawn)  * 20000
163                        : pt == ROOK  ?   bool(to & threatenedByMinor) * 25000
164                                        + bool(to & threatenedByPawn)  * 10000
165                        : pt != PAWN ?    bool(to & threatenedByPawn)  * 15000
166                        :                                                0 )
167                        :                                                0 ;
168       }
169
170       else // Type == EVASIONS
171       {
172           if (pos.capture_stage(m))
173               m.value =  PieceValue[pos.piece_on(to_sq(m))]
174                        - Value(type_of(pos.moved_piece(m)))
175                        + (1 << 28);
176           else
177               m.value =  (*mainHistory)[pos.side_to_move()][from_to(m)]
178                        + (*continuationHistory[0])[pos.moved_piece(m)][to_sq(m)];
179       }
180 }
181
182 /// MovePicker::select() returns the next move satisfying a predicate function.
183 /// It never returns the TT move.
184 template<MovePicker::PickType T, typename Pred>
185 Move MovePicker::select(Pred filter) {
186
187   while (cur < endMoves)
188   {
189       if constexpr (T == Best)
190           std::swap(*cur, *std::max_element(cur, endMoves));
191
192       if (*cur != ttMove && filter())
193           return *cur++;
194
195       cur++;
196   }
197   return MOVE_NONE;
198 }
199
200 /// MovePicker::next_move() is the most important method of the MovePicker class. It
201 /// returns a new pseudo-legal move every time it is called until there are no more
202 /// moves left, picking the move with the highest score from a list of generated moves.
203 Move MovePicker::next_move(bool skipQuiets) {
204
205 top:
206   switch (stage) {
207
208   case MAIN_TT:
209   case EVASION_TT:
210   case QSEARCH_TT:
211   case PROBCUT_TT:
212       ++stage;
213       return ttMove;
214
215   case CAPTURE_INIT:
216   case PROBCUT_INIT:
217   case QCAPTURE_INIT:
218       cur = endBadCaptures = moves;
219       endMoves = generate<CAPTURES>(pos, cur);
220
221       score<CAPTURES>();
222       partial_insertion_sort(cur, endMoves, std::numeric_limits<int>::min());
223       ++stage;
224       goto top;
225
226   case GOOD_CAPTURE:
227       if (select<Next>([&](){
228                        return pos.see_ge(*cur, Value(-cur->value)) ?
229                               // Move losing capture to endBadCaptures to be tried later
230                               true : (*endBadCaptures++ = *cur, false); }))
231           return *(cur - 1);
232
233       // Prepare the pointers to loop over the refutations array
234       cur = std::begin(refutations);
235       endMoves = std::end(refutations);
236
237       // If the countermove is the same as a killer, skip it
238       if (   refutations[0].move == refutations[2].move
239           || refutations[1].move == refutations[2].move)
240           --endMoves;
241
242       ++stage;
243       [[fallthrough]];
244
245   case REFUTATION:
246       if (select<Next>([&](){ return    *cur != MOVE_NONE
247                                     && !pos.capture_stage(*cur)
248                                     &&  pos.pseudo_legal(*cur); }))
249           return *(cur - 1);
250       ++stage;
251       [[fallthrough]];
252
253   case QUIET_INIT:
254       if (!skipQuiets)
255       {
256           cur = endBadCaptures;
257           endMoves = generate<QUIETS>(pos, cur);
258
259           score<QUIETS>();
260           partial_insertion_sort(cur, endMoves, -3000 * depth);
261       }
262
263       ++stage;
264       [[fallthrough]];
265
266   case QUIET:
267       if (   !skipQuiets
268           && select<Next>([&](){return   *cur != refutations[0].move
269                                       && *cur != refutations[1].move
270                                       && *cur != refutations[2].move;}))
271           return *(cur - 1);
272
273       // Prepare the pointers to loop over the bad captures
274       cur = moves;
275       endMoves = endBadCaptures;
276
277       ++stage;
278       [[fallthrough]];
279
280   case BAD_CAPTURE:
281       return select<Next>([](){ return true; });
282
283   case EVASION_INIT:
284       cur = moves;
285       endMoves = generate<EVASIONS>(pos, cur);
286
287       score<EVASIONS>();
288       ++stage;
289       [[fallthrough]];
290
291   case EVASION:
292       return select<Best>([](){ return true; });
293
294   case PROBCUT:
295       return select<Next>([&](){ return pos.see_ge(*cur, threshold); });
296
297   case QCAPTURE:
298       if (select<Next>([&](){ return   depth > DEPTH_QS_RECAPTURES
299                                     || to_sq(*cur) == recaptureSquare; }))
300           return *(cur - 1);
301
302       // If we did not find any move and we do not try checks, we have finished
303       if (depth != DEPTH_QS_CHECKS)
304           return MOVE_NONE;
305
306       ++stage;
307       [[fallthrough]];
308
309   case QCHECK_INIT:
310       cur = moves;
311       endMoves = generate<QUIET_CHECKS>(pos, cur);
312
313       ++stage;
314       [[fallthrough]];
315
316   case QCHECK:
317       return select<Next>([](){ return true; });
318   }
319
320   assert(false);
321   return MOVE_NONE; // Silence warning
322 }
323
324 } // namespace Stockfish