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