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