Cache pinned and discovery check bitboards
[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 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 a 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 #endif
31
32 ////
33 //// Includes
34 ////
35
36 #include "bitboard.h"
37 #include "color.h"
38 #include "direction.h"
39 #include "move.h"
40 #include "piece.h"
41 #include "phase.h"
42 #include "square.h"
43 #include "value.h"
44
45
46 ////
47 //// Constants
48 ////
49
50 /// FEN string for the initial position:
51 const std::string StartPosition =
52   "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
53
54 /// Maximum number of plies per game (220 should be enough, because the
55 /// maximum search depth is 100, and during position setup we reset the
56 /// move counter for every non-reversible move):
57 const int MaxGameLength = 220;
58
59
60 ////
61 //// Types
62 ////
63
64 /// Castle rights, encoded as bit fields:
65
66 enum CastleRights {
67   NO_CASTLES = 0,
68   WHITE_OO = 1,
69   BLACK_OO = 2,
70   WHITE_OOO = 4,
71   BLACK_OOO = 8,
72   ALL_CASTLES = 15
73 };
74
75
76 /// The UndoInfo struct stores information we need to restore a Position
77 /// object to its previous state when we retract a move.  Whenever a move
78 /// is made on the board (by calling Position::do_move), an UndoInfo object
79 /// must be passed as a parameter.  When the move is unmade (by calling
80 /// Position::undo_move), the same UndoInfo object must be passed again.
81
82 struct UndoInfo {
83   int castleRights;
84   Square epSquare;
85   Bitboard checkersBB, pinners[2], pinned[2], dcCandidates[2];
86   Key key, pawnKey, materialKey;
87   int rule50;
88   Move lastMove;
89   Value mgValue, egValue;
90   PieceType capture;
91 };
92
93
94 /// The position data structure.  A position consists of the following data:
95 ///
96 ///    * For each piece type, a bitboard representing the squares occupied
97 ///      by pieces of that type.
98 ///    * For each color, a bitboard representing the squares occupiecd by
99 ///      pieces of that color.
100 ///    * A bitboard of all occupied squares.
101 ///    * A bitboard of all checking pieces.
102 ///    * A 64-entry array of pieces, indexed by the squares of the board.
103 ///    * The current side to move.
104 ///    * Information about the castling rights for both sides.
105 ///    * The initial files of the kings and both pairs of rooks.  This is
106 ///      used to implement the Chess960 castling rules.
107 ///    * The en passant square (which is SQ_NONE if no en passant capture is
108 ///      possible).
109 ///    * The squares of the kings for both sides.
110 ///    * The last move played.
111 ///    * Hash keys for the position itself, the current pawn structure, and
112 ///      the current material situation.
113 ///    * Hash keys for all previous positions in the game (for detecting
114 ///      repetition draws.
115 ///    * A counter for detecting 50 move rule draws.
116
117 class Position {
118
119   friend class MaterialInfo;
120   friend class EndgameFunctions;
121
122 public:
123   // Constructors
124   Position() {};
125   Position(const Position& pos);
126   Position(const std::string& fen);
127
128   // Text input/output
129   void from_fen(const std::string& fen);
130   const std::string to_fen() const;
131   void print(Move m = MOVE_NONE) const;
132
133   // Copying
134   void copy(const Position &pos);
135   void flipped_copy(const Position &pos);
136
137   // The piece on a given square
138   Piece piece_on(Square s) const;
139   PieceType type_of_piece_on(Square s) const;
140   Color color_of_piece_on(Square s) const;
141   bool square_is_empty(Square s) const;
142   bool square_is_occupied(Square s) const;
143   Value midgame_value_of_piece_on(Square s) const;
144   Value endgame_value_of_piece_on(Square s) const;
145
146   // Side to move
147   Color side_to_move() const;
148
149   // Bitboard representation of the position
150   Bitboard empty_squares() const;
151   Bitboard occupied_squares() const;
152   Bitboard pieces_of_color(Color c) const;
153   Bitboard pieces_of_type(PieceType pt) const;
154   Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
155   Bitboard pawns() const;
156   Bitboard knights() const;
157   Bitboard bishops() const;
158   Bitboard rooks() const;
159   Bitboard queens() const;
160   Bitboard kings() const;
161   Bitboard rooks_and_queens() const;
162   Bitboard bishops_and_queens() const;
163   Bitboard sliders() const;
164   Bitboard pawns(Color c) const;
165   Bitboard knights(Color c) const;
166   Bitboard bishops(Color c) const;
167   Bitboard rooks(Color c) const;
168   Bitboard queens(Color c) const;
169   Bitboard kings(Color c) const;
170   Bitboard rooks_and_queens(Color c) const;
171   Bitboard bishops_and_queens(Color c) const;
172   Bitboard sliders_of_color(Color c) const;
173
174   // Number of pieces of each color and type
175   int piece_count(Color c, PieceType pt) const;
176
177   // The en passant square
178   Square ep_square() const;
179
180   // Current king position for each color
181   Square king_square(Color c) const;
182
183   // Castling rights
184   bool can_castle_kingside(Color c) const;
185   bool can_castle_queenside(Color c) const;
186   bool can_castle(Color c) const;
187   Square initial_kr_square(Color c) const;
188   Square initial_qr_square(Color c) const;
189
190   // Attack bitboards
191   Bitboard sliding_attacks(Square s, Direction d) const;
192   Bitboard ray_attacks(Square s, SignedDirection d) const;
193   Bitboard pawn_attacks(Color c, Square s) const;
194
195   template<PieceType>
196   Bitboard piece_attacks(Square s) const;
197
198   // Bitboards for pinned pieces and discovered check candidates
199   Bitboard discovered_check_candidates(Color c) const;
200   Bitboard pinned_pieces(Color c, Bitboard& p) const;
201   Bitboard pinned_pieces(Color c) const;
202
203   // Checking pieces
204   Bitboard checkers() const;
205
206   // Piece lists
207   Square piece_list(Color c, PieceType pt, int index) const;
208
209   // Attack information for a given square
210   bool square_is_attacked(Square s, Color c) const;
211   Bitboard attacks_to(Square s) const;
212   Bitboard attacks_to(Square s, Color c) const;
213   bool is_check() const;
214   bool pawn_attacks_square(Color c, Square f, Square t) const;
215
216   template<PieceType>
217   Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
218
219   bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
220
221   // Properties of moves
222   bool pl_move_is_legal(Move m) const;
223   bool pl_move_is_legal(Move m, Bitboard pinned) const;
224   bool move_is_check(Move m) const;
225   bool move_is_check(Move m, Bitboard dcCandidates) const;
226   bool move_is_capture(Move m) const;
227   bool move_is_deep_pawn_push(Move m) const;
228   bool move_is_pawn_push_to_7th(Move m) const;
229   bool move_is_passed_pawn_push(Move m) const;
230   bool move_was_passed_pawn_push(Move m) const;
231   bool move_attacks_square(Move m, Square s) const;
232
233   // Information about pawns
234   bool pawn_is_passed(Color c, Square s) const;
235   bool pawn_is_isolated(Color c, Square s) const;
236   bool pawn_is_doubled(Color c, Square s) const;
237
238   // Open and half-open files
239   bool file_is_open(File f) const;
240   bool file_is_half_open(Color c, File f) const;
241
242   // Weak squares
243   bool square_is_weak(Square s, Color c) const;
244
245   // Doing and undoing moves
246   void backup(UndoInfo &u) const;
247   void restore(const UndoInfo &u);
248   void do_move(Move m, UndoInfo &u);
249   void do_move(Move m, UndoInfo &u, Bitboard dcCandidates);
250   void undo_move(Move m, const UndoInfo &u);
251   void do_null_move(UndoInfo &u);
252   void undo_null_move(const UndoInfo &u);
253
254   // Static exchange evaluation
255   int see(Square from, Square to) const;
256   int see(Move m) const;
257   int see(Square to) const;
258
259   // Accessing hash keys
260   Key get_key() const;
261   Key get_pawn_key() const;
262   Key get_material_key() const;
263
264   // Incremental evaluation
265   Value mg_value() const;
266   Value eg_value() const;
267   Value non_pawn_material(Color c) const;
268   Phase game_phase() const;
269   Value mg_pst_delta(Move m) const;
270
271   // Game termination checks
272   bool is_mate() const;
273   bool is_draw() const;
274
275   // Check if one side threatens a mate in one
276   bool has_mate_threat(Color c);
277
278   // Number of plies since the last non-reversible move
279   int rule_50_counter() const;
280
281   // Other properties of the position
282   bool opposite_colored_bishops() const;
283   bool has_pawn_on_7th(Color c) const;
284
285   // Reset the gamePly variable to 0
286   void reset_game_ply();
287
288   // Position consistency check, for debugging
289   bool is_ok(int* failedStep = NULL) const;
290
291   // Static member functions:
292   static void init_zobrist();
293   static void init_piece_square_tables();
294
295 private:
296   // Initialization helper functions (used while setting up a position)
297   void clear();
298   void put_piece(Piece p, Square s);
299   void allow_oo(Color c);
300   void allow_ooo(Color c);
301
302   // Helper functions for doing and undoing moves
303   void do_capture_move(Move m, PieceType capture, Color them, Square to);
304   void do_castle_move(Move m);
305   void do_promotion_move(Move m, UndoInfo &u);
306   void do_ep_move(Move m);
307   void undo_castle_move(Move m);
308   void undo_promotion_move(Move m, const UndoInfo &u);
309   void undo_ep_move(Move m);
310   void find_checkers();
311
312   template<PieceType Piece>
313   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
314
315   template<PieceType Piece, bool FindPinned>
316   Bitboard hidden_checks(Color c, Square ksq, Bitboard& pinners) const;
317
318   // Computing hash keys from scratch (for initialization and debugging)
319   Key compute_key() const;
320   Key compute_pawn_key() const;
321   Key compute_material_key() const;
322
323   // Computing incremental evaluation scores and material counts
324   Value mg_pst(Color c, PieceType pt, Square s) const;
325   Value eg_pst(Color c, PieceType pt, Square s) const;
326   Value compute_mg_value() const;
327   Value compute_eg_value() const;
328   Value compute_non_pawn_material(Color c) const;
329
330   // Bitboards
331   Bitboard byColorBB[2], byTypeBB[8];
332   Bitboard checkersBB;
333   mutable Bitboard pinners[2], pinned[2], dcCandidates[2];
334
335   // Board
336   Piece board[64];
337
338   // Piece counts
339   int pieceCount[2][8]; // [color][pieceType]
340
341   // Piece lists
342   Square pieceList[2][8][16]; // [color][pieceType][index]
343   int index[64];
344
345   // Other info
346   Color sideToMove;
347   int castleRights;
348   File initialKFile, initialKRFile, initialQRFile;
349   Square epSquare;
350   Square kingSquare[2];
351   Move lastMove;
352   Key key, pawnKey, materialKey, history[MaxGameLength];
353   int rule50, gamePly;
354   Value mgValue, egValue;
355   Value npMaterial[2];
356
357   // Static variables
358   static int castleRightsMask[64];
359   static Key zobrist[2][8][64];
360   static Key zobEp[64];
361   static Key zobCastle[16];
362   static Key zobMaterial[2][8][16];
363   static Key zobSideToMove;
364   static Value MgPieceSquareTable[16][64];
365   static Value EgPieceSquareTable[16][64];
366 };
367
368
369 ////
370 //// Inline functions
371 ////
372
373 inline Piece Position::piece_on(Square s) const {
374   return board[s];
375 }
376
377 inline Color Position::color_of_piece_on(Square s) const {
378   return color_of_piece(piece_on(s));
379 }
380
381 inline PieceType Position::type_of_piece_on(Square s) const {
382   return type_of_piece(piece_on(s));
383 }
384
385 inline bool Position::square_is_empty(Square s) const {
386   return piece_on(s) == EMPTY;
387 }
388
389 inline bool Position::square_is_occupied(Square s) const {
390   return !square_is_empty(s);
391 }
392
393 inline Value Position::midgame_value_of_piece_on(Square s) const {
394   return piece_value_midgame(piece_on(s));
395 }
396
397 inline Value Position::endgame_value_of_piece_on(Square s) const {
398   return piece_value_endgame(piece_on(s));
399 }
400
401 inline Color Position::side_to_move() const {
402   return sideToMove;
403 }
404
405 inline Bitboard Position::occupied_squares() const {
406   return byTypeBB[0];
407 }
408
409 inline Bitboard Position::empty_squares() const {
410   return ~(occupied_squares());
411 }
412
413 inline Bitboard Position::pieces_of_color(Color c) const {
414   return byColorBB[c];
415 }
416
417 inline Bitboard Position::pieces_of_type(PieceType pt) const {
418   return byTypeBB[pt];
419 }
420
421 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
422   return pieces_of_color(c) & pieces_of_type(pt);
423 }
424
425 inline Bitboard Position::pawns() const {
426   return pieces_of_type(PAWN);
427 }
428
429 inline Bitboard Position::knights() const {
430   return pieces_of_type(KNIGHT);
431 }
432
433 inline Bitboard Position::bishops() const {
434   return pieces_of_type(BISHOP);
435 }
436
437 inline Bitboard Position::rooks() const {
438   return pieces_of_type(ROOK);
439 }
440
441 inline Bitboard Position::queens() const {
442   return pieces_of_type(QUEEN);
443 }
444
445 inline Bitboard Position::kings() const {
446   return pieces_of_type(KING);
447 }
448
449 inline Bitboard Position::rooks_and_queens() const {
450   return rooks() | queens();
451 }
452
453 inline Bitboard Position::bishops_and_queens() const {
454   return bishops() | queens();
455 }
456
457 inline Bitboard Position::sliders() const {
458   return bishops() | queens() | rooks();
459 }
460
461 inline Bitboard Position::pawns(Color c) const {
462   return pieces_of_color_and_type(c, PAWN);
463 }
464
465 inline Bitboard Position::knights(Color c) const {
466   return pieces_of_color_and_type(c, KNIGHT);
467 }
468
469 inline Bitboard Position::bishops(Color c) const {
470   return pieces_of_color_and_type(c, BISHOP);
471 }
472
473 inline Bitboard Position::rooks(Color c) const {
474   return pieces_of_color_and_type(c, ROOK);
475 }
476
477 inline Bitboard Position::queens(Color c) const {
478   return pieces_of_color_and_type(c, QUEEN);
479 }
480
481 inline Bitboard Position::kings(Color c) const {
482   return pieces_of_color_and_type(c, KING);
483 }
484
485 inline Bitboard Position::rooks_and_queens(Color c) const {
486   return rooks_and_queens() & pieces_of_color(c);
487 }
488
489 inline Bitboard Position::bishops_and_queens(Color c) const {
490   return bishops_and_queens() & pieces_of_color(c);
491 }
492
493 inline Bitboard Position::sliders_of_color(Color c) const {
494   return sliders() & pieces_of_color(c);
495 }
496
497 inline int Position::piece_count(Color c, PieceType pt) const {
498   return pieceCount[c][pt];
499 }
500
501 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
502   return pieceList[c][pt][index];
503 }
504
505 inline Square Position::ep_square() const {
506   return epSquare;
507 }
508
509 inline Square Position::king_square(Color c) const {
510   return kingSquare[c];
511 }
512
513 inline bool Position::can_castle_kingside(Color side) const {
514   return castleRights & (1+int(side));
515 }
516
517 inline bool Position::can_castle_queenside(Color side) const {
518   return castleRights & (4+4*int(side));
519 }
520
521 inline bool Position::can_castle(Color side) const {
522   return can_castle_kingside(side) || can_castle_queenside(side);
523 }
524
525 inline Square Position::initial_kr_square(Color c) const {
526   return relative_square(c, make_square(initialKRFile, RANK_1));
527 }
528
529 inline Square Position::initial_qr_square(Color c) const {
530   return relative_square(c, make_square(initialQRFile, RANK_1));
531 }
532
533 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
534   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
535 }
536
537 template<>
538 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
539   return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
540 }
541
542 template<>
543 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
544   return StepAttackBB[KNIGHT][s];
545 }
546
547 template<>
548 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
549   return bishop_attacks_bb(s, occupied_squares());
550 }
551
552 template<>
553 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
554   return rook_attacks_bb(s, occupied_squares());
555 }
556
557 template<>
558 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
559   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
560 }
561
562 template<>
563 inline Bitboard Position::piece_attacks<KING>(Square s) const {
564   return StepAttackBB[KING][s];
565 }
566
567 inline Bitboard Position::checkers() const {
568   return checkersBB;
569 }
570
571 inline bool Position::is_check() const {
572   return checkersBB != EmptyBoardBB;
573 }
574
575 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
576   return bit_is_set(pawn_attacks(c, f), t);
577 }
578
579 template<PieceType Piece>
580 Bitboard Position::piece_attacks_square(Square f, Square t) const {
581   return bit_is_set(piece_attacks<Piece>(f), t);
582 }
583
584 inline Bitboard Position::attacks_to(Square s, Color c) const {
585
586   return attacks_to(s) & pieces_of_color(c);
587 }
588
589 inline bool Position::square_is_attacked(Square s, Color c) const {
590
591   return attacks_to(s, c) != EmptyBoardBB;
592 }
593
594 inline bool Position::pawn_is_passed(Color c, Square s) const {
595   return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
596 }
597
598 inline bool Position::pawn_is_isolated(Color c, Square s) const {
599   return !(pawns(c) & neighboring_files_bb(s));
600 }
601
602 inline bool Position::pawn_is_doubled(Color c, Square s) const {
603   return pawns(c) & squares_behind(c, s);
604 }
605
606 inline bool Position::file_is_open(File f) const {
607   return !(pawns() & file_bb(f));
608 }
609
610 inline bool Position::file_is_half_open(Color c, File f) const {
611   return !(pawns(c) & file_bb(f));
612 }
613
614 inline bool Position::square_is_weak(Square s, Color c) const {
615   return !(pawns(c) & outpost_mask(opposite_color(c), s));
616 }
617
618 inline Key Position::get_key() const {
619   return key;
620 }
621
622 inline Key Position::get_pawn_key() const {
623   return pawnKey;
624 }
625
626 inline Key Position::get_material_key() const {
627   return materialKey;
628 }
629
630 inline Value Position::mg_pst(Color c, PieceType pt, Square s) const {
631   return MgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
632 }
633
634 inline Value Position::mg_pst_delta(Move m) const {
635   return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
636         -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
637 }
638
639 inline Value Position::eg_pst(Color c, PieceType pt, Square s) const {
640   return EgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
641 }
642
643 inline Value Position::mg_value() const {
644   return mgValue;
645 }
646
647 inline Value Position::eg_value() const {
648   return egValue;
649 }
650
651 inline Value Position::non_pawn_material(Color c) const {
652   return npMaterial[c];
653 }
654
655 inline Phase Position::game_phase() const {
656
657   // The purpose of the Value(325) terms below is to make sure the difference
658   // between MidgameLimit and EndgameLimit is a power of 2, which should make
659   // the division at the end of the function a bit faster.
660   static const Value MidgameLimit =  2 * QueenValueMidgame
661                                    + 2 * RookValueMidgame
662                                    + 6 * BishopValueMidgame
663                                    + Value(325);
664
665   static const Value EndgameLimit = 4 * RookValueMidgame - Value(325);
666
667   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
668
669   if (npm >= MidgameLimit)
670       return PHASE_MIDGAME;
671   else if(npm <= EndgameLimit)
672       return PHASE_ENDGAME;
673   else
674       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
675 }
676
677 inline bool Position::move_is_deep_pawn_push(Move m) const {
678
679   Color c = side_to_move();
680   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
681         && relative_rank(c, move_to(m)) > RANK_4;
682 }
683
684 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
685
686   Color c = side_to_move();
687   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
688         && relative_rank(c, move_to(m)) == RANK_7;
689 }
690
691 inline bool Position::move_is_passed_pawn_push(Move m) const {
692
693   Color c = side_to_move();
694   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
695         && pawn_is_passed(c, move_to(m));
696 }
697
698 inline bool Position::move_was_passed_pawn_push(Move m) const {
699
700   Color c = opposite_color(side_to_move());
701   return   piece_on(move_to(m)) == piece_of_color_and_type(c, PAWN)
702         && pawn_is_passed(c, move_to(m));
703 }
704
705 inline int Position::rule_50_counter() const {
706
707   return rule50;
708 }
709
710 inline bool Position::opposite_colored_bishops() const {
711
712   return   piece_count(WHITE, BISHOP) == 1
713         && piece_count(BLACK, BISHOP) == 1
714         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
715 }
716
717 inline bool Position::has_pawn_on_7th(Color c) const {
718
719   return pawns(c) & relative_rank_bb(c, RANK_7);
720 }
721
722
723 #endif // !defined(POSITION_H_INCLUDED)