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