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