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