f5e023855561063a15ab79770f11b1ed9b6d5257
[stockfish] / src / movepick.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2020 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 <cassert>
20
21 #include "movepick.h"
22
23 namespace {
24
25   enum Stages {
26     MAIN_TT, CAPTURE_INIT, GOOD_CAPTURE, REFUTATION, QUIET_INIT, QUIET, BAD_CAPTURE,
27     EVASION_TT, EVASION_INIT, EVASION,
28     PROBCUT_TT, PROBCUT_INIT, PROBCUT,
29     QSEARCH_TT, QCAPTURE_INIT, QCAPTURE, QCHECK_INIT, QCHECK
30   };
31
32   // partial_insertion_sort() sorts moves in descending order up to and including
33   // a given limit. The order of moves smaller than the limit is left unspecified.
34   void partial_insertion_sort(ExtMove* begin, ExtMove* end, int limit) {
35
36     for (ExtMove *sortedEnd = begin, *p = begin + 1; p < end; ++p)
37         if (p->value >= limit)
38         {
39             ExtMove tmp = *p, *q;
40             *p = *++sortedEnd;
41             for (q = sortedEnd; q != begin && *(q - 1) < tmp; --q)
42                 *q = *(q - 1);
43             *q = tmp;
44         }
45   }
46
47 } // namespace
48
49
50 /// Constructors of the MovePicker class. As arguments we pass information
51 /// to help it to return the (presumably) good moves first, to decide which
52 /// moves to return (in the quiescence search, for instance, we only want to
53 /// search captures, promotions, and some checks) and how important good move
54 /// ordering is at the current node.
55
56 /// MovePicker constructor for the main search
57 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const ButterflyHistory* mh, const LowPlyHistory* lp,
58                        const CapturePieceToHistory* cph, const PieceToHistory** ch, Move cm, const Move* killers, int pl)
59            : pos(p), mainHistory(mh), lowPlyHistory(lp), captureHistory(cph), continuationHistory(ch),
60              ttMove(ttm), refutations{{killers[0], 0}, {killers[1], 0}, {cm, 0}}, depth(d), ply(pl) {
61
62   assert(d > 0);
63
64   stage = (pos.checkers() ? EVASION_TT : MAIN_TT) +
65           !(ttm && pos.pseudo_legal(ttm));
66 }
67
68 /// MovePicker constructor for quiescence search
69 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const ButterflyHistory* mh,
70                        const CapturePieceToHistory* cph, const PieceToHistory** ch, Square rs)
71            : pos(p), mainHistory(mh), captureHistory(cph), continuationHistory(ch), ttMove(ttm), recaptureSquare(rs), depth(d) {
72
73   assert(d <= 0);
74
75   stage = (pos.checkers() ? EVASION_TT : QSEARCH_TT) +
76           !(   ttm
77             && (pos.checkers() || depth > DEPTH_QS_RECAPTURES || to_sq(ttm) == recaptureSquare)
78             && pos.pseudo_legal(ttm));
79 }
80
81 /// MovePicker constructor for ProbCut: we generate captures with SEE greater
82 /// than or equal to the given threshold.
83 MovePicker::MovePicker(const Position& p, Move ttm, Value th, const CapturePieceToHistory* cph)
84            : pos(p), captureHistory(cph), ttMove(ttm), threshold(th) {
85
86   assert(!pos.checkers());
87
88   stage = PROBCUT_TT + !(ttm && pos.capture(ttm)
89                              && pos.pseudo_legal(ttm)
90                              && pos.see_ge(ttm, threshold));
91 }
92
93 /// MovePicker::score() assigns a numerical value to each move in a list, used
94 /// for sorting. Captures are ordered by Most Valuable Victim (MVV), preferring
95 /// captures with a good history. Quiets moves are ordered using the histories.
96 template<GenType Type>
97 void MovePicker::score() {
98
99   static_assert(Type == CAPTURES || Type == QUIETS || Type == EVASIONS, "Wrong type");
100
101   for (auto& m : *this)
102       if (Type == CAPTURES)
103           m.value =  int(PieceValue[MG][pos.piece_on(to_sq(m))]) * 6
104                    + (*captureHistory)[pos.moved_piece(m)][to_sq(m)][type_of(pos.piece_on(to_sq(m)))];
105
106       else if (Type == QUIETS)
107           m.value =      (*mainHistory)[pos.side_to_move()][from_to(m)]
108                    + 2 * (*continuationHistory[0])[pos.moved_piece(m)][to_sq(m)]
109                    + 2 * (*continuationHistory[1])[pos.moved_piece(m)][to_sq(m)]
110                    + 2 * (*continuationHistory[3])[pos.moved_piece(m)][to_sq(m)]
111                    +     (*continuationHistory[5])[pos.moved_piece(m)][to_sq(m)]
112                    + (ply < MAX_LPH ? std::min(4, depth / 3) * (*lowPlyHistory)[ply][from_to(m)] : 0);
113
114       else // Type == EVASIONS
115       {
116           if (pos.capture(m))
117               m.value =  PieceValue[MG][pos.piece_on(to_sq(m))]
118                        - Value(type_of(pos.moved_piece(m)));
119           else
120               m.value =  (*mainHistory)[pos.side_to_move()][from_to(m)]
121                        + (*continuationHistory[0])[pos.moved_piece(m)][to_sq(m)]
122                        - (1 << 28);
123       }
124 }
125
126 /// MovePicker::select() returns the next move satisfying a predicate function.
127 /// It never returns the TT move.
128 template<MovePicker::PickType T, typename Pred>
129 Move MovePicker::select(Pred filter) {
130
131   while (cur < endMoves)
132   {
133       if (T == Best)
134           std::swap(*cur, *std::max_element(cur, endMoves));
135
136       if (*cur != ttMove && filter())
137           return *cur++;
138
139       cur++;
140   }
141   return MOVE_NONE;
142 }
143
144 /// MovePicker::next_move() is the most important method of the MovePicker class. It
145 /// returns a new pseudo legal move every time it is called until there are no more
146 /// moves left, picking the move with the highest score from a list of generated moves.
147 Move MovePicker::next_move(bool skipQuiets) {
148
149 top:
150   switch (stage) {
151
152   case MAIN_TT:
153   case EVASION_TT:
154   case QSEARCH_TT:
155   case PROBCUT_TT:
156       ++stage;
157       return ttMove;
158
159   case CAPTURE_INIT:
160   case PROBCUT_INIT:
161   case QCAPTURE_INIT:
162       cur = endBadCaptures = moves;
163       endMoves = generate<CAPTURES>(pos, cur);
164
165       score<CAPTURES>();
166       ++stage;
167       goto top;
168
169   case GOOD_CAPTURE:
170       if (select<Best>([&](){
171                        return pos.see_ge(*cur, Value(-69 * cur->value / 1024)) ?
172                               // Move losing capture to endBadCaptures to be tried later
173                               true : (*endBadCaptures++ = *cur, false); }))
174           return *(cur - 1);
175
176       // Prepare the pointers to loop over the refutations array
177       cur = std::begin(refutations);
178       endMoves = std::end(refutations);
179
180       // If the countermove is the same as a killer, skip it
181       if (   refutations[0].move == refutations[2].move
182           || refutations[1].move == refutations[2].move)
183           --endMoves;
184
185       ++stage;
186       [[fallthrough]];
187
188   case REFUTATION:
189       if (select<Next>([&](){ return    *cur != MOVE_NONE
190                                     && !pos.capture(*cur)
191                                     &&  pos.pseudo_legal(*cur); }))
192           return *(cur - 1);
193       ++stage;
194       [[fallthrough]];
195
196   case QUIET_INIT:
197       if (!skipQuiets)
198       {
199           cur = endBadCaptures;
200           endMoves = generate<QUIETS>(pos, cur);
201
202           score<QUIETS>();
203           partial_insertion_sort(cur, endMoves, -3000 * depth);
204       }
205
206       ++stage;
207       [[fallthrough]];
208
209   case QUIET:
210       if (   !skipQuiets
211           && select<Next>([&](){return   *cur != refutations[0].move
212                                       && *cur != refutations[1].move
213                                       && *cur != refutations[2].move;}))
214           return *(cur - 1);
215
216       // Prepare the pointers to loop over the bad captures
217       cur = moves;
218       endMoves = endBadCaptures;
219
220       ++stage;
221       [[fallthrough]];
222
223   case BAD_CAPTURE:
224       return select<Next>([](){ return true; });
225
226   case EVASION_INIT:
227       cur = moves;
228       endMoves = generate<EVASIONS>(pos, cur);
229
230       score<EVASIONS>();
231       ++stage;
232       [[fallthrough]];
233
234   case EVASION:
235       return select<Best>([](){ return true; });
236
237   case PROBCUT:
238       return select<Best>([&](){ return pos.see_ge(*cur, threshold); });
239
240   case QCAPTURE:
241       if (select<Best>([&](){ return   depth > DEPTH_QS_RECAPTURES
242                                     || to_sq(*cur) == recaptureSquare; }))
243           return *(cur - 1);
244
245       // If we did not find any move and we do not try checks, we have finished
246       if (depth != DEPTH_QS_CHECKS)
247           return MOVE_NONE;
248
249       ++stage;
250       [[fallthrough]];
251
252   case QCHECK_INIT:
253       cur = moves;
254       endMoves = generate<QUIET_CHECKS>(pos, cur);
255
256       ++stage;
257       [[fallthrough]];
258
259   case QCHECK:
260       return select<Next>([](){ return true; });
261   }
262
263   assert(false);
264   return MOVE_NONE; // Silence warning
265 }