Introduce captured_piece()
[stockfish] / src / position.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(POSITION_H_INCLUDED)
22 #define POSITION_H_INCLUDED
23
24 // Disable some silly and noisy warning from MSVC compiler
25 #if defined(_MSC_VER)
26
27 // Forcing value to bool 'true' or 'false' (performance warning)
28 #pragma warning(disable: 4800)
29
30 // Conditional expression is constant
31 #pragma warning(disable: 4127)
32
33
34 #endif
35
36 ////
37 //// Includes
38 ////
39
40 #include "bitboard.h"
41 #include "color.h"
42 #include "direction.h"
43 #include "move.h"
44 #include "piece.h"
45 #include "square.h"
46 #include "value.h"
47
48
49 ////
50 //// Constants
51 ////
52
53 /// FEN string for the initial position
54 const std::string StartPosition = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
55
56 /// Maximum number of plies per game (220 should be enough, because the
57 /// maximum search depth is 100, and during position setup we reset the
58 /// move counter for every non-reversible move).
59 const int MaxGameLength = 220;
60
61
62 ////
63 //// Types
64 ////
65
66 /// struct checkInfo is initialized at c'tor time and keeps
67 /// info used to detect if a move gives check.
68
69 struct CheckInfo {
70
71     CheckInfo(const Position&);
72
73     Square ksq;
74     Bitboard dcCandidates;
75     Bitboard checkSq[8];
76 };
77
78 /// Castle rights, encoded as bit fields
79
80 enum CastleRights {
81   NO_CASTLES  = 0,
82   WHITE_OO    = 1,
83   BLACK_OO    = 2,
84   WHITE_OOO   = 4,
85   BLACK_OOO   = 8,
86   ALL_CASTLES = 15
87 };
88
89 /// Game phase
90 enum Phase {
91   PHASE_ENDGAME = 0,
92   PHASE_MIDGAME = 128
93 };
94
95
96 /// The StateInfo struct stores information we need to restore a Position
97 /// object to its previous state when we retract a move. Whenever a move
98 /// is made on the board (by calling Position::do_move), an StateInfo object
99 /// must be passed as a parameter.
100
101 struct StateInfo {
102   Key pawnKey, materialKey;
103   int castleRights, rule50, pliesFromNull;
104   Square epSquare;
105   Score value;
106   Value npMaterial[2];
107
108   Key key;
109   PieceType capture;
110   Bitboard checkersBB;
111   StateInfo* previous;
112 };
113
114
115 /// The position data structure. A position consists of the following data:
116 ///
117 ///    * For each piece type, a bitboard representing the squares occupied
118 ///      by pieces of that type.
119 ///    * For each color, a bitboard representing the squares occupied by
120 ///      pieces of that color.
121 ///    * A bitboard of all occupied squares.
122 ///    * A bitboard of all checking pieces.
123 ///    * A 64-entry array of pieces, indexed by the squares of the board.
124 ///    * The current side to move.
125 ///    * Information about the castling rights for both sides.
126 ///    * The initial files of the kings and both pairs of rooks. This is
127 ///      used to implement the Chess960 castling rules.
128 ///    * The en passant square (which is SQ_NONE if no en passant capture is
129 ///      possible).
130 ///    * The squares of the kings for both sides.
131 ///    * Hash keys for the position itself, the current pawn structure, and
132 ///      the current material situation.
133 ///    * Hash keys for all previous positions in the game for detecting
134 ///      repetition draws.
135 ///    * A counter for detecting 50 move rule draws.
136
137 class Position {
138
139   friend class MaterialInfo;
140   friend class EndgameFunctions;
141
142 public:
143   enum GamePhase {
144       MidGame,
145       EndGame
146   };
147
148   // Constructors
149   Position();
150   explicit Position(const Position& pos);
151   explicit Position(const std::string& fen);
152
153   // Text input/output
154   void from_fen(const std::string& fen);
155   const std::string to_fen() const;
156   void print(Move m = MOVE_NONE) const;
157
158   // Copying
159   void fast_copy(const Position& pos);
160   void flipped_copy(const Position& pos);
161
162   // The piece on a given square
163   Piece piece_on(Square s) const;
164   PieceType type_of_piece_on(Square s) const;
165   Color color_of_piece_on(Square s) const;
166   bool square_is_empty(Square s) const;
167   bool square_is_occupied(Square s) const;
168   Value midgame_value_of_piece_on(Square s) const;
169   Value endgame_value_of_piece_on(Square s) const;
170
171   // Side to move
172   Color side_to_move() const;
173
174   // Bitboard representation of the position
175   Bitboard empty_squares() const;
176   Bitboard occupied_squares() const;
177   Bitboard pieces_of_color(Color c) const;
178   Bitboard pieces(PieceType pt) const;
179   Bitboard pieces(PieceType pt, Color c) const;
180   Bitboard pieces(PieceType pt1, PieceType pt2) const;
181   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
182
183   // Number of pieces of each color and type
184   int piece_count(Color c, PieceType pt) const;
185
186   // The en passant square
187   Square ep_square() const;
188
189   // Current king position for each color
190   Square king_square(Color c) const;
191
192   // Castling rights
193   bool can_castle_kingside(Color c) const;
194   bool can_castle_queenside(Color c) const;
195   bool can_castle(Color c) const;
196   Square initial_kr_square(Color c) const;
197   Square initial_qr_square(Color c) const;
198
199   // Bitboards for pinned pieces and discovered check candidates
200   Bitboard discovered_check_candidates(Color c) const;
201   Bitboard pinned_pieces(Color c) const;
202
203   // Checking pieces and under check information
204   Bitboard checkers() const;
205   bool is_check() const;
206
207   // Piece lists
208   Square piece_list(Color c, PieceType pt, int index) const;
209   const Square* piece_list_begin(Color c, PieceType pt) const;
210
211   // Information about attacks to or from a given square
212   Bitboard attackers_to(Square s) const;
213   Bitboard attacks_from(Piece p, Square s) const;
214   template<PieceType> Bitboard attacks_from(Square s) const;
215   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
216
217   // Properties of moves
218   bool pl_move_is_legal(Move m, Bitboard pinned) const;
219   bool pl_move_is_evasion(Move m, Bitboard pinned) const;
220   bool move_is_check(Move m) const;
221   bool move_is_check(Move m, const CheckInfo& ci) const;
222   bool move_is_capture(Move m) const;
223   bool move_is_capture_or_promotion(Move m) const;
224   bool move_is_passed_pawn_push(Move m) const;
225   bool move_attacks_square(Move m, Square s) const;
226
227   // Piece captured with previous moves
228   PieceType captured_piece() const;
229
230   // Information about pawns
231   bool pawn_is_passed(Color c, Square s) const;
232   static bool pawn_is_passed(Bitboard theirPawns, Color c, Square s);
233   static bool pawn_is_isolated(Bitboard ourPawns, Square s);
234   static bool pawn_is_doubled(Bitboard ourPawns, Color c, Square s);
235
236   // Weak squares
237   bool square_is_weak(Square s, Color c) const;
238
239   // Doing and undoing moves
240   void detach();
241   void do_move(Move m, StateInfo& st);
242   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
243   void undo_move(Move m);
244   void do_null_move(StateInfo& st);
245   void undo_null_move();
246
247   // Static exchange evaluation
248   int see(Square from, Square to) const;
249   int see(Move m) const;
250   int see(Square to) const;
251   int see_sign(Move m) const;
252
253   // Accessing hash keys
254   Key get_key() const;
255   Key get_exclusion_key() const;
256   Key get_pawn_key() const;
257   Key get_material_key() const;
258
259   // Incremental evaluation
260   Score value() const;
261   Value non_pawn_material(Color c) const;
262   Score pst_delta(Piece piece, Square from, Square to) const;
263
264   // Game termination checks
265   bool is_mate() const;
266   bool is_draw() const;
267
268   // Check if one side threatens a mate in one
269   bool has_mate_threat(Color c);
270
271   // Number of plies since the last non-reversible move
272   int rule_50_counter() const;
273
274   // Other properties of the position
275   bool opposite_colored_bishops() const;
276   bool has_pawn_on_7th(Color c) const;
277
278   // Reset the gamePly variable to 0
279   void reset_game_ply();
280
281   // Position consistency check, for debugging
282   bool is_ok(int* failedStep = NULL) const;
283
284   // Static member functions
285   static void init_zobrist();
286   static void init_piece_square_tables();
287
288 private:
289
290   // Initialization helper functions (used while setting up a position)
291   void clear();
292   void put_piece(Piece p, Square s);
293   void allow_oo(Color c);
294   void allow_ooo(Color c);
295
296   // Helper functions for doing and undoing moves
297   void do_capture_move(Bitboard& key, PieceType capture, Color them, Square to, bool ep);
298   void do_castle_move(Move m);
299   void undo_castle_move(Move m);
300   void find_checkers();
301
302   template<bool FindPinned>
303   Bitboard hidden_checkers(Color c) const;
304
305   // Computing hash keys from scratch (for initialization and debugging)
306   Key compute_key() const;
307   Key compute_pawn_key() const;
308   Key compute_material_key() const;
309
310   // Computing incremental evaluation scores and material counts
311   Score pst(Color c, PieceType pt, Square s) const;
312   Score compute_value() const;
313   Value compute_non_pawn_material(Color c) const;
314
315   // Board
316   Piece board[64];
317
318   // Bitboards
319   Bitboard byTypeBB[8], byColorBB[2];
320
321   // Piece counts
322   int pieceCount[2][8]; // [color][pieceType]
323
324   // Piece lists
325   Square pieceList[2][8][16]; // [color][pieceType][index]
326   int index[64]; // [square]
327
328   // Other info
329   Color sideToMove;
330   int gamePly;
331   Key history[MaxGameLength];
332   File initialKFile, initialKRFile, initialQRFile;
333   StateInfo startState;
334   StateInfo* st;
335
336   // Static variables
337   static int castleRightsMask[64];
338   static Key zobrist[2][8][64];
339   static Key zobEp[64];
340   static Key zobCastle[16];
341   static Key zobMaterial[2][8][16];
342   static Key zobSideToMove;
343   static Score PieceSquareTable[16][64];
344   static Key zobExclusion;
345 };
346
347
348 ////
349 //// Inline functions
350 ////
351
352 inline Piece Position::piece_on(Square s) const {
353   return board[s];
354 }
355
356 inline Color Position::color_of_piece_on(Square s) const {
357   return color_of_piece(piece_on(s));
358 }
359
360 inline PieceType Position::type_of_piece_on(Square s) const {
361   return type_of_piece(piece_on(s));
362 }
363
364 inline bool Position::square_is_empty(Square s) const {
365   return piece_on(s) == EMPTY;
366 }
367
368 inline bool Position::square_is_occupied(Square s) const {
369   return !square_is_empty(s);
370 }
371
372 inline Value Position::midgame_value_of_piece_on(Square s) const {
373   return piece_value_midgame(piece_on(s));
374 }
375
376 inline Value Position::endgame_value_of_piece_on(Square s) const {
377   return piece_value_endgame(piece_on(s));
378 }
379
380 inline Color Position::side_to_move() const {
381   return sideToMove;
382 }
383
384 inline Bitboard Position::occupied_squares() const {
385   return byTypeBB[0];
386 }
387
388 inline Bitboard Position::empty_squares() const {
389   return ~(occupied_squares());
390 }
391
392 inline Bitboard Position::pieces_of_color(Color c) const {
393   return byColorBB[c];
394 }
395
396 inline Bitboard Position::pieces(PieceType pt) const {
397   return byTypeBB[pt];
398 }
399
400 inline Bitboard Position::pieces(PieceType pt, Color c) const {
401   return byTypeBB[pt] & byColorBB[c];
402 }
403
404 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
405   return byTypeBB[pt1] | byTypeBB[pt2];
406 }
407
408 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
409   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
410 }
411
412 inline int Position::piece_count(Color c, PieceType pt) const {
413   return pieceCount[c][pt];
414 }
415
416 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
417   return pieceList[c][pt][index];
418 }
419
420 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
421   return pieceList[c][pt];
422 }
423
424 inline Square Position::ep_square() const {
425   return st->epSquare;
426 }
427
428 inline Square Position::king_square(Color c) const {
429   return pieceList[c][KING][0];
430 }
431
432 inline bool Position::can_castle_kingside(Color side) const {
433   return st->castleRights & (1+int(side));
434 }
435
436 inline bool Position::can_castle_queenside(Color side) const {
437   return st->castleRights & (4+4*int(side));
438 }
439
440 inline bool Position::can_castle(Color side) const {
441   return can_castle_kingside(side) || can_castle_queenside(side);
442 }
443
444 inline Square Position::initial_kr_square(Color c) const {
445   return relative_square(c, make_square(initialKRFile, RANK_1));
446 }
447
448 inline Square Position::initial_qr_square(Color c) const {
449   return relative_square(c, make_square(initialQRFile, RANK_1));
450 }
451
452 template<>
453 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
454   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
455 }
456
457 template<PieceType Piece> // Knight and King and white pawns
458 inline Bitboard Position::attacks_from(Square s) const {
459   return StepAttackBB[Piece][s];
460 }
461
462 template<>
463 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
464   return bishop_attacks_bb(s, occupied_squares());
465 }
466
467 template<>
468 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
469   return rook_attacks_bb(s, occupied_squares());
470 }
471
472 template<>
473 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
474   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
475 }
476
477 inline Bitboard Position::checkers() const {
478   return st->checkersBB;
479 }
480
481 inline bool Position::is_check() const {
482   return st->checkersBB != EmptyBoardBB;
483 }
484
485 inline bool Position::pawn_is_passed(Color c, Square s) const {
486   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
487 }
488
489 inline bool Position::pawn_is_passed(Bitboard theirPawns, Color c, Square s) {
490   return !(theirPawns & passed_pawn_mask(c, s));
491 }
492
493 inline bool Position::pawn_is_isolated(Bitboard ourPawns, Square s) {
494   return !(ourPawns & neighboring_files_bb(s));
495 }
496
497 inline bool Position::pawn_is_doubled(Bitboard ourPawns, Color c, Square s) {
498   return ourPawns & squares_behind(c, s);
499 }
500
501 inline bool Position::square_is_weak(Square s, Color c) const {
502   return !(pieces(PAWN, c) & outpost_mask(opposite_color(c), s));
503 }
504
505 inline Key Position::get_key() const {
506   return st->key;
507 }
508
509 inline Key Position::get_exclusion_key() const {
510   return st->key ^ zobExclusion;
511 }
512
513 inline Key Position::get_pawn_key() const {
514   return st->pawnKey;
515 }
516
517 inline Key Position::get_material_key() const {
518   return st->materialKey;
519 }
520
521 inline Score Position::pst(Color c, PieceType pt, Square s) const {
522   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
523 }
524
525 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
526   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
527 }
528
529 inline Score Position::value() const {
530   return st->value;
531 }
532
533 inline Value Position::non_pawn_material(Color c) const {
534   return st->npMaterial[c];
535 }
536
537 inline bool Position::move_is_passed_pawn_push(Move m) const {
538
539   Color c = side_to_move();
540   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
541         && pawn_is_passed(c, move_to(m));
542 }
543
544 inline int Position::rule_50_counter() const {
545
546   return st->rule50;
547 }
548
549 inline bool Position::opposite_colored_bishops() const {
550
551   return   piece_count(WHITE, BISHOP) == 1
552         && piece_count(BLACK, BISHOP) == 1
553         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
554 }
555
556 inline bool Position::has_pawn_on_7th(Color c) const {
557
558   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
559 }
560
561 inline bool Position::move_is_capture(Move m) const {
562
563   // Move must not be MOVE_NONE !
564   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
565 }
566
567 inline bool Position::move_is_capture_or_promotion(Move m) const {
568
569   // Move must not be MOVE_NONE !
570   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
571 }
572
573 inline PieceType Position::captured_piece() const {
574   return st->capture;
575 }
576
577 #endif // !defined(POSITION_H_INCLUDED)