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