bcd5eb14e1b57cb77d92d81cd3bd5a8640920bb8
[stockfish] / src / movepick.h
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   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 #if !defined MOVEPICK_H_INCLUDED
22 #define MOVEPICK_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "depth.h"
29 #include "history.h"
30 #include "lock.h"
31 #include "position.h"
32
33
34 ////
35 //// Types
36 ////
37
38 struct EvalInfo;
39 struct SearchStack;
40
41 /// MovePicker is a class which is used to pick one legal move at a time from
42 /// the current position. It is initialized with a Position object and a few
43 /// moves we have reason to believe are good. The most important method is
44 /// MovePicker::pick_next_move(), which returns a new legal move each time it
45 /// is called, until there are no legal moves left, when MOVE_NONE is returned.
46 /// In order to improve the efficiency of the alpha beta algorithm, MovePicker
47 /// attempts to return the moves which are most likely to be strongest first.
48
49 class MovePicker {
50
51   MovePicker& operator=(const MovePicker&); // silence a warning under MSVC
52
53 public:
54
55   enum MovegenPhase {
56     PH_TT_MOVE,        // Transposition table move
57     PH_MATE_KILLER,    // Mate killer from the current ply
58     PH_GOOD_CAPTURES,  // Queen promotions and captures with SEE values >= 0
59     PH_KILLERS,        // Killer moves from the current ply
60     PH_NONCAPTURES,    // Non-captures and underpromotions
61     PH_BAD_CAPTURES,   // Queen promotions and captures with SEE values < 0
62     PH_EVASIONS,       // Check evasions
63     PH_QCAPTURES,      // Captures in quiescence search
64     PH_QCHECKS,        // Non-capture checks in quiescence search
65     PH_STOP
66   };
67
68   MovePicker(const Position& p, Move ttm, Depth d, const History& h, SearchStack* ss = NULL);
69   Move get_next_move();
70   Move get_next_move(Lock& lock);
71   int number_of_moves() const;
72   Bitboard discovered_check_candidates() const;
73
74   static void init_phase_table();
75
76 private:
77   void score_captures();
78   void score_noncaptures();
79   void score_evasions();
80   void score_qcaptures();
81   Move pick_move_from_list();
82
83   const Position& pos;
84   const History& H;
85   Move ttMove, mateKiller, killer1, killer2;
86   Bitboard pinned, dc;
87   MoveStack moves[256], badCaptures[64];
88   int phaseIndex;
89   int numOfMoves, numOfBadCaptures;
90   int movesPicked;
91   bool checkKillers, checkLegal;
92   bool finished;
93 };
94
95
96 ////
97 //// Inline functions
98 ////
99
100 /// MovePicker::number_of_moves() simply returns the numOfMoves member
101 /// variable. It is intended to be used in positions where the side to move
102 /// is in check, for detecting checkmates or situations where there is only
103 /// a single reply to check.
104
105 inline int MovePicker::number_of_moves() const {
106   return numOfMoves;
107 }
108
109 /// MovePicker::discovered_check_candidates() returns a bitboard containing
110 /// all pieces which can possibly give discovered check. This bitboard is
111 /// computed by the constructor function.
112
113 inline Bitboard MovePicker::discovered_check_candidates() const {
114   return dc;
115 }
116
117 #endif // !defined(MOVEPICK_H_INCLUDED)