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