Use a per-thread array for generated 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-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 = pos.this_thread()->get_moves_array();
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) {
95
96   assert(d <= DEPTH_ZERO);
97
98   cur = end = moves = pos.this_thread()->get_moves_array();
99   if (p.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.is_capture_or_promotion(ttm))
113           ttm = MOVE_NONE;
114   }
115   else
116   {
117       stage = RECAPTURE;
118       recaptureSquare = sq;
119       ttm = MOVE_NONE;
120   }
121
122   ttMove = (ttm && pos.is_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) {
128
129   assert(!pos.checkers());
130
131   cur = end = moves = pos.this_thread()->get_moves_array();
132   stage = PROBCUT;
133
134   // In ProbCut we generate only captures better than parent's captured piece
135   captureThreshold = PieceValue[MG][pt];
136   ttMove = (ttm && pos.is_pseudo_legal(ttm) ? ttm : MOVE_NONE);
137
138   if (ttMove && (!pos.is_capture(ttMove) ||  pos.see(ttMove) <= captureThreshold))
139       ttMove = MOVE_NONE;
140
141   end += (ttMove != MOVE_NONE);
142 }
143
144 MovePicker::~MovePicker() { pos.this_thread()->free_moves_array(); }
145
146 /// score() assign a numerical move ordering score to each move in a move list.
147 /// The moves with highest scores will be picked first.
148 template<>
149 void MovePicker::score<CAPTURES>() {
150   // Winning and equal captures in the main search are ordered by MVV/LVA.
151   // Suprisingly, this appears to perform slightly better than SEE based
152   // move ordering. The reason is probably that in a position with a winning
153   // capture, capturing a more valuable (but sufficiently defended) piece
154   // first usually doesn't hurt. The opponent will have to recapture, and
155   // the hanging piece will still be hanging (except in the unusual cases
156   // where it is possible to recapture with the hanging piece). Exchanging
157   // big pieces before capturing a hanging piece probably helps to reduce
158   // the subtree size.
159   // In main search we want to push captures with negative SEE values to
160   // badCaptures[] array, but instead of doing it now we delay till when
161   // the move has been picked up in pick_move_from_list(), this way we save
162   // some SEE calls in case we get a cutoff (idea from Pablo Vazquez).
163   Move m;
164
165   for (ExtMove* it = moves; it != end; ++it)
166   {
167       m = it->move;
168       it->score =  PieceValue[MG][pos.piece_on(to_sq(m))]
169                  - type_of(pos.piece_moved(m));
170
171       if (type_of(m) == PROMOTION)
172           it->score += PieceValue[MG][promotion_type(m)] - PieceValue[MG][PAWN];
173
174       else if (type_of(m) == ENPASSANT)
175           it->score += PieceValue[MG][PAWN];
176   }
177 }
178
179 template<>
180 void MovePicker::score<QUIETS>() {
181
182   Move m;
183
184   for (ExtMove* it = moves; it != end; ++it)
185   {
186       m = it->move;
187       it->score = history[pos.piece_moved(m)][to_sq(m)];
188   }
189 }
190
191 template<>
192 void MovePicker::score<EVASIONS>() {
193   // Try good captures ordered by MVV/LVA, then non-captures if destination square
194   // is not under attack, ordered by history value, then bad-captures and quiet
195   // moves with a negative SEE. This last group is ordered by the SEE score.
196   Move m;
197   int seeScore;
198
199   for (ExtMove* it = moves; it != end; ++it)
200   {
201       m = it->move;
202       if ((seeScore = pos.see_sign(m)) < 0)
203           it->score = seeScore - HistoryStats::Max; // At the bottom
204
205       else if (pos.is_capture(m))
206           it->score =  PieceValue[MG][pos.piece_on(to_sq(m))]
207                      - type_of(pos.piece_moved(m)) + HistoryStats::Max;
208       else
209           it->score = history[pos.piece_moved(m)][to_sq(m)];
210   }
211 }
212
213
214 /// generate_next() generates, scores and sorts the next bunch of moves, when
215 /// there are no more moves to try for the current phase.
216
217 void MovePicker::generate_next() {
218
219   cur = moves;
220
221   switch (++stage) {
222
223   case CAPTURES_S1: case CAPTURES_S3: case CAPTURES_S4: case CAPTURES_S5: case CAPTURES_S6:
224       end = generate<CAPTURES>(pos, moves);
225       score<CAPTURES>();
226       return;
227
228   case KILLERS_S1:
229       cur = killers;
230       end = cur + 2;
231
232       killers[0].move = ss->killers[0];
233       killers[1].move = ss->killers[1];
234       killers[2].move = killers[3].move = MOVE_NONE;
235
236       // Be sure countermoves are different from killers
237       for (int i = 0; i < 2; ++i)
238           if (countermoves[i] != cur->move && countermoves[i] != (cur+1)->move)
239               (end++)->move = countermoves[i];
240
241       if (countermoves[1] && countermoves[1] == countermoves[0]) // Due to SMP races
242           killers[3].move = MOVE_NONE;
243
244       return;
245
246   case QUIETS_1_S1:
247       endQuiets = end = generate<QUIETS>(pos, moves);
248       score<QUIETS>();
249       end = std::partition(cur, end, has_positive_score);
250       insertion_sort(cur, end);
251       return;
252
253   case QUIETS_2_S1:
254       cur = end;
255       end = endQuiets;
256       if (depth >= 3 * ONE_PLY)
257           insertion_sort(cur, end);
258       return;
259
260   case BAD_CAPTURES_S1:
261       // Just pick them in reverse order to get MVV/LVA ordering
262       cur = moves + MAX_MOVES - 1;
263       end = endBadCaptures;
264       return;
265
266   case EVASIONS_S2:
267       end = generate<EVASIONS>(pos, moves);
268       if (end > moves + 1)
269           score<EVASIONS>();
270       return;
271
272   case QUIET_CHECKS_S3:
273       end = generate<QUIET_CHECKS>(pos, moves);
274       return;
275
276   case EVASION: case QSEARCH_0: case QSEARCH_1: case PROBCUT: case RECAPTURE:
277       stage = STOP;
278   case STOP:
279       end = cur + 1; // Avoid another next_phase() call
280       return;
281
282   default:
283       assert(false);
284   }
285 }
286
287
288 /// next_move() is the most important method of the MovePicker class. It returns
289 /// a new pseudo legal move every time is called, until there are no more moves
290 /// left. It picks the move with the biggest score from a list of generated moves
291 /// taking care not returning the ttMove if has already been searched previously.
292 template<>
293 Move MovePicker::next_move<false>() {
294
295   Move move;
296
297   while (true)
298   {
299       while (cur == end)
300           generate_next();
301
302       switch (stage) {
303
304       case MAIN_SEARCH: case EVASION: case QSEARCH_0: case QSEARCH_1: case PROBCUT:
305           cur++;
306           return ttMove;
307
308       case CAPTURES_S1:
309           move = pick_best(cur++, end)->move;
310           if (move != ttMove)
311           {
312               if (pos.see_sign(move) >= 0)
313                   return move;
314
315               // Losing capture, move it to the tail of the array
316               (endBadCaptures--)->move = move;
317           }
318           break;
319
320       case KILLERS_S1:
321           move = (cur++)->move;
322           if (    move != MOVE_NONE
323               &&  pos.is_pseudo_legal(move)
324               &&  move != ttMove
325               && !pos.is_capture(move))
326               return move;
327           break;
328
329       case QUIETS_1_S1: case QUIETS_2_S1:
330           move = (cur++)->move;
331           if (   move != ttMove
332               && move != killers[0].move
333               && move != killers[1].move
334               && move != killers[2].move
335               && move != killers[3].move)
336               return move;
337           break;
338
339       case BAD_CAPTURES_S1:
340           return (cur--)->move;
341
342       case EVASIONS_S2: case CAPTURES_S3: case CAPTURES_S4:
343           move = pick_best(cur++, end)->move;
344           if (move != ttMove)
345               return move;
346           break;
347
348       case CAPTURES_S5:
349            move = pick_best(cur++, end)->move;
350            if (move != ttMove && pos.see(move) > captureThreshold)
351                return move;
352            break;
353
354       case CAPTURES_S6:
355           move = pick_best(cur++, end)->move;
356           if (to_sq(move) == recaptureSquare)
357               return move;
358           break;
359
360       case QUIET_CHECKS_S3:
361           move = (cur++)->move;
362           if (move != ttMove)
363               return move;
364           break;
365
366       case STOP:
367           return MOVE_NONE;
368
369       default:
370           assert(false);
371       }
372   }
373 }
374
375
376 /// Version of next_move() to use at split point nodes where the move is grabbed
377 /// from the split point's shared MovePicker object. This function is not thread
378 /// safe so must be lock protected by the caller.
379 template<>
380 Move MovePicker::next_move<true>() { return ss->splitPoint->movePicker->next_move<false>(); }