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