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