Do not copy the whole old state in do_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 StateInfo 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 StateInfo object
79 /// must be passed as a parameter.
80
81 struct StateInfo {
82   Bitboard pinners[2], pinned[2], dcCandidates[2], checkersBB;
83   Key key, pawnKey, materialKey;
84   int castleRights, rule50;
85   Square epSquare;
86   Value mgValue, egValue;
87   PieceType capture;
88   StateInfo* previous;
89   Move lastMove;
90 };
91
92
93 /// The position data structure.  A position consists of the following data:
94 ///
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
107 ///      possible).
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.
115
116 class Position {
117
118   friend class MaterialInfo;
119   friend class EndgameFunctions;
120
121 public:
122   // Constructors
123   Position() {};
124   Position(const Position& pos);
125   Position(const std::string& fen);
126
127   // Text input/output
128   void from_fen(const std::string& fen);
129   const std::string to_fen() const;
130   void print(Move m = MOVE_NONE) const;
131
132   // Copying
133   void copy(const Position &pos);
134   void flipped_copy(const Position &pos);
135
136   // The piece on a given square
137   Piece piece_on(Square s) const;
138   PieceType type_of_piece_on(Square s) const;
139   Color color_of_piece_on(Square s) const;
140   bool square_is_empty(Square s) const;
141   bool square_is_occupied(Square s) const;
142   Value midgame_value_of_piece_on(Square s) const;
143   Value endgame_value_of_piece_on(Square s) const;
144
145   // Side to move
146   Color side_to_move() const;
147
148   // Bitboard representation of the position
149   Bitboard empty_squares() const;
150   Bitboard occupied_squares() const;
151   Bitboard pieces_of_color(Color c) const;
152   Bitboard pieces_of_type(PieceType pt) const;
153   Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
154   Bitboard pawns() const;
155   Bitboard knights() const;
156   Bitboard bishops() const;
157   Bitboard rooks() const;
158   Bitboard queens() const;
159   Bitboard kings() const;
160   Bitboard rooks_and_queens() const;
161   Bitboard bishops_and_queens() const;
162   Bitboard sliders() const;
163   Bitboard pawns(Color c) const;
164   Bitboard knights(Color c) const;
165   Bitboard bishops(Color c) const;
166   Bitboard rooks(Color c) const;
167   Bitboard queens(Color c) const;
168   Bitboard kings(Color c) const;
169   Bitboard rooks_and_queens(Color c) const;
170   Bitboard bishops_and_queens(Color c) const;
171   Bitboard sliders_of_color(Color c) const;
172
173   // Number of pieces of each color and type
174   int piece_count(Color c, PieceType pt) const;
175
176   // The en passant square
177   Square ep_square() const;
178
179   // Current king position for each color
180   Square king_square(Color c) const;
181
182   // Castling rights
183   bool can_castle_kingside(Color c) const;
184   bool can_castle_queenside(Color c) const;
185   bool can_castle(Color c) const;
186   Square initial_kr_square(Color c) const;
187   Square initial_qr_square(Color c) const;
188
189   // Attack bitboards
190   Bitboard sliding_attacks(Square s, Direction d) const;
191   Bitboard ray_attacks(Square s, SignedDirection d) const;
192   Bitboard pawn_attacks(Color c, Square s) const;
193
194   template<PieceType>
195   Bitboard piece_attacks(Square s) const;
196
197   // Bitboards for pinned pieces and discovered check candidates
198   Bitboard discovered_check_candidates(Color c) const;
199   Bitboard pinned_pieces(Color c, Bitboard& p) const;
200   Bitboard pinned_pieces(Color c) const;
201
202   // Checking pieces
203   Bitboard checkers() const;
204
205   // Piece lists
206   Square piece_list(Color c, PieceType pt, int index) const;
207
208   // Attack information for a given square
209   bool square_is_attacked(Square s, Color c) const;
210   Bitboard attacks_to(Square s) const;
211   Bitboard attacks_to(Square s, Color c) const;
212   bool is_check() const;
213   bool pawn_attacks_square(Color c, Square f, Square t) const;
214
215   template<PieceType>
216   Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
217
218   bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
219
220   // Properties of moves
221   bool pl_move_is_legal(Move m) const;
222   bool move_is_check(Move m) const;
223   bool move_is_capture(Move m) const;
224   bool move_is_deep_pawn_push(Move m) const;
225   bool move_is_pawn_push_to_7th(Move m) const;
226   bool move_is_passed_pawn_push(Move m) const;
227   bool move_was_passed_pawn_push(Move m) const;
228   bool move_attacks_square(Move m, Square s) const;
229
230   // Information about pawns
231   bool pawn_is_passed(Color c, Square s) const;
232   bool pawn_is_isolated(Color c, Square s) const;
233   bool pawn_is_doubled(Color c, Square s) const;
234
235   // Open and half-open files
236   bool file_is_open(File f) const;
237   bool file_is_half_open(Color c, File f) const;
238
239   // Weak squares
240   bool square_is_weak(Square s, Color c) const;
241
242   // Doing and undoing moves
243   void do_move(Move m, StateInfo& st);
244   void undo_move(Move m);
245   void do_null_move(StateInfo& st);
246   void undo_null_move();
247
248   // Static exchange evaluation
249   int see(Square from, Square to) const;
250   int see(Move m) const;
251   int see(Square to) const;
252
253   // Accessing hash keys
254   Key get_key() const;
255   Key get_pawn_key() const;
256   Key get_material_key() const;
257
258   // Incremental evaluation
259   Value mg_value() const;
260   Value eg_value() const;
261   Value non_pawn_material(Color c) const;
262   Phase game_phase() const;
263   Value mg_pst_delta(Move m) const;
264
265   // Game termination checks
266   bool is_mate() const;
267   bool is_draw() const;
268
269   // Check if one side threatens a mate in one
270   bool has_mate_threat(Color c);
271
272   // Number of plies since the last non-reversible move
273   int rule_50_counter() const;
274
275   // Other properties of the position
276   bool opposite_colored_bishops() const;
277   bool has_pawn_on_7th(Color c) const;
278
279   // Reset the gamePly variable to 0
280   void reset_game_ply();
281
282   // Position consistency check, for debugging
283   bool is_ok(int* failedStep = NULL) const;
284
285   // Static member functions:
286   static void init_zobrist();
287   static void init_piece_square_tables();
288
289 private:
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 init_new_state(StateInfo& newSt);
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   void find_pinned();
307
308   template<PieceType Piece>
309   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
310
311   template<PieceType Piece, bool FindPinned>
312   Bitboard hidden_checks(Color c, Square ksq, Bitboard& pinners) const;
313
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;
318
319   // Computing incremental evaluation scores and material counts
320   enum GamePhase {
321       MidGame,
322       EndGame
323   };
324   template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
325   template<GamePhase> Value compute_value() const;
326   Value compute_non_pawn_material(Color c) const;
327
328   // Bitboards
329   Bitboard byColorBB[2], byTypeBB[8];
330
331   // Board
332   Piece board[64];
333
334   // Piece counts
335   int pieceCount[2][8]; // [color][pieceType]
336
337   // Piece lists
338   Square pieceList[2][8][16]; // [color][pieceType][index]
339   int index[64];
340
341   // Other info
342   Square kingSquare[2];
343   Color sideToMove;
344   int gamePly;
345   Key history[MaxGameLength];
346   Value npMaterial[2];
347   File initialKFile, initialKRFile, initialQRFile;
348   StateInfo startState;
349   StateInfo* st;
350
351   // Static variables
352   static int castleRightsMask[64];
353   static Key zobrist[2][8][64];
354   static Key zobEp[64];
355   static Key zobCastle[16];
356   static Key zobMaterial[2][8][16];
357   static Key zobSideToMove;
358   static Value MgPieceSquareTable[16][64];
359   static Value EgPieceSquareTable[16][64];
360 };
361
362
363 ////
364 //// Inline functions
365 ////
366
367 inline Piece Position::piece_on(Square s) const {
368   return board[s];
369 }
370
371 inline Color Position::color_of_piece_on(Square s) const {
372   return color_of_piece(piece_on(s));
373 }
374
375 inline PieceType Position::type_of_piece_on(Square s) const {
376   return type_of_piece(piece_on(s));
377 }
378
379 inline bool Position::square_is_empty(Square s) const {
380   return piece_on(s) == EMPTY;
381 }
382
383 inline bool Position::square_is_occupied(Square s) const {
384   return !square_is_empty(s);
385 }
386
387 inline Value Position::midgame_value_of_piece_on(Square s) const {
388   return piece_value_midgame(piece_on(s));
389 }
390
391 inline Value Position::endgame_value_of_piece_on(Square s) const {
392   return piece_value_endgame(piece_on(s));
393 }
394
395 inline Color Position::side_to_move() const {
396   return sideToMove;
397 }
398
399 inline Bitboard Position::occupied_squares() const {
400   return byTypeBB[0];
401 }
402
403 inline Bitboard Position::empty_squares() const {
404   return ~(occupied_squares());
405 }
406
407 inline Bitboard Position::pieces_of_color(Color c) const {
408   return byColorBB[c];
409 }
410
411 inline Bitboard Position::pieces_of_type(PieceType pt) const {
412   return byTypeBB[pt];
413 }
414
415 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
416   return pieces_of_color(c) & pieces_of_type(pt);
417 }
418
419 inline Bitboard Position::pawns() const {
420   return pieces_of_type(PAWN);
421 }
422
423 inline Bitboard Position::knights() const {
424   return pieces_of_type(KNIGHT);
425 }
426
427 inline Bitboard Position::bishops() const {
428   return pieces_of_type(BISHOP);
429 }
430
431 inline Bitboard Position::rooks() const {
432   return pieces_of_type(ROOK);
433 }
434
435 inline Bitboard Position::queens() const {
436   return pieces_of_type(QUEEN);
437 }
438
439 inline Bitboard Position::kings() const {
440   return pieces_of_type(KING);
441 }
442
443 inline Bitboard Position::rooks_and_queens() const {
444   return rooks() | queens();
445 }
446
447 inline Bitboard Position::bishops_and_queens() const {
448   return bishops() | queens();
449 }
450
451 inline Bitboard Position::sliders() const {
452   return bishops() | queens() | rooks();
453 }
454
455 inline Bitboard Position::pawns(Color c) const {
456   return pieces_of_color_and_type(c, PAWN);
457 }
458
459 inline Bitboard Position::knights(Color c) const {
460   return pieces_of_color_and_type(c, KNIGHT);
461 }
462
463 inline Bitboard Position::bishops(Color c) const {
464   return pieces_of_color_and_type(c, BISHOP);
465 }
466
467 inline Bitboard Position::rooks(Color c) const {
468   return pieces_of_color_and_type(c, ROOK);
469 }
470
471 inline Bitboard Position::queens(Color c) const {
472   return pieces_of_color_and_type(c, QUEEN);
473 }
474
475 inline Bitboard Position::kings(Color c) const {
476   return pieces_of_color_and_type(c, KING);
477 }
478
479 inline Bitboard Position::rooks_and_queens(Color c) const {
480   return rooks_and_queens() & pieces_of_color(c);
481 }
482
483 inline Bitboard Position::bishops_and_queens(Color c) const {
484   return bishops_and_queens() & pieces_of_color(c);
485 }
486
487 inline Bitboard Position::sliders_of_color(Color c) const {
488   return sliders() & pieces_of_color(c);
489 }
490
491 inline int Position::piece_count(Color c, PieceType pt) const {
492   return pieceCount[c][pt];
493 }
494
495 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
496   return pieceList[c][pt][index];
497 }
498
499 inline Square Position::ep_square() const {
500   return st->epSquare;
501 }
502
503 inline Square Position::king_square(Color c) const {
504   return kingSquare[c];
505 }
506
507 inline bool Position::can_castle_kingside(Color side) const {
508   return st->castleRights & (1+int(side));
509 }
510
511 inline bool Position::can_castle_queenside(Color side) const {
512   return st->castleRights & (4+4*int(side));
513 }
514
515 inline bool Position::can_castle(Color side) const {
516   return can_castle_kingside(side) || can_castle_queenside(side);
517 }
518
519 inline Square Position::initial_kr_square(Color c) const {
520   return relative_square(c, make_square(initialKRFile, RANK_1));
521 }
522
523 inline Square Position::initial_qr_square(Color c) const {
524   return relative_square(c, make_square(initialQRFile, RANK_1));
525 }
526
527 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
528   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
529 }
530
531 template<>
532 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
533   return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
534 }
535
536 template<>
537 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
538   return StepAttackBB[KNIGHT][s];
539 }
540
541 template<>
542 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
543   return bishop_attacks_bb(s, occupied_squares());
544 }
545
546 template<>
547 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
548   return rook_attacks_bb(s, occupied_squares());
549 }
550
551 template<>
552 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
553   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
554 }
555
556 template<>
557 inline Bitboard Position::piece_attacks<KING>(Square s) const {
558   return StepAttackBB[KING][s];
559 }
560
561 inline Bitboard Position::pinned_pieces(Color c) const {
562   return st->pinned[c];
563 }
564
565 inline Bitboard Position::pinned_pieces(Color c, Bitboard& p) const {
566   p = st->pinners[c];
567   return st->pinned[c];
568 }
569
570 inline Bitboard Position::discovered_check_candidates(Color c) const {
571   return st->dcCandidates[c];
572 }
573
574 inline Bitboard Position::checkers() const {
575   return st->checkersBB;
576 }
577
578 inline bool Position::is_check() const {
579   return st->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 st->key;
627 }
628
629 inline Key Position::get_pawn_key() const {
630   return st->pawnKey;
631 }
632
633 inline Key Position::get_material_key() const {
634   return st->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 st->mgValue;
650 }
651
652 inline Value Position::eg_value() const {
653   return st->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 st->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)