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