Use type_of() to categorize the moves
[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-2012 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 <algorithm>
22 #include <cassert>
23
24 #include "movegen.h"
25 #include "movepick.h"
26
27 namespace {
28
29   enum Sequencer {
30     MAIN_SEARCH, CAPTURES_S1, KILLERS_S1, QUIETS_1_S1, QUIETS_2_S1, BAD_CAPTURES_S1,
31     EVASION,     EVASIONS_S2,
32     QSEARCH_0,   CAPTURES_S3, QUIET_CHECKS_S3,
33     QSEARCH_1,   CAPTURES_S4,
34     PROBCUT,     CAPTURES_S5,
35     RECAPTURE,   CAPTURES_S6,
36     STOP
37   };
38
39   // Unary predicate used by std::partition to split positive scores from remaining
40   // ones so to sort separately the two sets, and with the second sort delayed.
41   inline bool has_positive_score(const MoveStack& move) { return move.score > 0; }
42
43   // Picks and moves to the front the best move in the range [firstMove, lastMove),
44   // it is faster than sorting all the moves in advance when moves are few, as
45   // normally are the possible captures.
46   inline MoveStack* pick_best(MoveStack* firstMove, MoveStack* lastMove)
47   {
48       std::swap(*firstMove, *std::max_element(firstMove, lastMove));
49       return firstMove;
50   }
51 }
52
53
54 /// Constructors of the MovePicker class. As arguments we pass information
55 /// to help it to return the presumably good moves first, to decide which
56 /// moves to return (in the quiescence search, for instance, we only want to
57 /// search captures, promotions and some checks) and about how important good
58 /// move ordering is at the current node.
59
60 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const History& h,
61                        Search::Stack* ss, Value beta) : pos(p), H(h), depth(d) {
62
63   assert(d > DEPTH_ZERO);
64
65   captureThreshold = 0;
66   curMove = lastMove = moves;
67   lastBadCapture = moves + MAX_MOVES - 1;
68
69   if (p.in_check())
70       phase = EVASION;
71
72   else
73   {
74       phase = MAIN_SEARCH;
75
76       killers[0].move = ss->killers[0];
77       killers[1].move = ss->killers[1];
78
79       // Consider sligtly negative captures as good if at low depth and far from beta
80       if (ss && ss->eval < beta - PawnValueMidgame && d < 3 * ONE_PLY)
81           captureThreshold = -PawnValueMidgame;
82
83       // Consider negative captures as good if still enough to reach beta
84       else if (ss && ss->eval > beta)
85           captureThreshold = beta - ss->eval;
86   }
87
88   ttMove = (ttm && pos.is_pseudo_legal(ttm) ? ttm : MOVE_NONE);
89   lastMove += (ttMove != MOVE_NONE);
90 }
91
92 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const History& h,
93                        Square sq) : pos(p), H(h), curMove(moves), lastMove(moves) {
94
95   assert(d <= DEPTH_ZERO);
96
97   if (p.in_check())
98       phase = EVASION;
99
100   else if (d > DEPTH_QS_NO_CHECKS)
101       phase = QSEARCH_0;
102
103   else if (d > DEPTH_QS_RECAPTURES)
104   {
105       phase = QSEARCH_1;
106
107       // Skip TT move if is not a capture or a promotion, this avoids qsearch
108       // tree explosion due to a possible perpetual check or similar rare cases
109       // when TT table is full.
110       if (ttm && !pos.is_capture_or_promotion(ttm))
111           ttm = MOVE_NONE;
112   }
113   else
114   {
115       phase = RECAPTURE;
116       recaptureSquare = sq;
117       ttm = MOVE_NONE;
118   }
119
120   ttMove = (ttm && pos.is_pseudo_legal(ttm) ? ttm : MOVE_NONE);
121   lastMove += (ttMove != MOVE_NONE);
122 }
123
124 MovePicker::MovePicker(const Position& p, Move ttm, const History& h, PieceType pt)
125                        : pos(p), H(h), curMove(moves), lastMove(moves) {
126
127   assert(!pos.in_check());
128
129   phase = PROBCUT;
130
131   // In ProbCut we generate only captures better than parent's captured piece
132   captureThreshold = PieceValueMidgame[pt];
133   ttMove = (ttm && pos.is_pseudo_legal(ttm) ? ttm : MOVE_NONE);
134
135   if (ttMove && (!pos.is_capture(ttMove) ||  pos.see(ttMove) <= captureThreshold))
136       ttMove = MOVE_NONE;
137
138   lastMove += (ttMove != MOVE_NONE);
139 }
140
141
142 /// MovePicker::score_captures(), MovePicker::score_noncaptures() and
143 /// MovePicker::score_evasions() assign a numerical move ordering score
144 /// to each move in a move list.  The moves with highest scores will be
145 /// picked first by next_move().
146
147 void MovePicker::score_captures() {
148   // Winning and equal captures in the main search are ordered by MVV/LVA.
149   // Suprisingly, this appears to perform slightly better than SEE based
150   // move ordering. The reason is probably that in a position with a winning
151   // capture, capturing a more valuable (but sufficiently defended) piece
152   // first usually doesn't hurt. The opponent will have to recapture, and
153   // the hanging piece will still be hanging (except in the unusual cases
154   // where it is possible to recapture with the hanging piece). Exchanging
155   // big pieces before capturing a hanging piece probably helps to reduce
156   // the subtree size.
157   // In main search we want to push captures with negative SEE values to
158   // badCaptures[] array, but instead of doing it now we delay till when
159   // the move has been picked up in pick_move_from_list(), this way we save
160   // some SEE calls in case we get a cutoff (idea from Pablo Vazquez).
161   Move m;
162
163   for (MoveStack* cur = moves; cur != lastMove; cur++)
164   {
165       m = cur->move;
166       cur->score =  PieceValueMidgame[pos.piece_on(to_sq(m))]
167                   - type_of(pos.piece_moved(m));
168
169       if (type_of(m) == PROMOTION)
170           cur->score += PieceValueMidgame[promotion_type(m)];
171   }
172 }
173
174 void MovePicker::score_noncaptures() {
175
176   Move m;
177
178   for (MoveStack* cur = moves; cur != lastMove; cur++)
179   {
180       m = cur->move;
181       cur->score = H.value(pos.piece_moved(m), to_sq(m));
182   }
183 }
184
185 void MovePicker::score_evasions() {
186   // Try good captures ordered by MVV/LVA, then non-captures if destination square
187   // is not under attack, ordered by history value, then bad-captures and quiet
188   // moves with a negative SEE. This last group is ordered by the SEE score.
189   Move m;
190   int seeScore;
191
192   if (lastMove < moves + 2)
193       return;
194
195   for (MoveStack* cur = moves; cur != lastMove; cur++)
196   {
197       m = cur->move;
198       if ((seeScore = pos.see_sign(m)) < 0)
199           cur->score = seeScore - History::MaxValue; // Be sure we are at the bottom
200       else if (pos.is_capture(m))
201           cur->score =  PieceValueMidgame[pos.piece_on(to_sq(m))]
202                       - type_of(pos.piece_moved(m)) + History::MaxValue;
203       else
204           cur->score = H.value(pos.piece_moved(m), to_sq(m));
205   }
206 }
207
208
209 /// MovePicker::generate_next() generates, scores and sorts the next bunch of moves,
210 /// when there are no more moves to try for the current phase.
211
212 void MovePicker::generate_next() {
213
214   curMove = moves;
215
216   switch (++phase) {
217
218   case CAPTURES_S1: case CAPTURES_S3: case CAPTURES_S4: case CAPTURES_S5: case CAPTURES_S6:
219       lastMove = generate<CAPTURES>(pos, moves);
220       score_captures();
221       return;
222
223   case KILLERS_S1:
224       curMove = killers;
225       lastMove = curMove + 2;
226       return;
227
228   case QUIETS_1_S1:
229       lastQuiet = lastMove = generate<QUIETS>(pos, moves);
230       score_noncaptures();
231       lastMove = std::partition(curMove, lastMove, has_positive_score);
232       sort<MoveStack>(curMove, lastMove);
233       return;
234
235   case QUIETS_2_S1:
236       curMove = lastMove;
237       lastMove = lastQuiet;
238       if (depth >= 3 * ONE_PLY)
239           sort<MoveStack>(curMove, lastMove);
240       return;
241
242   case BAD_CAPTURES_S1:
243       // Just pick them in reverse order to get MVV/LVA ordering
244       curMove = moves + MAX_MOVES - 1;
245       lastMove = lastBadCapture;
246       return;
247
248   case EVASIONS_S2:
249       lastMove = generate<EVASIONS>(pos, moves);
250       score_evasions();
251       return;
252
253   case QUIET_CHECKS_S3:
254       lastMove = generate<QUIET_CHECKS>(pos, moves);
255       return;
256
257   case EVASION: case QSEARCH_0: case QSEARCH_1: case PROBCUT: case RECAPTURE:
258       phase = STOP;
259   case STOP:
260       lastMove = curMove + 1; // Avoid another next_phase() call
261       return;
262
263   default:
264       assert(false);
265   }
266 }
267
268
269 /// MovePicker::next_move() is the most important method of the MovePicker class.
270 /// It returns a new pseudo legal move every time it is called, until there
271 /// are no more moves left. It picks the move with the biggest score from a list
272 /// of generated moves taking care not to return the tt move if has already been
273 /// searched previously. Note that this function is not thread safe so should be
274 /// lock protected by caller when accessed through a shared MovePicker object.
275
276 Move MovePicker::next_move() {
277
278   Move move;
279
280   while (true)
281   {
282       while (curMove == lastMove)
283           generate_next();
284
285       switch (phase) {
286
287       case MAIN_SEARCH: case EVASION: case QSEARCH_0: case QSEARCH_1: case PROBCUT:
288           curMove++;
289           return ttMove;
290
291       case CAPTURES_S1:
292           move = pick_best(curMove++, lastMove)->move;
293           if (move != ttMove)
294           {
295               assert(captureThreshold <= 0); // Otherwise we cannot use see_sign()
296
297               if (pos.see_sign(move) >= captureThreshold)
298                   return move;
299
300               // Losing capture, move it to the tail of the array
301               (lastBadCapture--)->move = move;
302           }
303           break;
304
305       case KILLERS_S1:
306           move = (curMove++)->move;
307           if (    move != MOVE_NONE
308               &&  pos.is_pseudo_legal(move)
309               &&  move != ttMove
310               && !pos.is_capture(move))
311               return move;
312           break;
313
314       case QUIETS_1_S1: case QUIETS_2_S1:
315           move = (curMove++)->move;
316           if (   move != ttMove
317               && move != killers[0].move
318               && move != killers[1].move)
319               return move;
320           break;
321
322       case BAD_CAPTURES_S1:
323           return (curMove--)->move;
324
325       case EVASIONS_S2: case CAPTURES_S3: case CAPTURES_S4:
326           move = pick_best(curMove++, lastMove)->move;
327           if (move != ttMove)
328               return move;
329           break;
330
331       case CAPTURES_S5:
332            move = pick_best(curMove++, lastMove)->move;
333            if (move != ttMove && pos.see(move) > captureThreshold)
334                return move;
335            break;
336
337       case CAPTURES_S6:
338           move = pick_best(curMove++, lastMove)->move;
339           if (to_sq(move) == recaptureSquare)
340               return move;
341           break;
342
343       case QUIET_CHECKS_S3:
344           move = (curMove++)->move;
345           if (move != ttMove)
346               return move;
347           break;
348
349       case STOP:
350           return MOVE_NONE;
351
352       default:
353           assert(false);
354       }
355   }
356 }