8d1ba3598c2da91c9252bbdf39efa3be3fea3fda
[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   Move lastMove;
87   Value mgValue, egValue;
88   PieceType capture;
89   StateInfo* previous;
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 do_capture_move(Move m, PieceType capture, Color them, Square to);
298   void do_castle_move(Move m);
299   void do_promotion_move(Move m);
300   void do_ep_move(Move m);
301   void undo_castle_move(Move m);
302   void undo_promotion_move(Move m);
303   void undo_ep_move(Move m);
304   void find_checkers();
305
306   template<PieceType Piece>
307   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
308
309   template<PieceType Piece, bool FindPinned>
310   Bitboard hidden_checks(Color c, Square ksq, Bitboard& pinners) const;
311
312   // Computing hash keys from scratch (for initialization and debugging)
313   Key compute_key() const;
314   Key compute_pawn_key() const;
315   Key compute_material_key() const;
316
317   // Computing incremental evaluation scores and material counts
318   enum GamePhase {
319       MidGame,
320       EndGame
321   };
322   template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
323   template<GamePhase> Value compute_value() const;
324   Value compute_non_pawn_material(Color c) const;
325
326   // Bitboards
327   Bitboard byColorBB[2], byTypeBB[8];
328
329   // Board
330   Piece board[64];
331
332   // Piece counts
333   int pieceCount[2][8]; // [color][pieceType]
334
335   // Piece lists
336   Square pieceList[2][8][16]; // [color][pieceType][index]
337   int index[64];
338
339   // Other info
340   Square kingSquare[2];
341   Color sideToMove;
342   int gamePly;
343   Key history[MaxGameLength];
344   Value npMaterial[2];
345   File initialKFile, initialKRFile, initialQRFile;
346   StateInfo startState;
347   StateInfo* st;
348
349   // Static variables
350   static int castleRightsMask[64];
351   static Key zobrist[2][8][64];
352   static Key zobEp[64];
353   static Key zobCastle[16];
354   static Key zobMaterial[2][8][16];
355   static Key zobSideToMove;
356   static Value MgPieceSquareTable[16][64];
357   static Value EgPieceSquareTable[16][64];
358 };
359
360
361 ////
362 //// Inline functions
363 ////
364
365 inline Piece Position::piece_on(Square s) const {
366   return board[s];
367 }
368
369 inline Color Position::color_of_piece_on(Square s) const {
370   return color_of_piece(piece_on(s));
371 }
372
373 inline PieceType Position::type_of_piece_on(Square s) const {
374   return type_of_piece(piece_on(s));
375 }
376
377 inline bool Position::square_is_empty(Square s) const {
378   return piece_on(s) == EMPTY;
379 }
380
381 inline bool Position::square_is_occupied(Square s) const {
382   return !square_is_empty(s);
383 }
384
385 inline Value Position::midgame_value_of_piece_on(Square s) const {
386   return piece_value_midgame(piece_on(s));
387 }
388
389 inline Value Position::endgame_value_of_piece_on(Square s) const {
390   return piece_value_endgame(piece_on(s));
391 }
392
393 inline Color Position::side_to_move() const {
394   return sideToMove;
395 }
396
397 inline Bitboard Position::occupied_squares() const {
398   return byTypeBB[0];
399 }
400
401 inline Bitboard Position::empty_squares() const {
402   return ~(occupied_squares());
403 }
404
405 inline Bitboard Position::pieces_of_color(Color c) const {
406   return byColorBB[c];
407 }
408
409 inline Bitboard Position::pieces_of_type(PieceType pt) const {
410   return byTypeBB[pt];
411 }
412
413 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
414   return pieces_of_color(c) & pieces_of_type(pt);
415 }
416
417 inline Bitboard Position::pawns() const {
418   return pieces_of_type(PAWN);
419 }
420
421 inline Bitboard Position::knights() const {
422   return pieces_of_type(KNIGHT);
423 }
424
425 inline Bitboard Position::bishops() const {
426   return pieces_of_type(BISHOP);
427 }
428
429 inline Bitboard Position::rooks() const {
430   return pieces_of_type(ROOK);
431 }
432
433 inline Bitboard Position::queens() const {
434   return pieces_of_type(QUEEN);
435 }
436
437 inline Bitboard Position::kings() const {
438   return pieces_of_type(KING);
439 }
440
441 inline Bitboard Position::rooks_and_queens() const {
442   return rooks() | queens();
443 }
444
445 inline Bitboard Position::bishops_and_queens() const {
446   return bishops() | queens();
447 }
448
449 inline Bitboard Position::sliders() const {
450   return bishops() | queens() | rooks();
451 }
452
453 inline Bitboard Position::pawns(Color c) const {
454   return pieces_of_color_and_type(c, PAWN);
455 }
456
457 inline Bitboard Position::knights(Color c) const {
458   return pieces_of_color_and_type(c, KNIGHT);
459 }
460
461 inline Bitboard Position::bishops(Color c) const {
462   return pieces_of_color_and_type(c, BISHOP);
463 }
464
465 inline Bitboard Position::rooks(Color c) const {
466   return pieces_of_color_and_type(c, ROOK);
467 }
468
469 inline Bitboard Position::queens(Color c) const {
470   return pieces_of_color_and_type(c, QUEEN);
471 }
472
473 inline Bitboard Position::kings(Color c) const {
474   return pieces_of_color_and_type(c, KING);
475 }
476
477 inline Bitboard Position::rooks_and_queens(Color c) const {
478   return rooks_and_queens() & pieces_of_color(c);
479 }
480
481 inline Bitboard Position::bishops_and_queens(Color c) const {
482   return bishops_and_queens() & pieces_of_color(c);
483 }
484
485 inline Bitboard Position::sliders_of_color(Color c) const {
486   return sliders() & pieces_of_color(c);
487 }
488
489 inline int Position::piece_count(Color c, PieceType pt) const {
490   return pieceCount[c][pt];
491 }
492
493 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
494   return pieceList[c][pt][index];
495 }
496
497 inline Square Position::ep_square() const {
498   return st->epSquare;
499 }
500
501 inline Square Position::king_square(Color c) const {
502   return kingSquare[c];
503 }
504
505 inline bool Position::can_castle_kingside(Color side) const {
506   return st->castleRights & (1+int(side));
507 }
508
509 inline bool Position::can_castle_queenside(Color side) const {
510   return st->castleRights & (4+4*int(side));
511 }
512
513 inline bool Position::can_castle(Color side) const {
514   return can_castle_kingside(side) || can_castle_queenside(side);
515 }
516
517 inline Square Position::initial_kr_square(Color c) const {
518   return relative_square(c, make_square(initialKRFile, RANK_1));
519 }
520
521 inline Square Position::initial_qr_square(Color c) const {
522   return relative_square(c, make_square(initialQRFile, RANK_1));
523 }
524
525 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
526   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
527 }
528
529 template<>
530 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
531   return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
532 }
533
534 template<>
535 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
536   return StepAttackBB[KNIGHT][s];
537 }
538
539 template<>
540 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
541   return bishop_attacks_bb(s, occupied_squares());
542 }
543
544 template<>
545 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
546   return rook_attacks_bb(s, occupied_squares());
547 }
548
549 template<>
550 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
551   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
552 }
553
554 template<>
555 inline Bitboard Position::piece_attacks<KING>(Square s) const {
556   return StepAttackBB[KING][s];
557 }
558
559 inline Bitboard Position::checkers() const {
560   return st->checkersBB;
561 }
562
563 inline bool Position::is_check() const {
564   return st->checkersBB != EmptyBoardBB;
565 }
566
567 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
568   return bit_is_set(pawn_attacks(c, f), t);
569 }
570
571 template<PieceType Piece>
572 Bitboard Position::piece_attacks_square(Square f, Square t) const {
573   return bit_is_set(piece_attacks<Piece>(f), t);
574 }
575
576 inline Bitboard Position::attacks_to(Square s, Color c) const {
577
578   return attacks_to(s) & pieces_of_color(c);
579 }
580
581 inline bool Position::square_is_attacked(Square s, Color c) const {
582
583   return attacks_to(s, c) != EmptyBoardBB;
584 }
585
586 inline bool Position::pawn_is_passed(Color c, Square s) const {
587   return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
588 }
589
590 inline bool Position::pawn_is_isolated(Color c, Square s) const {
591   return !(pawns(c) & neighboring_files_bb(s));
592 }
593
594 inline bool Position::pawn_is_doubled(Color c, Square s) const {
595   return pawns(c) & squares_behind(c, s);
596 }
597
598 inline bool Position::file_is_open(File f) const {
599   return !(pawns() & file_bb(f));
600 }
601
602 inline bool Position::file_is_half_open(Color c, File f) const {
603   return !(pawns(c) & file_bb(f));
604 }
605
606 inline bool Position::square_is_weak(Square s, Color c) const {
607   return !(pawns(c) & outpost_mask(opposite_color(c), s));
608 }
609
610 inline Key Position::get_key() const {
611   return st->key;
612 }
613
614 inline Key Position::get_pawn_key() const {
615   return st->pawnKey;
616 }
617
618 inline Key Position::get_material_key() const {
619   return st->materialKey;
620 }
621
622 template<Position::GamePhase Phase>
623 inline Value Position::pst(Color c, PieceType pt, Square s) const {
624   return (Phase == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
625                            : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
626 }
627
628 inline Value Position::mg_pst_delta(Move m) const {
629   return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
630         -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
631 }
632
633 inline Value Position::mg_value() const {
634   return st->mgValue;
635 }
636
637 inline Value Position::eg_value() const {
638   return st->egValue;
639 }
640
641 inline Value Position::non_pawn_material(Color c) const {
642   return npMaterial[c];
643 }
644
645 inline Phase Position::game_phase() const {
646
647   // The purpose of the Value(325) terms below is to make sure the difference
648   // between MidgameLimit and EndgameLimit is a power of 2, which should make
649   // the division at the end of the function a bit faster.
650   static const Value MidgameLimit =  2 * QueenValueMidgame
651                                    + 2 * RookValueMidgame
652                                    + 6 * BishopValueMidgame
653                                    + Value(325);
654
655   static const Value EndgameLimit = 4 * RookValueMidgame - Value(325);
656
657   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
658
659   if (npm >= MidgameLimit)
660       return PHASE_MIDGAME;
661   else if(npm <= EndgameLimit)
662       return PHASE_ENDGAME;
663   else
664       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
665 }
666
667 inline bool Position::move_is_deep_pawn_push(Move m) const {
668
669   Color c = side_to_move();
670   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
671         && relative_rank(c, move_to(m)) > RANK_4;
672 }
673
674 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
675
676   Color c = side_to_move();
677   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
678         && relative_rank(c, move_to(m)) == RANK_7;
679 }
680
681 inline bool Position::move_is_passed_pawn_push(Move m) const {
682
683   Color c = side_to_move();
684   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
685         && pawn_is_passed(c, move_to(m));
686 }
687
688 inline bool Position::move_was_passed_pawn_push(Move m) const {
689
690   Color c = opposite_color(side_to_move());
691   return   piece_on(move_to(m)) == piece_of_color_and_type(c, PAWN)
692         && pawn_is_passed(c, move_to(m));
693 }
694
695 inline int Position::rule_50_counter() const {
696
697   return st->rule50;
698 }
699
700 inline bool Position::opposite_colored_bishops() const {
701
702   return   piece_count(WHITE, BISHOP) == 1
703         && piece_count(BLACK, BISHOP) == 1
704         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
705 }
706
707 inline bool Position::has_pawn_on_7th(Color c) const {
708
709   return pawns(c) & relative_rank_bb(c, RANK_7);
710 }
711
712
713 #endif // !defined(POSITION_H_INCLUDED)