cea4efb4bebd1a00deb723e4920d7306db09aa42
[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-2009 Marco Costalba
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
22 ////
23 //// Includes
24 ////
25
26 #include <algorithm>
27 #include <cassert>
28
29 #include "history.h"
30 #include "evaluate.h"
31 #include "movegen.h"
32 #include "movepick.h"
33 #include "search.h"
34 #include "value.h"
35
36
37 ////
38 //// Local definitions
39 ////
40
41 namespace {
42
43   /// Variables
44
45   MovePicker::MovegenPhase PhaseTable[32];
46   int MainSearchPhaseIndex;
47   int EvasionsPhaseIndex;
48   int QsearchWithChecksPhaseIndex;
49   int QsearchWithoutChecksPhaseIndex;
50
51 }
52
53
54 ////
55 //// Functions
56 ////
57
58
59 /// Constructor for the MovePicker class.  Apart from the position for which
60 /// it is asked to pick legal moves, MovePicker also wants some information
61 /// to help it to return the presumably good moves first, to decide which
62 /// moves to return (in the quiescence search, for instance, we only want to
63 /// search captures, promotions and some checks) and about how important good
64 /// move ordering is at the current node.
65
66 MovePicker::MovePicker(const Position& p, Move ttm, Depth d,
67                        const History& h, SearchStack* ss) : pos(p), H(h) {
68   ttMove = ttm;
69   if (ss)
70   {
71       mateKiller = (ss->mateKiller == ttm)? MOVE_NONE : ss->mateKiller;
72       killer1 = ss->killers[0];
73       killer2 = ss->killers[1];
74   } else
75       mateKiller = killer1 = killer2 = MOVE_NONE;
76
77   movesPicked = numOfMoves = numOfBadCaptures = 0;
78   checkKillers = checkLegal = finished = false;
79
80   if (p.is_check())
81       phaseIndex = EvasionsPhaseIndex;
82   else if (d > Depth(0))
83       phaseIndex = MainSearchPhaseIndex;
84   else if (d == Depth(0))
85       phaseIndex = QsearchWithChecksPhaseIndex;
86   else
87       phaseIndex = QsearchWithoutChecksPhaseIndex;
88
89   Color us = pos.side_to_move();
90
91   dc = p.discovered_check_candidates(us);
92   pinned = p.pinned_pieces(us);
93
94   finished = false;
95 }
96
97
98 /// MovePicker::get_next_move() is the most important method of the MovePicker
99 /// class.  It returns a new legal move every time it is called, until there
100 /// are no more moves left of the types we are interested in.
101
102 Move MovePicker::get_next_move() {
103
104   Move move;
105
106   while (true)
107   {
108     // If we already have a list of generated moves, pick the best move from
109     // the list, and return it.
110     move = pick_move_from_list();
111     if (move != MOVE_NONE)
112     {
113         assert(move_is_ok(move));
114         return move;
115     }
116
117     // Next phase
118     phaseIndex++;
119     switch (PhaseTable[phaseIndex]) {
120
121     case PH_TT_MOVE:
122         if (ttMove != MOVE_NONE)
123         {
124             assert(move_is_ok(ttMove));
125             if (move_is_legal(pos, ttMove, pinned))
126                 return ttMove;
127         }
128         break;
129
130     case PH_MATE_KILLER:
131         if (mateKiller != MOVE_NONE)
132         {
133             assert(move_is_ok(mateKiller));
134             if (move_is_legal(pos, mateKiller, pinned))
135                 return mateKiller;
136         }
137         break;
138
139     case PH_GOOD_CAPTURES:
140         numOfMoves = generate_captures(pos, moves);
141         score_captures();
142         std::sort(moves, moves + numOfMoves);
143         movesPicked = 0;
144         checkLegal = true;
145         break;
146
147     case PH_KILLERS:
148         movesPicked = numOfMoves = 0;
149         checkLegal = false;
150         if (killer1 != MOVE_NONE && move_is_legal(pos, killer1, pinned) && !pos.move_is_capture(killer1))
151             moves[numOfMoves++].move = killer1;
152         if (killer2 != MOVE_NONE && move_is_legal(pos, killer2, pinned) && !pos.move_is_capture(killer2) )
153             moves[numOfMoves++].move = killer2;
154         break;
155
156     case PH_NONCAPTURES:
157         checkKillers = (numOfMoves != 0); // previous phase is PH_KILLERS
158         numOfMoves = generate_noncaptures(pos, moves);
159         score_noncaptures();
160         std::sort(moves, moves + numOfMoves);
161         movesPicked = 0;
162         checkLegal = true;
163         break;
164
165     case PH_BAD_CAPTURES:
166         // Bad captures SEE value is already calculated by score_captures()
167         // so just sort them to get SEE move ordering.
168         std::sort(badCaptures, badCaptures + numOfBadCaptures);
169         movesPicked = 0;
170         break;
171
172     case PH_EVASIONS:
173         assert(pos.is_check());
174         numOfMoves = generate_evasions(pos, moves, pinned);
175         score_evasions();
176         std::sort(moves, moves + numOfMoves);
177         movesPicked = 0;
178         break;
179
180     case PH_QCAPTURES:
181         numOfMoves = generate_captures(pos, moves);
182         score_qcaptures();
183         std::sort(moves, moves + numOfMoves);
184         movesPicked = 0;
185         break;
186
187     case PH_QCHECKS:
188         // Perhaps we should order moves move here?  FIXME
189         numOfMoves = generate_non_capture_checks(pos, moves, dc);
190         movesPicked = 0;
191         break;
192
193     case PH_STOP:
194         return MOVE_NONE;
195
196     default:
197         assert(false);
198         return MOVE_NONE;
199     }
200   }
201 }
202
203
204 /// A variant of get_next_move() which takes a lock as a parameter, used to
205 /// prevent multiple threads from picking the same move at a split point.
206
207 Move MovePicker::get_next_move(Lock &lock) {
208
209    lock_grab(&lock);
210    if (finished)
211    {
212        lock_release(&lock);
213        return MOVE_NONE;
214    }
215    Move m = get_next_move();
216    if (m == MOVE_NONE)
217        finished = true;
218
219    lock_release(&lock);
220    return m;
221 }
222
223
224 /// MovePicker::score_captures(), MovePicker::score_noncaptures(),
225 /// MovePicker::score_evasions() and MovePicker::score_qcaptures() assign a
226 /// numerical move ordering score to each move in a move list.  The moves
227 /// with highest scores will be picked first by pick_move_from_list().
228
229 void MovePicker::score_captures() {
230   // Winning and equal captures in the main search are ordered by MVV/LVA.
231   // Suprisingly, this appears to perform slightly better than SEE based
232   // move ordering.  The reason is probably that in a position with a winning
233   // capture, capturing a more valuable (but sufficiently defended) piece
234   // first usually doesn't hurt.  The opponent will have to recapture, and
235   // the hanging piece will still be hanging (except in the unusual cases
236   // where it is possible to recapture with the hanging piece). Exchanging
237   // big pieces before capturing a hanging piece probably helps to reduce
238   // the subtree size.
239   // While scoring captures it moves all captures with negative SEE values
240   // to the badCaptures[] array.
241   Move m;
242   int seeValue;
243
244   for (int i = 0; i < numOfMoves; i++)
245   {
246       m = moves[i].move;
247       seeValue = pos.see(m);
248       if (seeValue >= 0)
249       {
250           if (move_is_promotion(m))
251               moves[i].score = QueenValueMidgame;
252           else
253               moves[i].score = int(pos.midgame_value_of_piece_on(move_to(m)))
254                               -int(pos.type_of_piece_on(move_from(m)));
255       }
256       else
257       {
258           // Losing capture, move it to the badCaptures[] array
259           assert(numOfBadCaptures < 63);
260           moves[i].score = seeValue;
261           badCaptures[numOfBadCaptures++] = moves[i];
262           moves[i--] = moves[--numOfMoves];
263       }
264   }
265 }
266
267 void MovePicker::score_noncaptures() {
268   // First score by history, when no history is available then use
269   // piece/square tables values. This seems to be better then a
270   // random choice when we don't have an history for any move.
271   Move m;
272   int hs;
273
274   for (int i = 0; i < numOfMoves; i++)
275   {
276       m = moves[i].move;
277       hs = H.move_ordering_score(pos.piece_on(move_from(m)), move_to(m));
278
279       // Ensure history is always preferred to pst
280       if (hs > 0)
281           hs += 1000;
282
283       // pst based scoring
284       moves[i].score = hs + pos.mg_pst_delta(m);
285   }
286 }
287
288 void MovePicker::score_evasions() {
289
290   for (int i = 0; i < numOfMoves; i++)
291   {
292       Move m = moves[i].move;
293       if (m == ttMove)
294           moves[i].score = 2*HistoryMax;
295       else if (!pos.square_is_empty(move_to(m)))
296       {
297           int seeScore = pos.see(m);
298           moves[i].score = (seeScore >= 0)? seeScore + HistoryMax : seeScore;
299       } else
300           moves[i].score = H.move_ordering_score(pos.piece_on(move_from(m)), move_to(m));
301   }
302 }
303
304 void MovePicker::score_qcaptures() {
305
306   // Use MVV/LVA ordering
307   for (int i = 0; i < numOfMoves; i++)
308   {
309       Move m = moves[i].move;
310       if (move_is_promotion(m))
311           moves[i].score = QueenValueMidgame;
312       else
313           moves[i].score = int(pos.midgame_value_of_piece_on(move_to(m)))
314                           -int(pos.type_of_piece_on(move_from(m)));
315   }
316 }
317
318
319 /// MovePicker::pick_move_from_list() picks the move with the biggest score
320 /// from a list of generated moves (moves[] or badCaptures[], depending on
321 /// the current move generation phase).  It takes care not to return the
322 /// transposition table move if that has already been serched previously.
323
324 Move MovePicker::pick_move_from_list() {
325
326   assert(movesPicked >= 0);
327   assert(!pos.is_check() || PhaseTable[phaseIndex] == PH_EVASIONS || PhaseTable[phaseIndex] == PH_STOP);
328   assert( pos.is_check() || PhaseTable[phaseIndex] != PH_EVASIONS);
329
330   switch (PhaseTable[phaseIndex]) {
331
332   case PH_GOOD_CAPTURES:
333   case PH_KILLERS:
334   case PH_NONCAPTURES:
335       while (movesPicked < numOfMoves)
336       {
337           Move move = moves[movesPicked++].move;
338           if (   move != ttMove
339               && move != mateKiller
340               && (!checkKillers || (move != killer1 && move != killer2))
341               && (!checkLegal || pos.pl_move_is_legal(move, pinned)))
342               return move;
343       }
344       break;
345
346   case PH_EVASIONS:
347       if (movesPicked < numOfMoves)
348           return moves[movesPicked++].move;
349
350       break;
351
352   case PH_BAD_CAPTURES:
353       while (movesPicked < numOfBadCaptures)
354       {
355           Move move = badCaptures[movesPicked++].move;
356           if (   move != ttMove
357               && move != mateKiller
358               && pos.pl_move_is_legal(move, pinned))
359               return move;
360       }
361       break;
362
363   case PH_QCAPTURES:
364   case PH_QCHECKS:
365       while (movesPicked < numOfMoves)
366       {
367           Move move = moves[movesPicked++].move;
368           // Maybe postpone the legality check until after futility pruning?
369           if (   move != ttMove
370               && pos.pl_move_is_legal(move, pinned))
371               return move;
372       }
373       break;
374
375   default:
376       break;
377   }
378   return MOVE_NONE;
379 }
380
381
382 /// MovePicker::init_phase_table() initializes the PhaseTable[],
383 /// MainSearchPhaseIndex, EvasionPhaseIndex, QsearchWithChecksPhaseIndex
384 /// and QsearchWithoutChecksPhaseIndex. It is only called once during
385 /// program startup, and never again while the program is running.
386
387 void MovePicker::init_phase_table() {
388
389   int i = 0;
390
391   // Main search
392   MainSearchPhaseIndex = i - 1;
393   PhaseTable[i++] = PH_TT_MOVE;
394   PhaseTable[i++] = PH_MATE_KILLER;
395   PhaseTable[i++] = PH_GOOD_CAPTURES;
396   PhaseTable[i++] = PH_KILLERS;
397   PhaseTable[i++] = PH_NONCAPTURES;
398   PhaseTable[i++] = PH_BAD_CAPTURES;
399   PhaseTable[i++] = PH_STOP;
400
401   // Check evasions
402   EvasionsPhaseIndex = i - 1;
403   PhaseTable[i++] = PH_EVASIONS;
404   PhaseTable[i++] = PH_STOP;
405
406   // Quiescence search with checks
407   QsearchWithChecksPhaseIndex = i - 1;
408   PhaseTable[i++] = PH_TT_MOVE;
409   PhaseTable[i++] = PH_QCAPTURES;
410   PhaseTable[i++] = PH_QCHECKS;
411   PhaseTable[i++] = PH_STOP;
412
413   // Quiescence search without checks
414   QsearchWithoutChecksPhaseIndex = i - 1;
415   PhaseTable[i++] = PH_TT_MOVE;
416   PhaseTable[i++] = PH_QCAPTURES;
417   PhaseTable[i++] = PH_STOP;
418 }