]> git.sesse.net Git - stockfish/blob - src/movepick.cpp
MovePicker::find_best_index() never returns -1
[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 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 <cassert>
27
28 #include "history.h"
29 #include "evaluate.h"
30 #include "movegen.h"
31 #include "movepick.h"
32 #include "search.h"
33 #include "value.h"
34
35
36 ////
37 //// Local definitions
38 ////
39
40 namespace {
41
42   /// Variables
43
44   MovePicker::MovegenPhase PhaseTable[32];
45   int MainSearchPhaseIndex;
46   int EvasionsPhaseIndex;
47   int QsearchWithChecksPhaseIndex;
48   int QsearchNoCapturesPhaseIndex;
49   int QsearchWithoutChecksPhaseIndex;
50   int NoMovesPhaseIndex;
51
52 }
53
54
55
56 ////
57 //// Functions
58 ////
59
60
61 /// Constructor for the MovePicker class.  Apart from the position for which
62 /// it is asked to pick legal moves, MovePicker also wants some information
63 /// to help it to return the presumably good moves first, to decide which
64 /// moves to return (in the quiescence search, for instance, we only want to
65 /// search captures, promotions and some checks) and about how important good
66 /// move ordering is at the current node.
67
68 MovePicker::MovePicker(const Position& p, bool pv, Move ttm,
69                        const SearchStack& ss, Depth d, EvalInfo* ei) : pos(p) {
70   pvNode = pv;
71   ttMove = ttm;
72   mateKiller = (ss.mateKiller == ttm)? MOVE_NONE : ss.mateKiller;
73   killer1 = ss.killers[0];
74   killer2 = ss.killers[1];
75   depth = d;
76   movesPicked = 0;
77   numOfMoves = 0;
78   numOfBadCaptures = 0;
79
80   // With EvalInfo we are able to know how many captures are possible before
81   // generating them. So avoid generating in case we know are zero.
82   Color us = pos.side_to_move();
83   Color them = opposite_color(us);
84   bool noCaptures =    ei
85                    && (ei->attackedBy[us][0] & pos.pieces_of_color(them)) == 0
86                    && !ei->mi->specialized_eval_exists()
87                    && (pos.ep_square() == SQ_NONE)
88                    && !pos.has_pawn_on_7th(us);
89
90   if (p.is_check())
91       phaseIndex = EvasionsPhaseIndex;
92   else if (depth > Depth(0))
93       phaseIndex = MainSearchPhaseIndex;
94   else if (depth == Depth(0))
95       phaseIndex = (noCaptures ? QsearchNoCapturesPhaseIndex : QsearchWithChecksPhaseIndex);
96   else
97       phaseIndex = (noCaptures ? NoMovesPhaseIndex : QsearchWithoutChecksPhaseIndex);
98
99   dc = p.discovered_check_candidates(us);
100   pinned = p.pinned_pieces(p.side_to_move());
101
102   finished = false;
103 }
104
105
106 /// MovePicker::get_next_move() is the most important method of the MovePicker
107 /// class.  It returns a new legal move every time it is called, until there
108 /// are no more moves left of the types we are interested in.
109
110 Move MovePicker::get_next_move() {
111
112   Move move;
113
114   while (true)
115   {
116     // If we already have a list of generated moves, pick the best move from
117     // the list, and return it.
118     move = pick_move_from_list();
119     if (move != MOVE_NONE)
120     {
121         assert(move_is_ok(move));
122         return move;
123     }
124
125     // Next phase
126     phaseIndex++;
127     switch (PhaseTable[phaseIndex]) {
128
129     case PH_TT_MOVE:
130         if (ttMove != MOVE_NONE)
131         {
132             assert(move_is_ok(ttMove));
133             if (move_is_legal(pos, ttMove, pinned))
134                 return ttMove;
135         }
136         break;
137
138     case PH_MATE_KILLER:
139         if (mateKiller != MOVE_NONE)
140         {
141             assert(move_is_ok(mateKiller));
142             if (move_is_legal(pos, mateKiller, pinned))
143                 return mateKiller;
144        }
145        break;
146
147     case PH_GOOD_CAPTURES:
148         numOfMoves = generate_captures(pos, moves);
149         score_captures();
150         movesPicked = 0;
151         break;
152
153     case PH_BAD_CAPTURES:
154         badCapturesPicked = 0;
155         break;
156
157     case PH_NONCAPTURES:
158         numOfMoves = generate_noncaptures(pos, moves);
159         score_noncaptures();
160         movesPicked = 0;
161         break;
162
163     case PH_EVASIONS:
164         assert(pos.is_check());
165         numOfMoves = generate_evasions(pos, moves);
166         score_evasions();
167         movesPicked = 0;
168         break;
169
170     case PH_QCAPTURES:
171         numOfMoves = generate_captures(pos, moves);
172         score_qcaptures();
173         movesPicked = 0;
174         break;
175
176     case PH_QCHECKS:
177         numOfMoves = generate_checks(pos, moves, dc);
178         movesPicked = 0;
179         break;
180
181     case PH_STOP:
182         return MOVE_NONE;
183
184     default:
185         assert(false);
186         return MOVE_NONE;
187     }
188   }
189 }
190
191
192 /// A variant of get_next_move() which takes a lock as a parameter, used to
193 /// prevent multiple threads from picking the same move at a split point.
194
195 Move MovePicker::get_next_move(Lock &lock) {
196
197    lock_grab(&lock);
198    if (finished)
199    {
200        lock_release(&lock);
201        return MOVE_NONE;
202    }
203    Move m = get_next_move();
204    if (m == MOVE_NONE)
205        finished = true;
206
207    lock_release(&lock);
208    return m;
209 }
210
211
212 /// MovePicker::score_captures(), MovePicker::score_noncaptures(),
213 /// MovePicker::score_evasions() and MovePicker::score_qcaptures() assign a
214 /// numerical move ordering score to each move in a move list.  The moves
215 /// with highest scores will be picked first by pick_move_from_list().
216
217 void MovePicker::score_captures() {
218   // Winning and equal captures in the main search are ordered by MVV/LVA.
219   // Suprisingly, this appears to perform slightly better than SEE based
220   // move ordering.  The reason is probably that in a position with a winning
221   // capture, capturing a more valuable (but sufficiently defended) piece
222   // first usually doesn't hurt.  The opponent will have to recapture, and
223   // the hanging piece will still be hanging (except in the unusual cases
224   // where it is possible to recapture with the hanging piece). Exchanging
225   // big pieces before capturing a hanging piece probably helps to reduce
226   // the subtree size.
227   // While scoring captures it moves all captures with negative SEE values
228   // to the badCaptures[] array.
229   Move m;
230   int seeValue;
231
232   for (int i = 0; i < numOfMoves; i++)
233   {
234       m = moves[i].move;
235       seeValue = pos.see(m);
236       if (seeValue >= 0)
237       {
238           if (move_promotion(m))
239               moves[i].score = QueenValueMidgame;
240           else
241               moves[i].score = int(pos.midgame_value_of_piece_on(move_to(m)))
242                               -int(pos.type_of_piece_on(move_from(m)));
243       }
244       else
245       {
246           // Losing capture, move it to the badCaptures[] array
247           assert(numOfBadCaptures < 63);
248           moves[i].score = seeValue;
249           badCaptures[numOfBadCaptures++] = moves[i];
250           moves[i--] = moves[--numOfMoves];
251       }
252   }
253 }
254
255 void MovePicker::score_noncaptures() {
256   // First score by history, when no history is available then use
257   // piece/square tables values. This seems to be better then a
258   // random choice when we don't have an history for any move.
259   Move m;
260   int hs;
261
262   for (int i = 0; i < numOfMoves; i++)
263   {
264       m = moves[i].move;
265
266       if (m == killer1)
267           hs = HistoryMax + 2;
268       else if (m == killer2)
269           hs = HistoryMax + 1;
270       else
271           hs = H.move_ordering_score(pos.piece_on(move_from(m)), m);
272
273       // Ensure history is always preferred to pst
274       if (hs > 0)
275           hs += 1000;
276
277       // pst based scoring
278       moves[i].score = hs + pos.mg_pst_delta(m);
279   }
280 }
281
282 void MovePicker::score_evasions() {
283
284   for (int i = 0; i < numOfMoves; i++)
285   {
286       Move m = moves[i].move;
287       if (m == ttMove)
288           moves[i].score = 2*HistoryMax;
289       else if (!pos.square_is_empty(move_to(m)))
290       {
291           int seeScore = pos.see(m);
292           moves[i].score = (seeScore >= 0)? seeScore + HistoryMax : seeScore;
293       } else
294           moves[i].score = H.move_ordering_score(pos.piece_on(move_from(m)), m);
295   }
296 }
297
298 void MovePicker::score_qcaptures() {
299
300   // Use MVV/LVA ordering
301   for (int i = 0; i < numOfMoves; i++)
302   {
303       Move m = moves[i].move;
304       if (move_promotion(m))
305           moves[i].score = QueenValueMidgame;
306       else
307           moves[i].score = int(pos.midgame_value_of_piece_on(move_to(m)))
308                           -int(pos.type_of_piece_on(move_from(m)));
309   }
310 }
311
312
313 /// find_best_index() loops across the moves and returns index of
314 /// the highest scored one. There is also a second version that
315 /// lowers the priority of moves that attack the same square,
316 /// so that if the best move that attack a square fails the next
317 /// move picked attacks a different square if any, not the same one.
318
319 int MovePicker::find_best_index() {
320
321   assert(movesPicked < numOfMoves);
322
323   int bestIndex = movesPicked, bestScore = moves[movesPicked].score;
324
325   for (int i = movesPicked + 1; i < numOfMoves; i++)
326       if (moves[i].score > bestScore)
327       {
328           bestIndex = i;
329           bestScore = moves[i].score;
330       }
331   return bestIndex;
332 }
333
334 int MovePicker::find_best_index(Bitboard* squares, int values[]) {
335
336   assert(movesPicked < numOfMoves);
337
338   int hs;
339   Move m;
340   Square to;
341   int bestScore = -10000000, bestIndex = -1;
342
343   for (int i = movesPicked; i < numOfMoves; i++)
344   {
345       m = moves[i].move;
346       to = move_to(m);
347
348       if (!bit_is_set(*squares, to))
349       {
350           // Init at first use
351           set_bit(squares, to);
352           values[to] = 0;
353       }
354
355       hs = moves[i].score - values[to];
356       if (hs > bestScore)
357       {
358           bestIndex = i;
359           bestScore = hs;
360       }
361   }
362
363   if (bestIndex != -1)
364   {
365       // Raise value of the picked square, so next attack
366       // to the same square will get low priority.
367       to = move_to(moves[bestIndex].move);
368       values[to] += 0xB00;
369   }
370   return bestIndex;
371 }
372
373
374 /// MovePicker::pick_move_from_list() picks the move with the biggest score
375 /// from a list of generated moves (moves[] or badCaptures[], depending on
376 /// the current move generation phase).  It takes care not to return the
377 /// transposition table move if that has already been serched previously.
378
379 Move MovePicker::pick_move_from_list() {
380
381   int bestIndex;
382   Move move;
383
384   switch (PhaseTable[phaseIndex]) {
385
386   case PH_GOOD_CAPTURES:
387       assert(!pos.is_check());
388       assert(movesPicked >= 0);
389
390       while (movesPicked < numOfMoves)
391       {
392           bestIndex = find_best_index();
393           move = moves[bestIndex].move;
394           moves[bestIndex] = moves[movesPicked++];
395           if (   move != ttMove
396               && move != mateKiller
397               && pos.pl_move_is_legal(move, pinned))
398               return move;
399       }
400       break;
401
402   case PH_NONCAPTURES:
403       assert(!pos.is_check());
404       assert(movesPicked >= 0);
405
406       while (movesPicked < numOfMoves)
407       {
408           // If this is a PV node or we have only picked a few moves, scan
409           // the entire move list for the best move.  If many moves have already
410           // been searched and it is not a PV node, we are probably failing low
411           // anyway, so we just pick the first move from the list.
412           bestIndex = (pvNode || movesPicked < 12) ? find_best_index() : movesPicked;
413           move = moves[bestIndex].move;
414           moves[bestIndex] = moves[movesPicked++];
415           if (   move != ttMove
416               && move != mateKiller
417               && pos.pl_move_is_legal(move, pinned))
418               return move;
419       }
420       break;
421
422   case PH_EVASIONS:
423       assert(pos.is_check());
424       assert(movesPicked >= 0);
425
426       while (movesPicked < numOfMoves)
427       {
428           bestIndex = find_best_index();
429           move = moves[bestIndex].move;
430           moves[bestIndex] = moves[movesPicked++];
431           return move;
432     }
433     break;
434
435   case PH_BAD_CAPTURES:
436       assert(!pos.is_check());
437       assert(badCapturesPicked >= 0);
438       // It's probably a good idea to use SEE move ordering here, instead
439       // of just picking the first move.  FIXME
440       while (badCapturesPicked < numOfBadCaptures)
441       {
442           move = badCaptures[badCapturesPicked++].move;
443           if (   move != ttMove
444               && move != mateKiller
445               && pos.pl_move_is_legal(move, pinned))
446               return move;
447       }
448       break;
449
450   case PH_QCAPTURES:
451       assert(!pos.is_check());
452       assert(movesPicked >= 0);
453       while (movesPicked < numOfMoves)
454       {
455           bestIndex = (movesPicked < 4 ? find_best_index() : movesPicked);
456           move = moves[bestIndex].move;
457           moves[bestIndex] = moves[movesPicked++];
458           // Remember to change the line below if we decide to hash the qsearch!
459           // Maybe also postpone the legality check until after futility pruning?
460           if (/* move != ttMove && */ pos.pl_move_is_legal(move, pinned))
461               return move;
462       }
463       break;
464
465   case PH_QCHECKS:
466       assert(!pos.is_check());
467       assert(movesPicked >= 0);
468       // Perhaps we should do something better than just picking the first
469       // move here?  FIXME
470       while (movesPicked < numOfMoves)
471       {
472           move = moves[movesPicked++].move;
473           // Remember to change the line below if we decide to hash the qsearch!
474           if (/* move != ttMove && */ pos.pl_move_is_legal(move, pinned))
475               return move;
476       }
477       break;
478
479   default:
480       break;
481   }
482   return MOVE_NONE;
483 }
484
485
486 /// MovePicker::current_move_type() returns the type of the just
487 /// picked next move. It can be used in search to further differentiate
488 /// according to the current move type: capture, non capture, escape, etc.
489 MovePicker::MovegenPhase MovePicker::current_move_type() const {
490
491   return PhaseTable[phaseIndex];
492 }
493
494
495 /// MovePicker::init_phase_table() initializes the PhaseTable[],
496 /// MainSearchPhaseIndex, EvasionPhaseIndex, QsearchWithChecksPhaseIndex
497 /// QsearchNoCapturesPhaseIndex, QsearchWithoutChecksPhaseIndex and
498 /// NoMovesPhaseIndex variables. It is only called once during program
499 /// startup, and never again while the program is running.
500
501 void MovePicker::init_phase_table() {
502
503   int i = 0;
504
505   // Main search
506   MainSearchPhaseIndex = i - 1;
507   PhaseTable[i++] = PH_TT_MOVE;
508   PhaseTable[i++] = PH_MATE_KILLER;
509   PhaseTable[i++] = PH_GOOD_CAPTURES;
510   // PH_KILLER_1 and PH_KILLER_2 are not yet used.
511   // PhaseTable[i++] = PH_KILLER_1;
512   // PhaseTable[i++] = PH_KILLER_2;
513   PhaseTable[i++] = PH_NONCAPTURES;
514   PhaseTable[i++] = PH_BAD_CAPTURES;
515   PhaseTable[i++] = PH_STOP;
516
517   // Check evasions
518   EvasionsPhaseIndex = i - 1;
519   PhaseTable[i++] = PH_EVASIONS;
520   PhaseTable[i++] = PH_STOP;
521
522   // Quiescence search with checks
523   QsearchWithChecksPhaseIndex = i - 1;
524   PhaseTable[i++] = PH_QCAPTURES;
525   PhaseTable[i++] = PH_QCHECKS;
526   PhaseTable[i++] = PH_STOP;
527
528   // Quiescence search with checks only and no captures
529   QsearchNoCapturesPhaseIndex = i - 1;
530   PhaseTable[i++] = PH_QCHECKS;
531   PhaseTable[i++] = PH_STOP;
532
533   // Quiescence search without checks
534   QsearchWithoutChecksPhaseIndex = i - 1;
535   PhaseTable[i++] = PH_QCAPTURES;
536   PhaseTable[i++] = PH_STOP;
537
538   // Do not generate any move
539   NoMovesPhaseIndex = i - 1;
540   PhaseTable[i++] = PH_STOP;
541 }