Big renaming of move's helpers
[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-2012 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 "types.h"
27
28
29 /// The checkInfo struct is initialized at c'tor time and keeps info used
30 /// to detect if a move gives check.
31 class Position;
32
33 struct CheckInfo {
34
35   explicit CheckInfo(const Position&);
36
37   Bitboard dcCandidates;
38   Bitboard pinned;
39   Bitboard checkSq[8];
40 };
41
42
43 /// The StateInfo struct stores information we need to restore a Position
44 /// object to its previous state when we retract a move. Whenever a move
45 /// is made on the board (by calling Position::do_move), an StateInfo object
46 /// must be passed as a parameter.
47
48 struct StateInfo {
49   Key pawnKey, materialKey;
50   Value npMaterial[2];
51   int castleRights, rule50, pliesFromNull;
52   Score value;
53   Square epSquare;
54
55   Key key;
56   Bitboard checkersBB;
57   PieceType capturedType;
58   StateInfo* previous;
59 };
60
61
62 /// The position data structure. A position consists of the following data:
63 ///
64 ///    * For each piece type, a bitboard representing the squares occupied
65 ///      by pieces of that type.
66 ///    * For each color, a bitboard representing the squares occupied by
67 ///      pieces of that color.
68 ///    * A bitboard of all occupied squares.
69 ///    * A bitboard of all checking pieces.
70 ///    * A 64-entry array of pieces, indexed by the squares of the board.
71 ///    * The current side to move.
72 ///    * Information about the castling rights for both sides.
73 ///    * The initial files of the kings and both pairs of rooks. This is
74 ///      used to implement the Chess960 castling rules.
75 ///    * The en passant square (which is SQ_NONE if no en passant capture is
76 ///      possible).
77 ///    * The squares of the kings for both sides.
78 ///    * Hash keys for the position itself, the current pawn structure, and
79 ///      the current material situation.
80 ///    * Hash keys for all previous positions in the game for detecting
81 ///      repetition draws.
82 ///    * A counter for detecting 50 move rule draws.
83
84 class Position {
85
86   // No copy c'tor or assignment operator allowed
87   Position(const Position&);
88   Position& operator=(const Position&);
89
90 public:
91   Position() {}
92   Position(const Position& pos, int th) { copy(pos, th); }
93   Position(const std::string& fen, bool isChess960, int th);
94
95   // Text input/output
96   void copy(const Position& pos, int th);
97   void from_fen(const std::string& fen, bool isChess960);
98   const std::string to_fen() const;
99   void print(Move m = MOVE_NONE) const;
100
101   // The piece on a given square
102   Piece piece_on(Square s) const;
103   bool square_is_empty(Square s) const;
104
105   // Side to move
106   Color side_to_move() const;
107
108   // Bitboard representation of the position
109   Bitboard empty_squares() const;
110   Bitboard occupied_squares() const;
111   Bitboard pieces(Color c) const;
112   Bitboard pieces(PieceType pt) const;
113   Bitboard pieces(PieceType pt, Color c) const;
114   Bitboard pieces(PieceType pt1, PieceType pt2) const;
115   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
116
117   // Number of pieces of each color and type
118   int piece_count(Color c, PieceType pt) const;
119
120   // The en passant square
121   Square ep_square() const;
122
123   // Current king position for each color
124   Square king_square(Color c) const;
125
126   // Castling rights
127   bool can_castle(CastleRight f) const;
128   bool can_castle(Color c) const;
129   Square castle_rook_square(CastleRight f) const;
130
131   // Bitboards for pinned pieces and discovered check candidates
132   Bitboard discovered_check_candidates() const;
133   Bitboard pinned_pieces() const;
134
135   // Checking pieces and under check information
136   Bitboard checkers() const;
137   bool in_check() const;
138
139   // Piece lists
140   const Square* piece_list(Color c, PieceType pt) const;
141
142   // Information about attacks to or from a given square
143   Bitboard attackers_to(Square s) const;
144   Bitboard attackers_to(Square s, Bitboard occ) const;
145   Bitboard attacks_from(Piece p, Square s) const;
146   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
147   template<PieceType> Bitboard attacks_from(Square s) const;
148   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
149
150   // Properties of moves
151   bool move_gives_check(Move m, const CheckInfo& ci) const;
152   bool move_attacks_square(Move m, Square s) const;
153   bool pl_move_is_legal(Move m, Bitboard pinned) const;
154   bool is_pseudo_legal(const Move m) const;
155   bool is_capture(Move m) const;
156   bool is_capture_or_promotion(Move m) const;
157   bool is_passed_pawn_push(Move m) const;
158
159   // Piece captured with previous moves
160   PieceType captured_piece_type() const;
161
162   // Information about pawns
163   bool pawn_is_passed(Color c, Square s) const;
164
165   // Doing and undoing moves
166   void do_move(Move m, StateInfo& st);
167   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
168   void undo_move(Move m);
169   template<bool Do> void do_null_move(StateInfo& st);
170
171   // Static exchange evaluation
172   int see(Move m) const;
173   int see_sign(Move m) const;
174
175   // Accessing hash keys
176   Key key() const;
177   Key exclusion_key() const;
178   Key pawn_key() const;
179   Key material_key() const;
180
181   // Incremental evaluation
182   Score value() const;
183   Value non_pawn_material(Color c) const;
184   Score pst_delta(Piece piece, Square from, Square to) const;
185
186   // Game termination checks
187   bool is_mate() const;
188   template<bool SkipRepetition> bool is_draw() const;
189
190   // Plies from start position to the beginning of search
191   int startpos_ply_counter() const;
192
193   // Other properties of the position
194   bool opposite_colored_bishops() const;
195   bool has_pawn_on_7th(Color c) const;
196   bool is_chess960() const;
197
198   // Current thread ID searching on the position
199   int thread() const;
200
201   int64_t nodes_searched() const;
202   void set_nodes_searched(int64_t n);
203
204   // Position consistency check, for debugging
205   bool pos_is_ok(int* failedStep = NULL) const;
206   void flip_me();
207
208   // Global initialization
209   static void init();
210
211 private:
212
213   // Initialization helper functions (used while setting up a position)
214   void clear();
215   void put_piece(Piece p, Square s);
216   void set_castle_right(Square ksq, Square rsq);
217   bool move_is_legal(const Move m) const;
218
219   // Helper template functions
220   template<bool Do> void do_castle_move(Move m);
221   template<bool FindPinned> Bitboard hidden_checkers() const;
222
223   // Computing hash keys from scratch (for initialization and debugging)
224   Key compute_key() const;
225   Key compute_pawn_key() const;
226   Key compute_material_key() const;
227
228   // Computing incremental evaluation scores and material counts
229   Score pst(Piece p, Square s) const;
230   Score compute_value() const;
231   Value compute_non_pawn_material(Color c) const;
232
233   // Board
234   Piece board[64];             // [square]
235
236   // Bitboards
237   Bitboard byTypeBB[8];        // [pieceType]
238   Bitboard byColorBB[2];       // [color]
239   Bitboard occupied;
240
241   // Piece counts
242   int pieceCount[2][8];        // [color][pieceType]
243
244   // Piece lists
245   Square pieceList[2][8][16];  // [color][pieceType][index]
246   int index[64];               // [square]
247
248   // Other info
249   int castleRightsMask[64];    // [square]
250   Square castleRookSquare[16]; // [castleRight]
251   StateInfo startState;
252   int64_t nodes;
253   int startPosPly;
254   Color sideToMove;
255   int threadID;
256   StateInfo* st;
257   int chess960;
258
259   // Static variables
260   static Score pieceSquareTable[16][64]; // [piece][square]
261   static Key zobrist[2][8][64];          // [color][pieceType][square]/[piece count]
262   static Key zobEp[64];                  // [square]
263   static Key zobCastle[16];              // [castleRight]
264   static Key zobSideToMove;
265   static Key zobExclusion;
266 };
267
268 inline int64_t Position::nodes_searched() const {
269   return nodes;
270 }
271
272 inline void Position::set_nodes_searched(int64_t n) {
273   nodes = n;
274 }
275
276 inline Piece Position::piece_on(Square s) const {
277   return board[s];
278 }
279
280 inline bool Position::square_is_empty(Square s) const {
281   return board[s] == NO_PIECE;
282 }
283
284 inline Color Position::side_to_move() const {
285   return sideToMove;
286 }
287
288 inline Bitboard Position::occupied_squares() const {
289   return occupied;
290 }
291
292 inline Bitboard Position::empty_squares() const {
293   return ~occupied;
294 }
295
296 inline Bitboard Position::pieces(Color c) const {
297   return byColorBB[c];
298 }
299
300 inline Bitboard Position::pieces(PieceType pt) const {
301   return byTypeBB[pt];
302 }
303
304 inline Bitboard Position::pieces(PieceType pt, Color c) const {
305   return byTypeBB[pt] & byColorBB[c];
306 }
307
308 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
309   return byTypeBB[pt1] | byTypeBB[pt2];
310 }
311
312 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
313   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
314 }
315
316 inline int Position::piece_count(Color c, PieceType pt) const {
317   return pieceCount[c][pt];
318 }
319
320 inline const Square* Position::piece_list(Color c, PieceType pt) const {
321   return pieceList[c][pt];
322 }
323
324 inline Square Position::ep_square() const {
325   return st->epSquare;
326 }
327
328 inline Square Position::king_square(Color c) const {
329   return pieceList[c][KING][0];
330 }
331
332 inline bool Position::can_castle(CastleRight f) const {
333   return st->castleRights & f;
334 }
335
336 inline bool Position::can_castle(Color c) const {
337   return st->castleRights & ((WHITE_OO | WHITE_OOO) << c);
338 }
339
340 inline Square Position::castle_rook_square(CastleRight f) const {
341   return castleRookSquare[f];
342 }
343
344 template<>
345 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
346   return StepAttacksBB[make_piece(c, PAWN)][s];
347 }
348
349 template<PieceType Piece> // Knight and King and white pawns
350 inline Bitboard Position::attacks_from(Square s) const {
351   return StepAttacksBB[Piece][s];
352 }
353
354 template<>
355 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
356   return bishop_attacks_bb(s, occupied_squares());
357 }
358
359 template<>
360 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
361   return rook_attacks_bb(s, occupied_squares());
362 }
363
364 template<>
365 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
366   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
367 }
368
369 inline Bitboard Position::attacks_from(Piece p, Square s) const {
370   return attacks_from(p, s, occupied_squares());
371 }
372
373 inline Bitboard Position::attackers_to(Square s) const {
374   return attackers_to(s, occupied_squares());
375 }
376
377 inline Bitboard Position::checkers() const {
378   return st->checkersBB;
379 }
380
381 inline bool Position::in_check() const {
382   return st->checkersBB != 0;
383 }
384
385 inline Bitboard Position::discovered_check_candidates() const {
386   return hidden_checkers<false>();
387 }
388
389 inline Bitboard Position::pinned_pieces() const {
390   return hidden_checkers<true>();
391 }
392
393 inline bool Position::pawn_is_passed(Color c, Square s) const {
394   return !(pieces(PAWN, flip(c)) & passed_pawn_mask(c, s));
395 }
396
397 inline Key Position::key() const {
398   return st->key;
399 }
400
401 inline Key Position::exclusion_key() const {
402   return st->key ^ zobExclusion;
403 }
404
405 inline Key Position::pawn_key() const {
406   return st->pawnKey;
407 }
408
409 inline Key Position::material_key() const {
410   return st->materialKey;
411 }
412
413 inline Score Position::pst(Piece p, Square s) const {
414   return pieceSquareTable[p][s];
415 }
416
417 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
418   return pieceSquareTable[piece][to] - pieceSquareTable[piece][from];
419 }
420
421 inline Score Position::value() const {
422   return st->value;
423 }
424
425 inline Value Position::non_pawn_material(Color c) const {
426   return st->npMaterial[c];
427 }
428
429 inline bool Position::is_passed_pawn_push(Move m) const {
430
431   return   board[from_sq(m)] == make_piece(sideToMove, PAWN)
432         && pawn_is_passed(sideToMove, to_sq(m));
433 }
434
435 inline int Position::startpos_ply_counter() const {
436   return startPosPly + st->pliesFromNull; // HACK
437 }
438
439 inline bool Position::opposite_colored_bishops() const {
440
441   return   pieceCount[WHITE][BISHOP] == 1
442         && pieceCount[BLACK][BISHOP] == 1
443         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
444 }
445
446 inline bool Position::has_pawn_on_7th(Color c) const {
447   return pieces(PAWN, c) & rank_bb(relative_rank(c, RANK_7));
448 }
449
450 inline bool Position::is_chess960() const {
451   return chess960;
452 }
453
454 inline bool Position::is_capture_or_promotion(Move m) const {
455
456   assert(is_ok(m));
457   return is_special(m) ? !is_castle(m) : !square_is_empty(to_sq(m));
458 }
459
460 inline bool Position::is_capture(Move m) const {
461
462   // Note that castle is coded as "king captures the rook"
463   assert(is_ok(m));
464   return (!square_is_empty(to_sq(m)) && !is_castle(m)) || is_enpassant(m);
465 }
466
467 inline PieceType Position::captured_piece_type() const {
468   return st->capturedType;
469 }
470
471 inline int Position::thread() const {
472   return threadID;
473 }
474
475 #endif // !defined(POSITION_H_INCLUDED)