Retire seeValues[] and move PieceValue[] out of Position
[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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
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 #if !defined(POSITION_H_INCLUDED)
21 #define POSITION_H_INCLUDED
22
23 #include <cassert>
24
25 #include "bitboard.h"
26 #include "move.h"
27 #include "types.h"
28
29 /// Maximum number of plies per game (220 should be enough, because the
30 /// maximum search depth is 100, and during position setup we reset the
31 /// move counter for every non-reversible move).
32 const int MaxGameLength = 220;
33
34 class Position;
35
36 /// struct checkInfo is initialized at c'tor time and keeps
37 /// info used to detect if a move gives check.
38
39 struct CheckInfo {
40
41     explicit CheckInfo(const Position&);
42
43     Bitboard dcCandidates;
44     Bitboard pinned;
45     Bitboard checkSq[8];
46 };
47
48 /// Castle rights, encoded as bit fields
49
50 enum CastleRights {
51   CASTLES_NONE = 0,
52   WHITE_OO     = 1,
53   BLACK_OO     = 2,
54   WHITE_OOO    = 4,
55   BLACK_OOO    = 8,
56   ALL_CASTLES  = 15
57 };
58
59 /// Game phase
60 enum Phase {
61   PHASE_ENDGAME = 0,
62   PHASE_MIDGAME = 128
63 };
64
65
66 /// The StateInfo struct stores information we need to restore a Position
67 /// object to its previous state when we retract a move. Whenever a move
68 /// is made on the board (by calling Position::do_move), an StateInfo object
69 /// must be passed as a parameter.
70
71 struct StateInfo {
72   Key pawnKey, materialKey;
73   int castleRights, rule50, gamePly, pliesFromNull;
74   Square epSquare;
75   Score value;
76   Value npMaterial[2];
77
78   PieceType capturedType;
79   Key key;
80   Bitboard checkersBB;
81   StateInfo* previous;
82 };
83
84
85 /// The position data structure. A position consists of the following data:
86 ///
87 ///    * For each piece type, a bitboard representing the squares occupied
88 ///      by pieces of that type.
89 ///    * For each color, a bitboard representing the squares occupied by
90 ///      pieces of that color.
91 ///    * A bitboard of all occupied squares.
92 ///    * A bitboard of all checking pieces.
93 ///    * A 64-entry array of pieces, indexed by the squares of the board.
94 ///    * The current side to move.
95 ///    * Information about the castling rights for both sides.
96 ///    * The initial files of the kings and both pairs of rooks. This is
97 ///      used to implement the Chess960 castling rules.
98 ///    * The en passant square (which is SQ_NONE if no en passant capture is
99 ///      possible).
100 ///    * The squares of the kings for both sides.
101 ///    * Hash keys for the position itself, the current pawn structure, and
102 ///      the current material situation.
103 ///    * Hash keys for all previous positions in the game for detecting
104 ///      repetition draws.
105 ///    * A counter for detecting 50 move rule draws.
106
107 class Position {
108
109   Position(); // No default or copy c'tor allowed
110   Position(const Position& pos);
111
112 public:
113   enum GamePhase {
114       MidGame,
115       EndGame
116   };
117
118   // Constructors
119   Position(const Position& pos, int threadID);
120   Position(const std::string& fen, bool isChess960, int threadID);
121
122   // Text input/output
123   void from_fen(const std::string& fen, bool isChess960);
124   const std::string to_fen() const;
125   void print(Move m = MOVE_NONE) const;
126
127   // Copying
128   void flip();
129
130   // The piece on a given square
131   Piece piece_on(Square s) const;
132   PieceType type_of_piece_on(Square s) const;
133   Color color_of_piece_on(Square s) const;
134   bool square_is_empty(Square s) const;
135   bool square_is_occupied(Square s) const;
136
137   // Side to move
138   Color side_to_move() const;
139
140   // Bitboard representation of the position
141   Bitboard empty_squares() const;
142   Bitboard occupied_squares() const;
143   Bitboard pieces_of_color(Color c) const;
144   Bitboard pieces(PieceType pt) const;
145   Bitboard pieces(PieceType pt, Color c) const;
146   Bitboard pieces(PieceType pt1, PieceType pt2) const;
147   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
148
149   // Number of pieces of each color and type
150   int piece_count(Color c, PieceType pt) const;
151
152   // The en passant square
153   Square ep_square() const;
154
155   // Current king position for each color
156   Square king_square(Color c) const;
157
158   // Castling rights
159   bool can_castle_kingside(Color c) const;
160   bool can_castle_queenside(Color c) const;
161   bool can_castle(Color c) const;
162   Square initial_kr_square(Color c) const;
163   Square initial_qr_square(Color c) const;
164
165   // Bitboards for pinned pieces and discovered check candidates
166   Bitboard discovered_check_candidates(Color c) const;
167   Bitboard pinned_pieces(Color c) const;
168
169   // Checking pieces and under check information
170   Bitboard checkers() const;
171   bool in_check() const;
172
173   // Piece lists
174   Square piece_list(Color c, PieceType pt, int index) const;
175   const Square* piece_list_begin(Color c, PieceType pt) const;
176
177   // Information about attacks to or from a given square
178   Bitboard attackers_to(Square s) const;
179   Bitboard attackers_to(Square s, Bitboard occ) const;
180   Bitboard attacks_from(Piece p, Square s) const;
181   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
182   template<PieceType> Bitboard attacks_from(Square s) const;
183   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
184
185   // Properties of moves
186   bool pl_move_is_legal(Move m, Bitboard pinned) const;
187   bool move_is_pl(const Move m) const;
188   bool move_gives_check(Move m, const CheckInfo& ci) const;
189   bool move_is_capture(Move m) const;
190   bool move_is_capture_or_promotion(Move m) const;
191   bool move_is_passed_pawn_push(Move m) const;
192   bool move_attacks_square(Move m, Square s) const;
193
194   // Piece captured with previous moves
195   PieceType captured_piece_type() const;
196
197   // Information about pawns
198   bool pawn_is_passed(Color c, Square s) const;
199
200   // Weak squares
201   bool square_is_weak(Square s, Color c) const;
202
203   // Doing and undoing moves
204   void do_setup_move(Move m);
205   void do_move(Move m, StateInfo& st);
206   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
207   void undo_move(Move m);
208   void do_null_move(StateInfo& st);
209   void undo_null_move();
210
211   // Static exchange evaluation
212   int see(Move m) const;
213   int see_sign(Move m) const;
214
215   // Accessing hash keys
216   Key get_key() const;
217   Key get_exclusion_key() const;
218   Key get_pawn_key() const;
219   Key get_material_key() const;
220
221   // Incremental evaluation
222   Score value() const;
223   Value non_pawn_material(Color c) const;
224   static Score pst_delta(Piece piece, Square from, Square to);
225
226   // Game termination checks
227   bool is_mate() const;
228   template<bool SkipRepetition> bool is_draw() const;
229
230   // Number of plies from starting position
231   int startpos_ply_counter() const;
232
233   // Other properties of the position
234   bool opposite_colored_bishops() const;
235   bool has_pawn_on_7th(Color c) const;
236   bool is_chess960() const;
237
238   // Current thread ID searching on the position
239   int thread() const;
240
241   int64_t nodes_searched() const;
242   void set_nodes_searched(int64_t n);
243
244   // Position consistency check, for debugging
245   bool is_ok(int* failedStep = NULL) const;
246
247   // Global initialization
248   static void init();
249
250 private:
251
252   // Initialization helper functions (used while setting up a position)
253   void clear();
254   void detach();
255   void put_piece(Piece p, Square s);
256   void set_castle_kingside(Color c);
257   void set_castle_queenside(Color c);
258   bool set_castling_rights(char token);
259   bool move_is_pl_slow(const Move m) const;
260
261   // Helper functions for doing and undoing moves
262   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
263   void do_castle_move(Move m);
264   void undo_castle_move(Move m);
265   void find_checkers();
266
267   template<bool FindPinned>
268   Bitboard hidden_checkers(Color c) const;
269
270   // Computing hash keys from scratch (for initialization and debugging)
271   Key compute_key() const;
272   Key compute_pawn_key() const;
273   Key compute_material_key() const;
274
275   // Computing incremental evaluation scores and material counts
276   static Score pst(Color c, PieceType pt, Square s);
277   Score compute_value() const;
278   Value compute_non_pawn_material(Color c) const;
279
280   // Board
281   Piece board[64];
282
283   // Bitboards
284   Bitboard byTypeBB[8], byColorBB[2];
285
286   // Piece counts
287   int pieceCount[2][8]; // [color][pieceType]
288
289   // Piece lists
290   Square pieceList[2][8][16]; // [color][pieceType][index]
291   int index[64]; // [square]
292
293   // Other info
294   Color sideToMove;
295   Key history[MaxGameLength];
296   int castleRightsMask[64];
297   StateInfo startState;
298   File initialKFile, initialKRFile, initialQRFile;
299   bool chess960;
300   int startPosPlyCounter;
301   int threadID;
302   int64_t nodes;
303   StateInfo* st;
304
305   // Static variables
306   static Key zobrist[2][8][64];
307   static Key zobEp[64];
308   static Key zobCastle[16];
309   static Key zobSideToMove;
310   static Score PieceSquareTable[16][64];
311   static Key zobExclusion;
312 };
313
314 inline int64_t Position::nodes_searched() const {
315   return nodes;
316 }
317
318 inline void Position::set_nodes_searched(int64_t n) {
319   nodes = n;
320 }
321
322 inline Piece Position::piece_on(Square s) const {
323   return board[s];
324 }
325
326 inline Color Position::color_of_piece_on(Square s) const {
327   return color_of_piece(piece_on(s));
328 }
329
330 inline PieceType Position::type_of_piece_on(Square s) const {
331   return type_of_piece(piece_on(s));
332 }
333
334 inline bool Position::square_is_empty(Square s) const {
335   return piece_on(s) == PIECE_NONE;
336 }
337
338 inline bool Position::square_is_occupied(Square s) const {
339   return !square_is_empty(s);
340 }
341
342 inline Color Position::side_to_move() const {
343   return sideToMove;
344 }
345
346 inline Bitboard Position::occupied_squares() const {
347   return byTypeBB[0];
348 }
349
350 inline Bitboard Position::empty_squares() const {
351   return ~occupied_squares();
352 }
353
354 inline Bitboard Position::pieces_of_color(Color c) const {
355   return byColorBB[c];
356 }
357
358 inline Bitboard Position::pieces(PieceType pt) const {
359   return byTypeBB[pt];
360 }
361
362 inline Bitboard Position::pieces(PieceType pt, Color c) const {
363   return byTypeBB[pt] & byColorBB[c];
364 }
365
366 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
367   return byTypeBB[pt1] | byTypeBB[pt2];
368 }
369
370 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
371   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
372 }
373
374 inline int Position::piece_count(Color c, PieceType pt) const {
375   return pieceCount[c][pt];
376 }
377
378 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
379   return pieceList[c][pt][idx];
380 }
381
382 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
383   return pieceList[c][pt];
384 }
385
386 inline Square Position::ep_square() const {
387   return st->epSquare;
388 }
389
390 inline Square Position::king_square(Color c) const {
391   return pieceList[c][KING][0];
392 }
393
394 inline bool Position::can_castle_kingside(Color c) const {
395   return st->castleRights & (WHITE_OO << c);
396 }
397
398 inline bool Position::can_castle_queenside(Color c) const {
399   return st->castleRights & (WHITE_OOO << c);
400 }
401
402 inline bool Position::can_castle(Color c) const {
403   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
404 }
405
406 inline void Position::set_castle_kingside(Color c) {
407   st->castleRights |= (WHITE_OO << c);
408 }
409
410 inline void Position::set_castle_queenside(Color c) {
411   st->castleRights |= (WHITE_OOO << c);
412 }
413
414 inline Square Position::initial_kr_square(Color c) const {
415   return relative_square(c, make_square(initialKRFile, RANK_1));
416 }
417
418 inline Square Position::initial_qr_square(Color c) const {
419   return relative_square(c, make_square(initialQRFile, RANK_1));
420 }
421
422 template<>
423 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
424   return StepAttacksBB[make_piece(c, PAWN)][s];
425 }
426
427 template<PieceType Piece> // Knight and King and white pawns
428 inline Bitboard Position::attacks_from(Square s) const {
429   return StepAttacksBB[Piece][s];
430 }
431
432 template<>
433 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
434   return bishop_attacks_bb(s, occupied_squares());
435 }
436
437 template<>
438 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
439   return rook_attacks_bb(s, occupied_squares());
440 }
441
442 template<>
443 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
444   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
445 }
446
447 inline Bitboard Position::checkers() const {
448   return st->checkersBB;
449 }
450
451 inline bool Position::in_check() const {
452   return st->checkersBB != EmptyBoardBB;
453 }
454
455 inline bool Position::pawn_is_passed(Color c, Square s) const {
456   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
457 }
458
459 inline bool Position::square_is_weak(Square s, Color c) const {
460   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
461 }
462
463 inline Key Position::get_key() const {
464   return st->key;
465 }
466
467 inline Key Position::get_exclusion_key() const {
468   return st->key ^ zobExclusion;
469 }
470
471 inline Key Position::get_pawn_key() const {
472   return st->pawnKey;
473 }
474
475 inline Key Position::get_material_key() const {
476   return st->materialKey;
477 }
478
479 inline Score Position::pst(Color c, PieceType pt, Square s) {
480   return PieceSquareTable[make_piece(c, pt)][s];
481 }
482
483 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
484   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
485 }
486
487 inline Score Position::value() const {
488   return st->value;
489 }
490
491 inline Value Position::non_pawn_material(Color c) const {
492   return st->npMaterial[c];
493 }
494
495 inline bool Position::move_is_passed_pawn_push(Move m) const {
496
497   Color c = side_to_move();
498   return   piece_on(move_from(m)) == make_piece(c, PAWN)
499         && pawn_is_passed(c, move_to(m));
500 }
501
502 inline int Position::startpos_ply_counter() const {
503   return startPosPlyCounter;
504 }
505
506 inline bool Position::opposite_colored_bishops() const {
507
508   return   piece_count(WHITE, BISHOP) == 1 && piece_count(BLACK, BISHOP) == 1
509         && opposite_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
510 }
511
512 inline bool Position::has_pawn_on_7th(Color c) const {
513   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
514 }
515
516 inline bool Position::is_chess960() const {
517   return chess960;
518 }
519
520 inline bool Position::move_is_capture_or_promotion(Move m) const {
521
522   assert(m != MOVE_NONE && m != MOVE_NULL);
523   return move_is_special(m) ? !move_is_castle(m) : !square_is_empty(move_to(m));
524 }
525
526 inline bool Position::move_is_capture(Move m) const {
527
528   assert(m != MOVE_NONE && m != MOVE_NULL);
529
530   // Note that castle is coded as "king captures the rook"
531   return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
532 }
533
534 inline PieceType Position::captured_piece_type() const {
535   return st->capturedType;
536 }
537
538 inline int Position::thread() const {
539   return threadID;
540 }
541
542 #endif // !defined(POSITION_H_INCLUDED)