4dcbbf76ec80b24531fe414820fb7fe0781f8dc4
[stockfish] / src / position.h
1 /*
2   Glaurung, a UCI chess playing engine.
3   Copyright (C) 2004-2008 Tord Romstad
4
5   Glaurung is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9   
10   Glaurung is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14   
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19
20 #if !defined(POSITION_H_INCLUDED)
21 #define POSITION_H_INCLUDED
22
23 // Disable a silly and noisy warning from MSVC compiler
24 #if defined(_MSC_VER)
25
26 // Forcing value to bool 'true' or 'false' (performance warning)
27 #pragma warning(disable: 4800) \r
28 \r
29 #endif
30
31 ////
32 //// Includes
33 ////
34
35 #include "bitboard.h"
36 #include "color.h"
37 #include "direction.h"
38 #include "move.h"
39 #include "piece.h"
40 #include "phase.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
75 /// The UndoInfo struct stores information we need to restore a Position
76 /// object to its previous state when we retract a move.  Whenever a move
77 /// is made on the board (by calling Position::do_move), an UndoInfo object
78 /// must be passed as a parameter.  When the move is unmade (by calling
79 /// Position::undo_move), the same UndoInfo object must be passed again.
80
81 struct UndoInfo {
82   int castleRights;
83   Square epSquare;
84   Bitboard checkersBB;
85   Key key, pawnKey, materialKey;
86   int rule50;
87   Move lastMove;
88   PieceType capture;
89   Value mgValue, egValue;
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
120 public:
121   // Constructors
122   Position() {};
123   Position(const Position &pos);
124   Position(const std::string &fen);
125
126   // Text input/output
127   void from_fen(const std::string &fen);
128   const std::string to_fen() const;
129   void print() const;
130
131   // Copying
132   void copy(const Position &pos);
133   void flipped_copy(const Position &pos);
134
135   // The piece on a given square
136   Piece piece_on(Square s) const;
137   PieceType type_of_piece_on(Square s) const;
138   Color color_of_piece_on(Square s) const;
139   bool square_is_empty(Square s) const;
140   bool square_is_occupied(Square s) const;
141   Value midgame_value_of_piece_on(Square s) const;
142   Value endgame_value_of_piece_on(Square s) const;
143
144   // Side to move
145   Color side_to_move() const;
146
147   // Bitboard representation of the position
148   Bitboard empty_squares() const;
149   Bitboard occupied_squares() const;
150   Bitboard pieces_of_color(Color c) const;
151   Bitboard pieces_of_type(PieceType pt) const;
152   Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
153   Bitboard pawns() const;
154   Bitboard knights() const;
155   Bitboard bishops() const;
156   Bitboard rooks() const;
157   Bitboard queens() const;
158   Bitboard kings() const;
159   Bitboard rooks_and_queens() const;
160   Bitboard bishops_and_queens() const;
161   Bitboard sliders() const;
162   Bitboard pawns(Color c) const;
163   Bitboard knights(Color c) const;
164   Bitboard bishops(Color c) const;
165   Bitboard rooks(Color c) const;
166   Bitboard queens(Color c) const;
167   Bitboard kings(Color c) const;
168   Bitboard rooks_and_queens(Color c) const;
169   Bitboard bishops_and_queens(Color c) const;
170   Bitboard sliders_of_color(Color c) const;
171
172   // Number of pieces of each color and type
173   int piece_count(Color c, PieceType pt) const;
174   int pawn_count(Color c) const;
175   int knight_count(Color c) const;
176   int bishop_count(Color c) const;
177   int rook_count(Color c) const;
178   int queen_count(Color c) const;
179
180   // The en passant square:
181   Square ep_square() const;
182
183   // Current king position for each color
184   Square king_square(Color c) const;
185
186   // Castling rights.
187   bool can_castle_kingside(Color c) const;
188   bool can_castle_queenside(Color c) const;
189   bool can_castle(Color c) const;
190   Square initial_kr_square(Color c) const;
191   Square initial_qr_square(Color c) const;
192
193   // Attack bitboards
194   Bitboard sliding_attacks(Square s, Direction d) const;
195   Bitboard ray_attacks(Square s, SignedDirection d) const;
196   Bitboard pawn_attacks(Color c, Square s) const;
197
198   template<PieceType>
199   Bitboard piece_attacks(Square s) const;
200
201   // Bitboards for pinned pieces and discovered check candidates
202   Bitboard discovered_check_candidates(Color c) const;
203   Bitboard pinned_pieces(Color c) const;
204
205   // Checking pieces
206   Bitboard checkers() const;
207
208   // Piece lists
209   Square piece_list(Color c, PieceType pt, int index) const;
210
211   // Attack information for a given square
212   bool square_is_attacked(Square s, Color c) const;
213   Bitboard attacks_to(Square s) const;
214   Bitboard attacks_to(Square s, Color c) const;
215   bool is_check() const;
216   bool white_pawn_attacks_square(Square f, Square t) const;
217   bool black_pawn_attacks_square(Square f, Square t) const;
218
219   template<PieceType>
220   Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
221
222   bool piece_attacks_square(Square f, Square t) const; // Dispatch at run-time
223
224   // Properties of moves
225   bool move_is_legal(Move m) const;
226   bool move_is_legal(Move m, Bitboard pinned) const;
227   bool move_is_check(Move m) const;
228   bool move_is_check(Move m, Bitboard dcCandidates) const;
229   bool move_is_capture(Move m) const;
230   bool move_is_deep_pawn_push(Move m) const;
231   bool move_is_pawn_push_to_7th(Move m) const;
232   bool move_is_passed_pawn_push(Move m) const;
233   bool move_was_passed_pawn_push(Move m) const;
234   bool move_attacks_square(Move m, Square s) const;
235
236   // Information about pawns
237   bool pawn_is_passed(Color c, Square s) const;
238   bool pawn_is_isolated(Color c, Square s) const;
239   bool pawn_is_doubled(Color c, Square s) const;
240
241   // Open and half-open files
242   bool file_is_open(File f) const;
243   bool file_is_half_open(Color c, File f) const;
244
245   // Weak squares
246   bool square_is_weak(Square s, Color c) const;
247
248   // Doing and undoing moves
249   void backup(UndoInfo &u) const;
250   void restore(const UndoInfo &u);
251   void do_move(Move m, UndoInfo &u);
252   void do_move(Move m, UndoInfo &u, Bitboard dcCandidates);
253   void undo_move(Move m, const UndoInfo &u);
254   void do_null_move(UndoInfo &u);
255   void undo_null_move(const UndoInfo &u);
256
257   // Static exchange evaluation
258   int see(Square from, Square to) const;
259   int see(Move m) const;
260
261   // Accessing hash keys
262   Key get_key() const;
263   Key get_pawn_key() const;
264   Key get_material_key() const;
265
266   // Incremental evaluation
267   Value mg_value() const;
268   Value eg_value() const;
269   Value non_pawn_material(Color c) const;
270   Phase game_phase() const;
271   Value mg_pst_delta(Move m) const;
272
273   // Game termination checks
274   bool is_mate();
275   bool is_draw() const;
276
277   // Check if one side threatens a mate in one
278   bool has_mate_threat(Color c);
279
280   // Number of plies since the last non-reversible move
281   int rule_50_counter() const;
282
283   // Other properties of the position
284   bool opposite_colored_bishops() const;
285   bool has_pawn_on_7th(Color c) const;
286
287   // Reset the gamePly variable to 0
288   void reset_game_ply();
289   
290   // Position consistency check, for debugging
291   bool is_ok(int* failedStep = NULL) const;
292
293   // Static member functions:
294   static void init_zobrist();
295   static void init_piece_square_tables();
296
297 private:
298   // Initialization helper functions (used while setting up a position)
299   void clear();
300   void put_piece(Piece p, Square s);
301   void allow_oo(Color c);
302   void allow_ooo(Color c);
303
304   // Helper functions for doing and undoing moves
305   void do_castle_move(Move m);
306   void do_promotion_move(Move m, UndoInfo &u);
307   void do_ep_move(Move m);
308   void undo_castle_move(Move m);
309   void undo_promotion_move(Move m, const UndoInfo &u);
310   void undo_ep_move(Move m);
311   void find_checkers();
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   Value mg_pst(Color c, PieceType pt, Square s) const;
320   Value eg_pst(Color c, PieceType pt, Square s) const;
321   Value compute_mg_value() const;
322   Value compute_eg_value() const;
323   Value compute_non_pawn_material(Color c) const;
324
325   // Bitboards
326   Bitboard byColorBB[2], byTypeBB[8];
327   Bitboard checkersBB;
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   Color sideToMove;
341   int castleRights;
342   File initialKFile, initialKRFile, initialQRFile;
343   Square epSquare;
344   Square kingSquare[2];
345   Move lastMove;
346   Key key, pawnKey, materialKey, history[MaxGameLength];
347   int rule50, gamePly;
348   Value mgValue, egValue;
349   Value npMaterial[2];
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 int Position::pawn_count(Color c) const {
496   return piece_count(c, PAWN);
497 }
498
499 inline int Position::knight_count(Color c) const {
500   return piece_count(c, KNIGHT);
501 }
502
503 inline int Position::bishop_count(Color c) const {
504   return piece_count(c, BISHOP);
505 }
506
507 inline int Position::rook_count(Color c) const {
508   return piece_count(c, ROOK);
509 }
510
511 inline int Position::queen_count(Color c) const {
512   return piece_count(c, QUEEN);
513 }
514
515 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
516   return pieceList[c][pt][index];
517 }
518
519 inline Square Position::ep_square() const {
520   return epSquare;
521 }
522
523 inline Square Position::king_square(Color c) const {
524   return kingSquare[c];
525 }
526
527 inline bool Position::can_castle_kingside(Color side) const {
528   return castleRights & (1+int(side));
529 }
530
531 inline bool Position::can_castle_queenside(Color side) const {
532   return castleRights & (4+4*int(side));
533 }
534
535 inline bool Position::can_castle(Color side) const {
536   return can_castle_kingside(side) || can_castle_queenside(side);
537 }
538
539 inline Square Position::initial_kr_square(Color c) const {
540   return relative_square(c, make_square(initialKRFile, RANK_1));
541 }
542
543 inline Square Position::initial_qr_square(Color c) const {
544   return relative_square(c, make_square(initialQRFile, RANK_1));
545 }
546
547 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
548   return StepAttackBB[pawn_of_color(c)][s];
549 }
550
551 template<>
552 inline Bitboard Position::piece_attacks<KNIGHT>(Square s) const {
553   return StepAttackBB[KNIGHT][s];
554 }
555
556 template<>
557 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
558   return bishop_attacks_bb(s, occupied_squares());
559 }
560
561 template<>
562 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
563   return rook_attacks_bb(s, occupied_squares());
564 }
565
566 template<>
567 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
568   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
569 }
570
571 template<>
572 inline Bitboard Position::piece_attacks<KING>(Square s) const {
573   return StepAttackBB[KING][s];
574 }
575
576 inline Bitboard Position::checkers() const {
577   return checkersBB;
578 }
579
580 inline bool Position::is_check() const {
581   return checkers() != EmptyBoardBB;
582 }
583
584 inline bool Position::white_pawn_attacks_square(Square f, Square t) const {
585   return bit_is_set(pawn_attacks(WHITE, f), t);
586 }
587
588 inline bool Position::black_pawn_attacks_square(Square f, Square t) const {
589   return bit_is_set(pawn_attacks(BLACK, f), t);
590 }
591
592 template<PieceType Piece>
593 Bitboard Position::piece_attacks_square(Square f, Square t) const {
594   return bit_is_set(piece_attacks<Piece>(f), t);
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 key;
623 }
624
625 inline Key Position::get_pawn_key() const {
626   return pawnKey;
627 }
628
629 inline Key Position::get_material_key() const {
630   return materialKey;
631 }
632
633 inline Value Position::mg_pst(Color c, PieceType pt, Square s) const {
634   return MgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
635 }
636
637 inline Value Position::mg_pst_delta(Move m) const {
638   return MgPieceSquareTable[piece_on(move_from(m))][move_to(m)]
639         -MgPieceSquareTable[piece_on(move_from(m))][move_from(m)];
640 }
641
642 inline Value Position::eg_pst(Color c, PieceType pt, Square s) const {
643   return EgPieceSquareTable[piece_of_color_and_type(c, pt)][s];
644 }
645
646 inline Value Position::mg_value() const {
647   return mgValue;
648 }
649
650 inline Value Position::eg_value() const {
651   return egValue;
652 }
653
654 inline Value Position::non_pawn_material(Color c) const {
655   return npMaterial[c];
656 }
657
658 inline Phase Position::game_phase() const {
659
660   // The purpose of the Value(325) terms below is to make sure the difference
661   // between MidgameLimit and EndgameLimit is a power of 2, which should make
662   // the division at the end of the function a bit faster.
663   static const Value MidgameLimit =  2 * QueenValueMidgame
664                                    + 2 * RookValueMidgame
665                                    + 6 * BishopValueMidgame
666                                    + Value(325);
667
668   static const Value EndgameLimit = 4 * RookValueMidgame - Value(325);
669
670   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
671   
672   if (npm >= MidgameLimit)
673       return PHASE_MIDGAME;
674   else if(npm <= EndgameLimit)
675       return PHASE_ENDGAME;
676   else
677       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
678 }
679
680 inline bool Position::move_is_deep_pawn_push(Move m) const {
681
682   Color c = side_to_move();
683   return   piece_on(move_from(m)) == pawn_of_color(c)
684         && relative_rank(c, move_to(m)) > RANK_4;
685 }
686
687 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
688
689   Color c = side_to_move();
690   return   piece_on(move_from(m)) == pawn_of_color(c)
691         && relative_rank(c, move_to(m)) == RANK_7;
692 }
693
694 inline bool Position::move_is_passed_pawn_push(Move m) const {
695
696   Color c = side_to_move();
697   return   piece_on(move_from(m)) == pawn_of_color(c)
698         && pawn_is_passed(c, move_to(m));
699 }
700
701 inline bool Position::move_was_passed_pawn_push(Move m) const {
702
703   Color c = opposite_color(side_to_move());
704   return   piece_on(move_to(m)) == pawn_of_color(c)
705         && pawn_is_passed(c, move_to(m));
706 }
707
708 inline int Position::rule_50_counter() const {
709
710   return rule50;
711 }
712
713 inline bool Position::opposite_colored_bishops() const {
714
715   return   bishop_count(WHITE) == 1
716         && bishop_count(BLACK) == 1        
717         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
718 }
719
720 inline bool Position::has_pawn_on_7th(Color c) const {
721
722   return pawns(c) & relative_rank_bb(c, RANK_7);
723 }
724                    
725
726 #endif // !defined(POSITION_H_INCLUDED)