Merge Stats tables
[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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
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
25 namespace {
26
27   enum Stages {
28     MAIN_SEARCH, CAPTURES_INIT, GOOD_CAPTURES, KILLER0, KILLER1, COUNTERMOVE, QUIET_INIT, QUIET, BAD_CAPTURES,
29     EVASION, EVASIONS_INIT, ALL_EVASIONS,
30     PROBCUT, PROBCUT_CAPTURES_INIT, PROBCUT_CAPTURES,
31     QSEARCH, QCAPTURES_INIT, QCAPTURES, QCHECKS, QSEARCH_RECAPTURES, QRECAPTURES
32   };
33
34   // partial_insertion_sort() sorts moves in descending order up to and including
35   // a given limit. The order of moves smaller than the limit is left unspecified.
36   void partial_insertion_sort(ExtMove* begin, ExtMove* end, int limit) {
37
38     for (ExtMove *sortedEnd = begin, *p = begin + 1; p < end; ++p)
39         if (p->value >= limit)
40         {
41             ExtMove tmp = *p, *q;
42             *p = *++sortedEnd;
43             for (q = sortedEnd; q != begin && *(q - 1) < tmp; --q)
44                 *q = *(q - 1);
45             *q = tmp;
46         }
47   }
48
49   // pick_best() finds the best move in the range (begin, end) and moves it to
50   // the front. It's faster than sorting all the moves in advance when there
51   // are few moves, e.g., the possible captures.
52   Move pick_best(ExtMove* begin, ExtMove* end) {
53
54     std::swap(*begin, *std::max_element(begin, end));
55     return *begin;
56   }
57
58 } // namespace
59
60
61 /// Constructors of the MovePicker class. As arguments we pass information
62 /// to help it to return the (presumably) good moves first, to decide which
63 /// moves to return (in the quiescence search, for instance, we only want to
64 /// search captures, promotions, and some checks) and how important good move
65 /// ordering is at the current node.
66
67 /// MovePicker constructor for the main search
68 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const ButterflyHistory* mh,
69                        const CapturePieceToHistory* cph, const PieceToHistory** ch, Move cm, Move* killers_p)
70            : pos(p), mainHistory(mh), captureHistory(cph), contHistory(ch), countermove(cm),
71              killers{killers_p[0], killers_p[1]}, depth(d){
72
73   assert(d > DEPTH_ZERO);
74
75   stage = pos.checkers() ? EVASION : MAIN_SEARCH;
76   ttMove = ttm && pos.pseudo_legal(ttm) ? ttm : MOVE_NONE;
77   stage += (ttMove == MOVE_NONE);
78 }
79
80 /// MovePicker constructor for quiescence search
81 MovePicker::MovePicker(const Position& p, Move ttm, Depth d, const ButterflyHistory* mh,  const CapturePieceToHistory* cph, Square s)
82            : pos(p), mainHistory(mh), captureHistory(cph), depth(d) {
83
84   assert(d <= DEPTH_ZERO);
85
86   if (pos.checkers())
87       stage = EVASION;
88
89   else if (d > DEPTH_QS_RECAPTURES)
90       stage = QSEARCH;
91
92   else
93   {
94       stage = QSEARCH_RECAPTURES;
95       recaptureSquare = s;
96       return;
97   }
98
99   ttMove = ttm && pos.pseudo_legal(ttm) ? ttm : MOVE_NONE;
100   stage += (ttMove == MOVE_NONE);
101 }
102
103 /// MovePicker constructor for ProbCut: we generate captures with SEE higher
104 /// than or equal to the given threshold.
105 MovePicker::MovePicker(const Position& p, Move ttm, Value th, const CapturePieceToHistory* cph)
106            : pos(p), captureHistory(cph), threshold(th) {
107
108   assert(!pos.checkers());
109
110   stage = PROBCUT;
111   ttMove =   ttm
112           && pos.pseudo_legal(ttm)
113           && pos.capture(ttm)
114           && pos.see_ge(ttm, threshold) ? ttm : MOVE_NONE;
115
116   stage += (ttMove == MOVE_NONE);
117 }
118
119 /// score() assigns a numerical value to each move in a list, used for sorting.
120 /// Captures are ordered by Most Valuable Victim (MVV), preferring captures
121 /// with a good history. Quiets are ordered using the histories.
122 template<GenType Type>
123 void MovePicker::score() {
124
125   static_assert(Type == CAPTURES || Type == QUIETS || Type == EVASIONS, "Wrong type");
126
127   for (auto& m : *this)
128       if (Type == CAPTURES)
129           m.value =  PieceValue[MG][pos.piece_on(to_sq(m))]
130                    + (*captureHistory)[pos.moved_piece(m)][to_sq(m)][type_of(pos.piece_on(to_sq(m)))];
131
132       else if (Type == QUIETS)
133           m.value =  (*mainHistory)[pos.side_to_move()][from_to(m)]
134                    + (*contHistory[0])[pos.moved_piece(m)][to_sq(m)]
135                    + (*contHistory[1])[pos.moved_piece(m)][to_sq(m)]
136                    + (*contHistory[3])[pos.moved_piece(m)][to_sq(m)];
137
138       else // Type == EVASIONS
139       {
140           if (pos.capture(m))
141               m.value =  PieceValue[MG][pos.piece_on(to_sq(m))]
142                        - Value(type_of(pos.moved_piece(m)));
143           else
144               m.value = (*mainHistory)[pos.side_to_move()][from_to(m)] - (1 << 28);
145       }
146 }
147
148 /// next_move() is the most important method of the MovePicker class. It returns
149 /// a new pseudo legal move every time it is called, until there are no more moves
150 /// left. It picks the move with the biggest value from a list of generated moves
151 /// taking care not to return the ttMove if it has already been searched.
152
153 Move MovePicker::next_move(bool skipQuiets) {
154
155   Move move;
156
157   switch (stage) {
158
159   case MAIN_SEARCH: case EVASION: case QSEARCH: case PROBCUT:
160       ++stage;
161       return ttMove;
162
163   case CAPTURES_INIT:
164   case PROBCUT_CAPTURES_INIT:
165   case QCAPTURES_INIT:
166   case QSEARCH_RECAPTURES:
167       endBadCaptures = cur = moves;
168       endMoves = generate<CAPTURES>(pos, cur);
169       score<CAPTURES>();
170       ++stage;
171
172       // Rebranch at the top of the switch via a recursive call
173       return next_move(skipQuiets);
174
175   case GOOD_CAPTURES:
176       while (cur < endMoves)
177       {
178           move = pick_best(cur++, endMoves);
179           if (move != ttMove)
180           {
181               if (pos.see_ge(move, Value(-55 * (cur-1)->value / 1024)))
182                   return move;
183
184               // Losing capture, move it to the beginning of the array
185               *endBadCaptures++ = move;
186           }
187       }
188       ++stage;
189       /* fallthrough */
190
191   case KILLER0:
192   case KILLER1:
193       do
194       {
195           move = killers[++stage - KILLER1];
196           if (    move != MOVE_NONE
197               &&  move != ttMove
198               &&  pos.pseudo_legal(move)
199               && !pos.capture(move))
200               return move;
201       } while (stage <= KILLER1);
202       /* fallthrough */
203
204   case COUNTERMOVE:
205       ++stage;
206       move = countermove;
207       if (    move != MOVE_NONE
208           &&  move != ttMove
209           &&  move != killers[0]
210           &&  move != killers[1]
211           &&  pos.pseudo_legal(move)
212           && !pos.capture(move))
213           return move;
214       /* fallthrough */
215
216   case QUIET_INIT:
217       cur = endBadCaptures;
218       endMoves = generate<QUIETS>(pos, cur);
219       score<QUIETS>();
220       partial_insertion_sort(cur, endMoves, -4000 * depth / ONE_PLY);
221       ++stage;
222       /* fallthrough */
223
224   case QUIET:
225       if (!skipQuiets)
226          while (cur < endMoves)
227          {
228              move = *cur++;
229
230              if (   move != ttMove
231                  && move != killers[0]
232                  && move != killers[1]
233                  && move != countermove)
234                  return move;
235          }
236       ++stage;
237       cur = moves; // Point to beginning of bad captures
238       /* fallthrough */
239
240   case BAD_CAPTURES:
241       if (cur < endBadCaptures)
242           return *cur++;
243       break;
244
245   case EVASIONS_INIT:
246       cur = moves;
247       endMoves = generate<EVASIONS>(pos, cur);
248       score<EVASIONS>();
249       ++stage;
250       /* fallthrough */
251
252   case ALL_EVASIONS:
253       while (cur < endMoves)
254       {
255           move = pick_best(cur++, endMoves);
256           if (move != ttMove)
257               return move;
258       }
259       break;
260
261   case PROBCUT_CAPTURES:
262       while (cur < endMoves)
263       {
264           move = pick_best(cur++, endMoves);
265           if (   move != ttMove
266               && pos.see_ge(move, threshold))
267               return move;
268       }
269       break;
270
271   case QCAPTURES:
272       while (cur < endMoves)
273       {
274           move = pick_best(cur++, endMoves);
275           if (move != ttMove)
276               return move;
277       }
278       if (depth <= DEPTH_QS_NO_CHECKS)
279           break;
280       cur = moves;
281       endMoves = generate<QUIET_CHECKS>(pos, cur);
282       ++stage;
283       /* fallthrough */
284
285   case QCHECKS:
286       while (cur < endMoves)
287       {
288           move = cur++->move;
289           if (move != ttMove)
290               return move;
291       }
292       break;
293
294   case QRECAPTURES:
295       while (cur < endMoves)
296       {
297           move = *cur++;
298           if (to_sq(move) == recaptureSquare)
299               return move;
300       }
301       break;
302
303   default:
304       assert(false);
305   }
306
307   return MOVE_NONE;
308 }