Passing UndoInfo is not needed anymore when undoing the move
[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   Bitboard pinners[2], pinned[2], dcCandidates[2], checkersBB;
84   Key key, pawnKey, materialKey;
85   int castleRights, rule50;
86   Square epSquare;
87   Move lastMove;
88   Value mgValue, egValue;
89   PieceType capture;
90   UndoInfo* previous;
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 move_is_check(Move m) const;
224   bool move_is_capture(Move m) const;
225   bool move_is_deep_pawn_push(Move m) const;
226   bool move_is_pawn_push_to_7th(Move m) const;
227   bool move_is_passed_pawn_push(Move m) const;
228   bool move_was_passed_pawn_push(Move m) const;
229   bool move_attacks_square(Move m, Square s) const;
230
231   // Information about pawns
232   bool pawn_is_passed(Color c, Square s) const;
233   bool pawn_is_isolated(Color c, Square s) const;
234   bool pawn_is_doubled(Color c, Square s) const;
235
236   // Open and half-open files
237   bool file_is_open(File f) const;
238   bool file_is_half_open(Color c, File f) const;
239
240   // Weak squares
241   bool square_is_weak(Square s, Color c) const;
242
243   // Doing and undoing moves
244   void do_move(Move m, UndoInfo &u);
245   void undo_move(Move m);
246   void do_null_move(UndoInfo &u);
247   void undo_null_move(const UndoInfo &u);
248
249   // Static exchange evaluation
250   int see(Square from, Square to) const;
251   int see(Move m) const;
252   int see(Square to) const;
253
254   // Accessing hash keys
255   Key get_key() const;
256   Key get_pawn_key() const;
257   Key get_material_key() const;
258
259   // Incremental evaluation
260   Value mg_value() const;
261   Value eg_value() const;
262   Value non_pawn_material(Color c) const;
263   Phase game_phase() const;
264   Value mg_pst_delta(Move m) const;
265
266   // Game termination checks
267   bool is_mate() const;
268   bool is_draw() const;
269
270   // Check if one side threatens a mate in one
271   bool has_mate_threat(Color c);
272
273   // Number of plies since the last non-reversible move
274   int rule_50_counter() const;
275
276   // Other properties of the position
277   bool opposite_colored_bishops() const;
278   bool has_pawn_on_7th(Color c) const;
279
280   // Reset the gamePly variable to 0
281   void reset_game_ply();
282
283   // Position consistency check, for debugging
284   bool is_ok(int* failedStep = NULL) const;
285
286   // Static member functions:
287   static void init_zobrist();
288   static void init_piece_square_tables();
289
290 private:
291   // Initialization helper functions (used while setting up a position)
292   void clear();
293   void put_piece(Piece p, Square s);
294   void allow_oo(Color c);
295   void allow_ooo(Color c);
296
297   // Helper functions for doing and undoing moves
298   void do_capture_move(Move m, PieceType capture, Color them, Square to);
299   void do_castle_move(Move m);
300   void do_promotion_move(Move m);
301   void do_ep_move(Move m);
302   void undo_castle_move(Move m);
303   void undo_promotion_move(Move m);
304   void undo_ep_move(Move m);
305   void find_checkers();
306
307   template<PieceType Piece>
308   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
309
310   template<PieceType Piece, bool FindPinned>
311   Bitboard hidden_checks(Color c, Square ksq, Bitboard& pinners) const;
312
313   // Computing hash keys from scratch (for initialization and debugging)
314   Key compute_key() const;
315   Key compute_pawn_key() const;
316   Key compute_material_key() const;
317
318   // Computing incremental evaluation scores and material counts
319   enum GamePhase {
320       MidGame,
321       EndGame
322   };
323   template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
324   template<GamePhase> Value compute_value() const;
325   Value compute_non_pawn_material(Color c) const;
326
327   // Bitboards
328   Bitboard byColorBB[2], byTypeBB[8];
329
330   // Board
331   Piece board[64];
332
333   // Piece counts
334   int pieceCount[2][8]; // [color][pieceType]
335
336   // Piece lists
337   Square pieceList[2][8][16]; // [color][pieceType][index]
338   int index[64];
339
340   // Other info
341   Square kingSquare[2];
342   Color sideToMove;
343   int gamePly;
344   Key history[MaxGameLength];
345   Value npMaterial[2];
346   File initialKFile, initialKRFile, initialQRFile;
347
348   // Info backed up in do_move()
349   union {
350       UndoInfo undoInfoUnion;
351       struct { // Must have the same layout of UndoInfo
352           mutable Bitboard pinners[2], pinned[2], dcCandidates[2];
353           Bitboard checkersBB;
354           Key key, pawnKey, materialKey;
355           int castleRights, rule50;
356           Square epSquare;
357           Move lastMove;
358           Value mgValue, egValue;
359           PieceType capture;
360           UndoInfo* previous;
361       };
362   };
363
364   // Static variables
365   static int castleRightsMask[64];
366   static Key zobrist[2][8][64];
367   static Key zobEp[64];
368   static Key zobCastle[16];
369   static Key zobMaterial[2][8][16];
370   static Key zobSideToMove;
371   static Value MgPieceSquareTable[16][64];
372   static Value EgPieceSquareTable[16][64];
373 };
374
375
376 ////
377 //// Inline functions
378 ////
379
380 inline Piece Position::piece_on(Square s) const {
381   return board[s];
382 }
383
384 inline Color Position::color_of_piece_on(Square s) const {
385   return color_of_piece(piece_on(s));
386 }
387
388 inline PieceType Position::type_of_piece_on(Square s) const {
389   return type_of_piece(piece_on(s));
390 }
391
392 inline bool Position::square_is_empty(Square s) const {
393   return piece_on(s) == EMPTY;
394 }
395
396 inline bool Position::square_is_occupied(Square s) const {
397   return !square_is_empty(s);
398 }
399
400 inline Value Position::midgame_value_of_piece_on(Square s) const {
401   return piece_value_midgame(piece_on(s));
402 }
403
404 inline Value Position::endgame_value_of_piece_on(Square s) const {
405   return piece_value_endgame(piece_on(s));
406 }
407
408 inline Color Position::side_to_move() const {
409   return sideToMove;
410 }
411
412 inline Bitboard Position::occupied_squares() const {
413   return byTypeBB[0];
414 }
415
416 inline Bitboard Position::empty_squares() const {
417   return ~(occupied_squares());
418 }
419
420 inline Bitboard Position::pieces_of_color(Color c) const {
421   return byColorBB[c];
422 }
423
424 inline Bitboard Position::pieces_of_type(PieceType pt) const {
425   return byTypeBB[pt];
426 }
427
428 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
429   return pieces_of_color(c) & pieces_of_type(pt);
430 }
431
432 inline Bitboard Position::pawns() const {
433   return pieces_of_type(PAWN);
434 }
435
436 inline Bitboard Position::knights() const {
437   return pieces_of_type(KNIGHT);
438 }
439
440 inline Bitboard Position::bishops() const {
441   return pieces_of_type(BISHOP);
442 }
443
444 inline Bitboard Position::rooks() const {
445   return pieces_of_type(ROOK);
446 }
447
448 inline Bitboard Position::queens() const {
449   return pieces_of_type(QUEEN);
450 }
451
452 inline Bitboard Position::kings() const {
453   return pieces_of_type(KING);
454 }
455
456 inline Bitboard Position::rooks_and_queens() const {
457   return rooks() | queens();
458 }
459
460 inline Bitboard Position::bishops_and_queens() const {
461   return bishops() | queens();
462 }
463
464 inline Bitboard Position::sliders() const {
465   return bishops() | queens() | rooks();
466 }
467
468 inline Bitboard Position::pawns(Color c) const {
469   return pieces_of_color_and_type(c, PAWN);
470 }
471
472 inline Bitboard Position::knights(Color c) const {
473   return pieces_of_color_and_type(c, KNIGHT);
474 }
475
476 inline Bitboard Position::bishops(Color c) const {
477   return pieces_of_color_and_type(c, BISHOP);
478 }
479
480 inline Bitboard Position::rooks(Color c) const {
481   return pieces_of_color_and_type(c, ROOK);
482 }
483
484 inline Bitboard Position::queens(Color c) const {
485   return pieces_of_color_and_type(c, QUEEN);
486 }
487
488 inline Bitboard Position::kings(Color c) const {
489   return pieces_of_color_and_type(c, KING);
490 }
491
492 inline Bitboard Position::rooks_and_queens(Color c) const {
493   return rooks_and_queens() & pieces_of_color(c);
494 }
495
496 inline Bitboard Position::bishops_and_queens(Color c) const {
497   return bishops_and_queens() & pieces_of_color(c);
498 }
499
500 inline Bitboard Position::sliders_of_color(Color c) const {
501   return sliders() & pieces_of_color(c);
502 }
503
504 inline int Position::piece_count(Color c, PieceType pt) const {
505   return pieceCount[c][pt];
506 }
507
508 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
509   return pieceList[c][pt][index];
510 }
511
512 inline Square Position::ep_square() const {
513   return epSquare;
514 }
515
516 inline Square Position::king_square(Color c) const {
517   return kingSquare[c];
518 }
519
520 inline bool Position::can_castle_kingside(Color side) const {
521   return castleRights & (1+int(side));
522 }
523
524 inline bool Position::can_castle_queenside(Color side) const {
525   return castleRights & (4+4*int(side));
526 }
527
528 inline bool Position::can_castle(Color side) const {
529   return can_castle_kingside(side) || can_castle_queenside(side);
530 }
531
532 inline Square Position::initial_kr_square(Color c) const {
533   return relative_square(c, make_square(initialKRFile, RANK_1));
534 }
535
536 inline Square Position::initial_qr_square(Color c) const {
537   return relative_square(c, make_square(initialQRFile, RANK_1));
538 }
539
540 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
541   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
542 }
543
544 template<>
545 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
546   return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
547 }
548
549 template<>
550 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
551   return StepAttackBB[KNIGHT][s];
552 }
553
554 template<>
555 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
556   return bishop_attacks_bb(s, occupied_squares());
557 }
558
559 template<>
560 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
561   return rook_attacks_bb(s, occupied_squares());
562 }
563
564 template<>
565 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
566   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
567 }
568
569 template<>
570 inline Bitboard Position::piece_attacks<KING>(Square s) const {
571   return StepAttackBB[KING][s];
572 }
573
574 inline Bitboard Position::checkers() const {
575   return checkersBB;
576 }
577
578 inline bool Position::is_check() const {
579   return checkersBB != EmptyBoardBB;
580 }
581
582 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
583   return bit_is_set(pawn_attacks(c, f), t);
584 }
585
586 template<PieceType Piece>
587 Bitboard Position::piece_attacks_square(Square f, Square t) const {
588   return bit_is_set(piece_attacks<Piece>(f), t);
589 }
590
591 inline Bitboard Position::attacks_to(Square s, Color c) const {
592
593   return attacks_to(s) & pieces_of_color(c);
594 }
595
596 inline bool Position::square_is_attacked(Square s, Color c) const {
597
598   return attacks_to(s, c) != EmptyBoardBB;
599 }
600
601 inline bool Position::pawn_is_passed(Color c, Square s) const {
602   return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
603 }
604
605 inline bool Position::pawn_is_isolated(Color c, Square s) const {
606   return !(pawns(c) & neighboring_files_bb(s));
607 }
608
609 inline bool Position::pawn_is_doubled(Color c, Square s) const {
610   return pawns(c) & squares_behind(c, s);
611 }
612
613 inline bool Position::file_is_open(File f) const {
614   return !(pawns() & file_bb(f));
615 }
616
617 inline bool Position::file_is_half_open(Color c, File f) const {
618   return !(pawns(c) & file_bb(f));
619 }
620
621 inline bool Position::square_is_weak(Square s, Color c) const {
622   return !(pawns(c) & outpost_mask(opposite_color(c), s));
623 }
624
625 inline Key Position::get_key() const {
626   return key;
627 }
628
629 inline Key Position::get_pawn_key() const {
630   return pawnKey;
631 }
632
633 inline Key Position::get_material_key() const {
634   return materialKey;
635 }
636
637 template<Position::GamePhase Phase>
638 inline Value Position::pst(Color c, PieceType pt, Square s) const {
639   return (Phase == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
640                            : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
641 }
642
643 inline Value Position::mg_pst_delta(Move m) const {
644   return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
645         -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
646 }
647
648 inline Value Position::mg_value() const {
649   return mgValue;
650 }
651
652 inline Value Position::eg_value() const {
653   return egValue;
654 }
655
656 inline Value Position::non_pawn_material(Color c) const {
657   return npMaterial[c];
658 }
659
660 inline Phase Position::game_phase() const {
661
662   // The purpose of the Value(325) terms below is to make sure the difference
663   // between MidgameLimit and EndgameLimit is a power of 2, which should make
664   // the division at the end of the function a bit faster.
665   static const Value MidgameLimit =  2 * QueenValueMidgame
666                                    + 2 * RookValueMidgame
667                                    + 6 * BishopValueMidgame
668                                    + Value(325);
669
670   static const Value EndgameLimit = 4 * RookValueMidgame - Value(325);
671
672   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
673
674   if (npm >= MidgameLimit)
675       return PHASE_MIDGAME;
676   else if(npm <= EndgameLimit)
677       return PHASE_ENDGAME;
678   else
679       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
680 }
681
682 inline bool Position::move_is_deep_pawn_push(Move m) const {
683
684   Color c = side_to_move();
685   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
686         && relative_rank(c, move_to(m)) > RANK_4;
687 }
688
689 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
690
691   Color c = side_to_move();
692   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
693         && relative_rank(c, move_to(m)) == RANK_7;
694 }
695
696 inline bool Position::move_is_passed_pawn_push(Move m) const {
697
698   Color c = side_to_move();
699   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
700         && pawn_is_passed(c, move_to(m));
701 }
702
703 inline bool Position::move_was_passed_pawn_push(Move m) const {
704
705   Color c = opposite_color(side_to_move());
706   return   piece_on(move_to(m)) == piece_of_color_and_type(c, PAWN)
707         && pawn_is_passed(c, move_to(m));
708 }
709
710 inline int Position::rule_50_counter() const {
711
712   return rule50;
713 }
714
715 inline bool Position::opposite_colored_bishops() const {
716
717   return   piece_count(WHITE, BISHOP) == 1
718         && piece_count(BLACK, BISHOP) == 1
719         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
720 }
721
722 inline bool Position::has_pawn_on_7th(Color c) const {
723
724   return pawns(c) & relative_rank_bb(c, RANK_7);
725 }
726
727
728 #endif // !defined(POSITION_H_INCLUDED)