2 Glaurung, a UCI chess playing engine.
3 Copyright (C) 2004-2008 Tord Romstad
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.
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.
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/>.
20 #if !defined(POSITION_H_INCLUDED)
21 #define POSITION_H_INCLUDED
23 // Disable a silly and noisy warning from MSVC compiler
26 // Forcing value to bool 'true' or 'false' (performance warning)
27 #pragma warning(disable: 4800)
\r
37 #include "direction.h"
49 /// FEN string for the initial position:
50 const std::string StartPosition =
51 "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
53 /// Maximum number of plies per game (220 should be enough, because the
54 /// maximum search depth is 100, and during position setup we reset the
55 /// move counter for every non-reversible move):
56 const int MaxGameLength = 220;
63 /// Castle rights, encoded as bit fields:
75 /// The UndoInfo struct stores information we need to restore a Position
76 /// object to its previous state when we retract a move. Whenever a move
77 /// is made on the board (by calling Position::do_move), an UndoInfo object
78 /// must be passed as a parameter. When the move is unmade (by calling
79 /// Position::undo_move), the same UndoInfo object must be passed again.
85 Key key, pawnKey, materialKey;
89 Value mgValue, egValue;
93 /// The position data structure. A position consists of the following data:
95 /// * For each piece type, a bitboard representing the squares occupied
96 /// by pieces of that type.
97 /// * For each color, a bitboard representing the squares occupiecd by
98 /// pieces of that color.
99 /// * A bitboard of all occupied squares.
100 /// * A bitboard of all checking pieces.
101 /// * A 64-entry array of pieces, indexed by the squares of the board.
102 /// * The current side to move.
103 /// * Information about the castling rights for both sides.
104 /// * The initial files of the kings and both pairs of rooks. This is
105 /// used to implement the Chess960 castling rules.
106 /// * The en passant square (which is SQ_NONE if no en passant capture is
108 /// * The squares of the kings for both sides.
109 /// * The last move played.
110 /// * Hash keys for the position itself, the current pawn structure, and
111 /// the current material situation.
112 /// * Hash keys for all previous positions in the game (for detecting
113 /// repetition draws.
114 /// * A counter for detecting 50 move rule draws.
118 friend class MaterialInfo;
123 Position(const Position &pos);
124 Position(const std::string &fen);
127 void from_fen(const std::string &fen);
128 const std::string to_fen() const;
132 void copy(const Position &pos);
133 void flipped_copy(const Position &pos);
135 // The piece on a given square
136 Piece piece_on(Square s) const;
137 PieceType type_of_piece_on(Square s) const;
138 Color color_of_piece_on(Square s) const;
139 bool square_is_empty(Square s) const;
140 bool square_is_occupied(Square s) const;
141 Value midgame_value_of_piece_on(Square s) const;
142 Value endgame_value_of_piece_on(Square s) const;
145 Color side_to_move() const;
147 // Bitboard representation of the position
148 Bitboard empty_squares() const;
149 Bitboard occupied_squares() const;
150 Bitboard pieces_of_color(Color c) const;
151 Bitboard pieces_of_type(PieceType pt) const;
152 Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
153 Bitboard pawns() const;
154 Bitboard knights() const;
155 Bitboard bishops() const;
156 Bitboard rooks() const;
157 Bitboard queens() const;
158 Bitboard kings() const;
159 Bitboard rooks_and_queens() const;
160 Bitboard bishops_and_queens() const;
161 Bitboard sliders() const;
162 Bitboard pawns(Color c) const;
163 Bitboard knights(Color c) const;
164 Bitboard bishops(Color c) const;
165 Bitboard rooks(Color c) const;
166 Bitboard queens(Color c) const;
167 Bitboard kings(Color c) const;
168 Bitboard rooks_and_queens(Color c) const;
169 Bitboard bishops_and_queens(Color c) const;
170 Bitboard sliders_of_color(Color c) const;
172 // Number of pieces of each color and type
173 int piece_count(Color c, PieceType pt) const;
174 int pawn_count(Color c) const;
175 int knight_count(Color c) const;
176 int bishop_count(Color c) const;
177 int rook_count(Color c) const;
178 int queen_count(Color c) const;
180 // The en passant square:
181 Square ep_square() const;
183 // Current king position for each color
184 Square king_square(Color c) const;
187 bool can_castle_kingside(Color c) const;
188 bool can_castle_queenside(Color c) const;
189 bool can_castle(Color c) const;
190 Square initial_kr_square(Color c) const;
191 Square initial_qr_square(Color c) const;
194 Bitboard sliding_attacks(Square s, Direction d) const;
195 Bitboard ray_attacks(Square s, SignedDirection d) const;
196 Bitboard pawn_attacks(Color c, Square s) const;
199 Bitboard piece_attacks(Square s) const;
201 // Bitboards for pinned pieces and discovered check candidates
202 Bitboard discovered_check_candidates(Color c) const;
203 Bitboard pinned_pieces(Color c) const;
206 Bitboard checkers() const;
209 Square piece_list(Color c, PieceType pt, int index) const;
211 // Attack information for a given square
212 bool square_is_attacked(Square s, Color c) const;
213 Bitboard attacks_to(Square s) const;
214 Bitboard attacks_to(Square s, Color c) const;
215 bool is_check() const;
216 bool piece_attacks_square(Square f, Square t) const;
217 bool white_pawn_attacks_square(Square f, Square t) const;
218 bool black_pawn_attacks_square(Square f, Square t) const;
219 bool knight_attacks_square(Square f, Square t) const;
220 bool bishop_attacks_square(Square f, Square t) const;
221 bool rook_attacks_square(Square f, Square t) const;
222 bool queen_attacks_square(Square f, Square t) const;
223 bool king_attacks_square(Square f, Square t) const;
225 // Properties of moves
226 bool move_is_legal(Move m) const;
227 bool move_is_legal(Move m, Bitboard pinned) const;
228 bool move_is_check(Move m) const;
229 bool move_is_check(Move m, Bitboard dcCandidates) const;
230 bool move_is_capture(Move m) const;
231 bool move_is_deep_pawn_push(Move m) const;
232 bool move_is_pawn_push_to_7th(Move m) const;
233 bool move_is_passed_pawn_push(Move m) const;
234 bool move_was_passed_pawn_push(Move m) const;
235 bool move_attacks_square(Move m, Square s) const;
237 // Information about pawns
238 bool pawn_is_passed(Color c, Square s) const;
239 bool pawn_is_isolated(Color c, Square s) const;
240 bool pawn_is_doubled(Color c, Square s) const;
242 // Open and half-open files
243 bool file_is_open(File f) const;
244 bool file_is_half_open(Color c, File f) const;
247 bool square_is_weak(Square s, Color c) const;
249 // Doing and undoing moves
250 void backup(UndoInfo &u) const;
251 void restore(const UndoInfo &u);
252 void do_move(Move m, UndoInfo &u);
253 void do_move(Move m, UndoInfo &u, Bitboard dcCandidates);
254 void undo_move(Move m, const UndoInfo &u);
255 void do_null_move(UndoInfo &u);
256 void undo_null_move(const UndoInfo &u);
258 // Static exchange evaluation
259 int see(Square from, Square to) const;
260 int see(Move m) const;
262 // Accessing hash keys
264 Key get_pawn_key() const;
265 Key get_material_key() const;
267 // Incremental evaluation
268 Value mg_value() const;
269 Value eg_value() const;
270 Value non_pawn_material(Color c) const;
271 Phase game_phase() const;
272 Value mg_pst_delta(Move m) const;
274 // Game termination checks
276 bool is_draw() const;
278 // Check if one side threatens a mate in one
279 bool has_mate_threat(Color c);
281 // Number of plies since the last non-reversible move
282 int rule_50_counter() const;
284 // Other properties of the position
285 bool opposite_colored_bishops() const;
286 bool has_pawn_on_7th(Color c) const;
288 // Reset the gamePly variable to 0
289 void reset_game_ply();
291 // Position consistency check, for debugging
292 bool is_ok(int* failedStep = NULL) const;
294 // Static member functions:
295 static void init_zobrist();
296 static void init_piece_square_tables();
299 // Initialization helper functions (used while setting up a position)
301 void put_piece(Piece p, Square s);
302 void allow_oo(Color c);
303 void allow_ooo(Color c);
305 // Helper functions for doing and undoing moves
306 void do_castle_move(Move m);
307 void do_promotion_move(Move m, UndoInfo &u);
308 void do_ep_move(Move m);
309 void undo_castle_move(Move m);
310 void undo_promotion_move(Move m, const UndoInfo &u);
311 void undo_ep_move(Move m);
312 void find_checkers();
314 // Computing hash keys from scratch (for initialization and debugging)
315 Key compute_key() const;
316 Key compute_pawn_key() const;
317 Key compute_material_key() const;
319 // Computing incremental evaluation scores and material counts
320 Value mg_pst(Color c, PieceType pt, Square s) const;
321 Value eg_pst(Color c, PieceType pt, Square s) const;
322 Value compute_mg_value() const;
323 Value compute_eg_value() const;
324 Value compute_non_pawn_material(Color c) const;
327 Bitboard byColorBB[2], byTypeBB[8];
334 int pieceCount[2][8]; // [color][pieceType]
337 Square pieceList[2][8][16]; // [color][pieceType][index]
343 File initialKFile, initialKRFile, initialQRFile;
345 Square kingSquare[2];
347 Key key, pawnKey, materialKey, history[MaxGameLength];
349 Value mgValue, egValue;
353 static int castleRightsMask[64];
354 static Key zobrist[2][8][64];
355 static Key zobEp[64];
356 static Key zobCastle[16];
357 static Key zobMaterial[2][8][16];
358 static Key zobSideToMove;
359 static Value MgPieceSquareTable[16][64];
360 static Value EgPieceSquareTable[16][64];
365 //// Inline functions
368 inline Piece Position::piece_on(Square s) const {
372 inline Color Position::color_of_piece_on(Square s) const {
373 return color_of_piece(piece_on(s));
376 inline PieceType Position::type_of_piece_on(Square s) const {
377 return type_of_piece(piece_on(s));
380 inline bool Position::square_is_empty(Square s) const {
381 return piece_on(s) == EMPTY;
384 inline bool Position::square_is_occupied(Square s) const {
385 return !square_is_empty(s);
388 inline Value Position::midgame_value_of_piece_on(Square s) const {
389 return piece_value_midgame(piece_on(s));
392 inline Value Position::endgame_value_of_piece_on(Square s) const {
393 return piece_value_endgame(piece_on(s));
396 inline Color Position::side_to_move() const {
400 inline Bitboard Position::occupied_squares() const {
404 inline Bitboard Position::empty_squares() const {
405 return ~(occupied_squares());
408 inline Bitboard Position::pieces_of_color(Color c) const {
412 inline Bitboard Position::pieces_of_type(PieceType pt) const {
416 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
417 return pieces_of_color(c) & pieces_of_type(pt);
420 inline Bitboard Position::pawns() const {
421 return pieces_of_type(PAWN);
424 inline Bitboard Position::knights() const {
425 return pieces_of_type(KNIGHT);
428 inline Bitboard Position::bishops() const {
429 return pieces_of_type(BISHOP);
432 inline Bitboard Position::rooks() const {
433 return pieces_of_type(ROOK);
436 inline Bitboard Position::queens() const {
437 return pieces_of_type(QUEEN);
440 inline Bitboard Position::kings() const {
441 return pieces_of_type(KING);
444 inline Bitboard Position::rooks_and_queens() const {
445 return rooks() | queens();
448 inline Bitboard Position::bishops_and_queens() const {
449 return bishops() | queens();
452 inline Bitboard Position::sliders() const {
453 return bishops() | queens() | rooks();
456 inline Bitboard Position::pawns(Color c) const {
457 return pieces_of_color_and_type(c, PAWN);
460 inline Bitboard Position::knights(Color c) const {
461 return pieces_of_color_and_type(c, KNIGHT);
464 inline Bitboard Position::bishops(Color c) const {
465 return pieces_of_color_and_type(c, BISHOP);
468 inline Bitboard Position::rooks(Color c) const {
469 return pieces_of_color_and_type(c, ROOK);
472 inline Bitboard Position::queens(Color c) const {
473 return pieces_of_color_and_type(c, QUEEN);
476 inline Bitboard Position::kings(Color c) const {
477 return pieces_of_color_and_type(c, KING);
480 inline Bitboard Position::rooks_and_queens(Color c) const {
481 return rooks_and_queens() & pieces_of_color(c);
484 inline Bitboard Position::bishops_and_queens(Color c) const {
485 return bishops_and_queens() & pieces_of_color(c);
488 inline Bitboard Position::sliders_of_color(Color c) const {
489 return sliders() & pieces_of_color(c);
492 inline int Position::piece_count(Color c, PieceType pt) const {
493 return pieceCount[c][pt];
496 inline int Position::pawn_count(Color c) const {
497 return piece_count(c, PAWN);
500 inline int Position::knight_count(Color c) const {
501 return piece_count(c, KNIGHT);
504 inline int Position::bishop_count(Color c) const {
505 return piece_count(c, BISHOP);
508 inline int Position::rook_count(Color c) const {
509 return piece_count(c, ROOK);
512 inline int Position::queen_count(Color c) const {
513 return piece_count(c, QUEEN);
516 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
517 return pieceList[c][pt][index];
520 inline Square Position::ep_square() const {
524 inline Square Position::king_square(Color c) const {
525 return kingSquare[c];
528 inline bool Position::can_castle_kingside(Color side) const {
529 return castleRights & (1+int(side));
532 inline bool Position::can_castle_queenside(Color side) const {
533 return castleRights & (4+4*int(side));
536 inline bool Position::can_castle(Color side) const {
537 return can_castle_kingside(side) || can_castle_queenside(side);
540 inline Square Position::initial_kr_square(Color c) const {
541 return relative_square(c, make_square(initialKRFile, RANK_1));
544 inline Square Position::initial_qr_square(Color c) const {
545 return relative_square(c, make_square(initialQRFile, RANK_1));
548 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
549 return StepAttackBB[pawn_of_color(c)][s];
553 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
554 return StepAttackBB[KNIGHT][s];
558 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
559 return bishop_attacks_bb(s, occupied_squares());
563 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
564 return rook_attacks_bb(s, occupied_squares());
568 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
569 return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
573 inline Bitboard Position::piece_attacks<KING>(Square s) const {
574 return StepAttackBB[KING][s];
577 inline Bitboard Position::checkers() const {
581 inline bool Position::is_check() const {
582 return checkers() != EmptyBoardBB;
585 inline bool Position::white_pawn_attacks_square(Square f, Square t) const {
586 return bit_is_set(pawn_attacks(WHITE, f), t);
589 inline bool Position::black_pawn_attacks_square(Square f, Square t) const {
590 return bit_is_set(pawn_attacks(BLACK, f), t);
593 inline bool Position::knight_attacks_square(Square f, Square t) const {
594 return bit_is_set(piece_attacks<KNIGHT>(f), t);
597 inline bool Position::bishop_attacks_square(Square f, Square t) const {
598 return bit_is_set(piece_attacks<BISHOP>(f), t);
601 inline bool Position::rook_attacks_square(Square f, Square t) const {
602 return bit_is_set(piece_attacks<ROOK>(f), t);
605 inline bool Position::queen_attacks_square(Square f, Square t) const {
606 return bit_is_set(piece_attacks<QUEEN>(f), t);
609 inline bool Position::king_attacks_square(Square f, Square t) const {
610 return bit_is_set(piece_attacks<KING>(f), t);
613 inline bool Position::pawn_is_passed(Color c, Square s) const {
614 return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
617 inline bool Position::pawn_is_isolated(Color c, Square s) const {
618 return !(pawns(c) & neighboring_files_bb(s));
621 inline bool Position::pawn_is_doubled(Color c, Square s) const {
622 return pawns(c) & squares_behind(c, s);
625 inline bool Position::file_is_open(File f) const {
626 return !(pawns() & file_bb(f));
629 inline bool Position::file_is_half_open(Color c, File f) const {
630 return !(pawns(c) & file_bb(f));
633 inline bool Position::square_is_weak(Square s, Color c) const {
634 return !(pawns(c) & outpost_mask(opposite_color(c), s));
637 inline Key Position::get_key() const {
641 inline Key Position::get_pawn_key() const {
645 inline Key Position::get_material_key() const {
649 inline Value Position::mg_pst(Color c, PieceType pt, Square s) const {
650 return MgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
653 inline Value Position::mg_pst_delta(Move m) const {
654 return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
655 -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
658 inline Value Position::eg_pst(Color c, PieceType pt, Square s) const {
659 return EgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
662 inline Value Position::mg_value() const {
666 inline Value Position::eg_value() const {
670 inline Value Position::non_pawn_material(Color c) const {
671 return npMaterial[c];
674 inline Phase Position::game_phase() const {
676 // The purpose of the Value(325) terms below is to make sure the difference
677 // between MidgameLimit and EndgameLimit is a power of 2, which should make
678 // the division at the end of the function a bit faster.
679 static const Value MidgameLimit = 2 * QueenValueMidgame
680 + 2 * RookValueMidgame
681 + 6 * BishopValueMidgame
684 static const Value EndgameLimit = 4 * RookValueMidgame - Value(325);
686 Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
688 if (npm >= MidgameLimit)
689 return PHASE_MIDGAME;
690 else if(npm <= EndgameLimit)
691 return PHASE_ENDGAME;
693 return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
696 inline bool Position::move_is_deep_pawn_push(Move m) const {
698 Color c = side_to_move();
699 return piece_on(move_from(m)) == pawn_of_color(c)
700 && relative_rank(c, move_to(m)) > RANK_4;
703 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
705 Color c = side_to_move();
706 return piece_on(move_from(m)) == pawn_of_color(c)
707 && relative_rank(c, move_to(m)) == RANK_7;
710 inline bool Position::move_is_passed_pawn_push(Move m) const {
712 Color c = side_to_move();
713 return piece_on(move_from(m)) == pawn_of_color(c)
714 && pawn_is_passed(c, move_to(m));
717 inline bool Position::move_was_passed_pawn_push(Move m) const {
719 Color c = opposite_color(side_to_move());
720 return piece_on(move_to(m)) == pawn_of_color(c)
721 && pawn_is_passed(c, move_to(m));
724 inline int Position::rule_50_counter() const {
729 inline bool Position::opposite_colored_bishops() const {
731 return bishop_count(WHITE) == 1
732 && bishop_count(BLACK) == 1
733 && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
736 inline bool Position::has_pawn_on_7th(Color c) const {
738 return pawns(c) & relative_rank_bb(c, RANK_7);
742 #endif // !defined(POSITION_H_INCLUDED)