Introduce MovePicker::isBadCapture() and use in probcut
[stockfish] / src / movepick.cpp
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-2010 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
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include <cassert>
22
23 #include "movegen.h"
24 #include "movepick.h"
25 #include "search.h"
26 #include "types.h"
27
28 namespace {
29
30   enum MovegenPhase {
31     PH_TT_MOVES,      // Transposition table move and mate killer
32     PH_GOOD_CAPTURES, // Queen promotions and captures with SEE values >= 0
33     PH_KILLERS,       // Killer moves from the current ply
34     PH_NONCAPTURES,   // Non-captures and underpromotions
35     PH_BAD_CAPTURES,  // Queen promotions and captures with SEE values < 0
36     PH_EVASIONS,      // Check evasions
37     PH_QCAPTURES,     // Captures in quiescence search
38     PH_QCHECKS,       // Non-capture checks in quiescence search
39     PH_STOP
40   };
41
42   CACHE_LINE_ALIGNMENT
43   const uint8_t MainSearchTable[] = { PH_TT_MOVES, PH_GOOD_CAPTURES, PH_KILLERS, PH_NONCAPTURES, PH_BAD_CAPTURES, PH_STOP };
44   const uint8_t EvasionTable[] = { PH_TT_MOVES, PH_EVASIONS, PH_STOP };
45   const uint8_t QsearchWithChecksTable[] = { PH_TT_MOVES, PH_QCAPTURES, PH_QCHECKS, PH_STOP };
46   const uint8_t QsearchWithoutChecksTable[] = { PH_TT_MOVES, PH_QCAPTURES, PH_STOP };
47 }
48
49 bool MovePicker::isBadCapture() const { return phase == PH_BAD_CAPTURES; }
50
51 /// Constructor for the MovePicker class. Apart from the position for which
52 /// it is asked to pick legal moves, MovePicker also wants some information
53 /// to help it to return the presumably good moves first, to decide which
54 /// moves to return (in the quiescence search, for instance, we only want to
55 /// search captures, promotions and some checks) and about how important good
56 /// move ordering is at the current node.
57
58 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const History& h,
59                        SearchStack* ss, Value beta) : pos(p), H(h) {
60   int searchTT = ttm;
61   ttMoves[0].move = ttm;
62   badCaptureThreshold = 0;
63   badCaptures = moves + MAX_MOVES;
64
65   assert(d > DEPTH_ZERO);
66
67   pinned = p.pinned_pieces(pos.side_to_move());
68
69   if (p.in_check())
70   {
71       ttMoves[1].move = killers[0].move = killers[1].move = MOVE_NONE;
72       phasePtr = EvasionTable;
73   }
74   else
75   {
76       ttMoves[1].move = (ss->mateKiller == ttm) ? MOVE_NONE : ss->mateKiller;
77       searchTT |= ttMoves[1].move;
78       killers[0].move = ss->killers[0];
79       killers[1].move = ss->killers[1];
80
81       // Consider sligtly negative captures as good if at low
82       // depth and far from beta.
83       if (ss && ss->eval < beta - PawnValueMidgame && d < 3 * ONE_PLY)
84           badCaptureThreshold = -PawnValueMidgame;
85
86       phasePtr = MainSearchTable;
87   }
88
89   phasePtr += int(!searchTT) - 1;
90   go_next_phase();
91 }
92
93 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const History& h)
94                       : pos(p), H(h) {
95   int searchTT = ttm;
96   ttMoves[0].move = ttm;
97   ttMoves[1].move = MOVE_NONE;
98
99   assert(d <= DEPTH_ZERO);
100
101   pinned = p.pinned_pieces(pos.side_to_move());
102
103   if (p.in_check())
104       phasePtr = EvasionTable;
105   else if (d >= DEPTH_QS_CHECKS)
106       phasePtr = QsearchWithChecksTable;
107   else
108   {
109       phasePtr = QsearchWithoutChecksTable;
110
111       // Skip TT move if is not a capture or a promotion, this avoids
112       // qsearch tree explosion due to a possible perpetual check or
113       // similar rare cases when TT table is full.
114       if (ttm != MOVE_NONE && !pos.move_is_capture(ttm) && !move_is_promotion(ttm))
115           searchTT = ttMoves[0].move = MOVE_NONE;
116   }
117
118   phasePtr += int(!searchTT) - 1;
119   go_next_phase();
120 }
121
122
123 /// MovePicker::go_next_phase() generates, scores and sorts the next bunch
124 /// of moves when there are no more moves to try for the current phase.
125
126 void MovePicker::go_next_phase() {
127
128   curMove = moves;
129   phase = *(++phasePtr);
130   switch (phase) {
131
132   case PH_TT_MOVES:
133       curMove = ttMoves;
134       lastMove = curMove + 2;
135       return;
136
137   case PH_GOOD_CAPTURES:
138       lastMove = generate<MV_CAPTURE>(pos, moves);
139       score_captures();
140       return;
141
142   case PH_KILLERS:
143       curMove = killers;
144       lastMove = curMove + 2;
145       return;
146
147   case PH_NONCAPTURES:
148       lastMove = generate<MV_NON_CAPTURE>(pos, moves);
149       score_noncaptures();
150       sort_moves(moves, lastMove, &lastGoodNonCapture);
151       return;
152
153   case PH_BAD_CAPTURES:
154       // Bad captures SEE value is already calculated so just pick
155       // them in order to get SEE move ordering.
156       curMove = badCaptures;
157       lastMove = moves + MAX_MOVES;
158       return;
159
160   case PH_EVASIONS:
161       assert(pos.in_check());
162       lastMove = generate<MV_EVASION>(pos, moves);
163       score_evasions();
164       return;
165
166   case PH_QCAPTURES:
167       lastMove = generate<MV_CAPTURE>(pos, moves);
168       score_captures();
169       return;
170
171   case PH_QCHECKS:
172       lastMove = generate<MV_NON_CAPTURE_CHECK>(pos, moves);
173       return;
174
175   case PH_STOP:
176       lastMove = curMove + 1; // Avoid another go_next_phase() call
177       return;
178
179   default:
180       assert(false);
181       return;
182   }
183 }
184
185
186 /// MovePicker::score_captures(), MovePicker::score_noncaptures() and
187 /// MovePicker::score_evasions() assign a numerical move ordering score
188 /// to each move in a move list.  The moves with highest scores will be
189 /// picked first by get_next_move().
190
191 void MovePicker::score_captures() {
192   // Winning and equal captures in the main search are ordered by MVV/LVA.
193   // Suprisingly, this appears to perform slightly better than SEE based
194   // move ordering. The reason is probably that in a position with a winning
195   // capture, capturing a more valuable (but sufficiently defended) piece
196   // first usually doesn't hurt. The opponent will have to recapture, and
197   // the hanging piece will still be hanging (except in the unusual cases
198   // where it is possible to recapture with the hanging piece). Exchanging
199   // big pieces before capturing a hanging piece probably helps to reduce
200   // the subtree size.
201   // In main search we want to push captures with negative SEE values to
202   // badCaptures[] array, but instead of doing it now we delay till when
203   // the move has been picked up in pick_move_from_list(), this way we save
204   // some SEE calls in case we get a cutoff (idea from Pablo Vazquez).
205   Move m;
206
207   // Use MVV/LVA ordering
208   for (MoveStack* cur = moves; cur != lastMove; cur++)
209   {
210       m = cur->move;
211       if (move_is_promotion(m))
212           cur->score = QueenValueMidgame;
213       else
214           cur->score =  pos.midgame_value_of_piece_on(move_to(m))
215                       - pos.type_of_piece_on(move_from(m));
216   }
217 }
218
219 void MovePicker::score_noncaptures() {
220
221   Move m;
222   Square from;
223
224   for (MoveStack* cur = moves; cur != lastMove; cur++)
225   {
226       m = cur->move;
227       from = move_from(m);
228       cur->score = H.value(pos.piece_on(from), move_to(m));
229   }
230 }
231
232 void MovePicker::score_evasions() {
233   // Try good captures ordered by MVV/LVA, then non-captures if
234   // destination square is not under attack, ordered by history
235   // value, and at the end bad-captures and non-captures with a
236   // negative SEE. This last group is ordered by the SEE score.
237   Move m;
238   int seeScore;
239
240   // Skip if we don't have at least two moves to order
241   if (lastMove < moves + 2)
242       return;
243
244   for (MoveStack* cur = moves; cur != lastMove; cur++)
245   {
246       m = cur->move;
247       if ((seeScore = pos.see_sign(m)) < 0)
248           cur->score = seeScore - History::MaxValue; // Be sure we are at the bottom
249       else if (pos.move_is_capture(m))
250           cur->score =  pos.midgame_value_of_piece_on(move_to(m))
251                       - pos.type_of_piece_on(move_from(m)) + History::MaxValue;
252       else
253           cur->score = H.value(pos.piece_on(move_from(m)), move_to(m));
254   }
255 }
256
257 /// MovePicker::get_next_move() is the most important method of the MovePicker
258 /// class. It returns a new legal move every time it is called, until there
259 /// are no more moves left. It picks the move with the biggest score from a list
260 /// of generated moves taking care not to return the tt move if has already been
261 /// searched previously. Note that this function is not thread safe so should be
262 /// lock protected by caller when accessed through a shared MovePicker object.
263
264 Move MovePicker::get_next_move() {
265
266   Move move;
267
268   while (true)
269   {
270       while (curMove == lastMove)
271           go_next_phase();
272
273       switch (phase) {
274
275       case PH_TT_MOVES:
276           move = (curMove++)->move;
277           if (   move != MOVE_NONE
278               && pos.move_is_legal(move, pinned))
279               return move;
280           break;
281
282       case PH_GOOD_CAPTURES:
283           move = pick_best(curMove++, lastMove).move;
284           if (   move != ttMoves[0].move
285               && move != ttMoves[1].move
286               && pos.pl_move_is_legal(move, pinned))
287           {
288               // Check for a non negative SEE now
289               int seeValue = pos.see_sign(move);
290               if (seeValue >= badCaptureThreshold)
291                   return move;
292
293               // Losing capture, move it to the tail of the array, note
294               // that move has now been already checked for legality.
295               (--badCaptures)->move = move;
296               badCaptures->score = seeValue;
297           }
298           break;
299
300       case PH_KILLERS:
301           move = (curMove++)->move;
302           if (   move != MOVE_NONE
303               && pos.move_is_legal(move, pinned)
304               && move != ttMoves[0].move
305               && move != ttMoves[1].move
306               && !pos.move_is_capture(move))
307               return move;
308           break;
309
310       case PH_NONCAPTURES:
311           // Sort negative scored moves only when we get there
312           if (curMove == lastGoodNonCapture)
313               insertion_sort<MoveStack>(lastGoodNonCapture, lastMove);
314
315           move = (curMove++)->move;
316           if (   move != ttMoves[0].move
317               && move != ttMoves[1].move
318               && move != killers[0].move
319               && move != killers[1].move
320               && pos.pl_move_is_legal(move, pinned))
321               return move;
322           break;
323
324       case PH_BAD_CAPTURES:
325           move = pick_best(curMove++, lastMove).move;
326           return move;
327
328       case PH_EVASIONS:
329       case PH_QCAPTURES:
330           move = pick_best(curMove++, lastMove).move;
331           if (   move != ttMoves[0].move
332               && pos.pl_move_is_legal(move, pinned))
333               return move;
334           break;
335
336       case PH_QCHECKS:
337           move = (curMove++)->move;
338           if (   move != ttMoves[0].move
339               && pos.pl_move_is_legal(move, pinned))
340               return move;
341           break;
342
343       case PH_STOP:
344           return MOVE_NONE;
345
346       default:
347           assert(false);
348           break;
349       }
350   }
351 }