Sync some common names
[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-2014 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 #ifndef POSITION_H_INCLUDED
21 #define POSITION_H_INCLUDED
22
23 #include <cassert>
24 #include <cstddef>
25
26 #include "bitboard.h"
27 #include "types.h"
28
29
30 /// The checkInfo struct is initialized at c'tor time and keeps info used
31 /// to detect if a move gives check.
32 class Position;
33 struct Thread;
34
35 struct CheckInfo {
36
37   explicit CheckInfo(const Position&);
38
39   Bitboard dcCandidates;
40   Bitboard pinned;
41   Bitboard checkSq[PIECE_TYPE_NB];
42   Square ksq;
43 };
44
45
46 /// The StateInfo struct stores information needed to restore a Position
47 /// object to its previous state when we retract a move. Whenever a move
48 /// is made on the board (by calling Position::do_move), a StateInfo
49 /// object must be passed as a parameter.
50
51 struct StateInfo {
52   Key pawnKey, materialKey;
53   Value npMaterial[COLOR_NB];
54   int castlingRights, rule50, pliesFromNull;
55   Score psq;
56   Square epSquare;
57
58   Key key;
59   Bitboard checkersBB;
60   PieceType capturedType;
61   StateInfo* previous;
62 };
63
64
65 /// When making a move the current StateInfo up to 'key' excluded is copied to
66 /// the new one. Here we calculate the quad words (64bits) needed to be copied.
67 const size_t StateCopySize64 = offsetof(StateInfo, key) / sizeof(uint64_t) + 1;
68
69
70 /// The Position class stores the information regarding the board representation
71 /// like pieces, side to move, hash keys, castling info, etc. The most important
72 /// methods are do_move() and undo_move(), used by the search to update node info
73 /// when traversing the search tree.
74
75 class Position {
76 public:
77   Position() {}
78   Position(const Position& pos, Thread* t) { *this = pos; thisThread = t; }
79   Position(const std::string& f, bool c960, Thread* t) { set(f, c960, t); }
80   Position& operator=(const Position&);
81   static void init();
82
83   // Text input/output
84   void set(const std::string& fenStr, bool isChess960, Thread* th);
85   const std::string fen() const;
86   const std::string pretty(Move m = MOVE_NONE) const;
87
88   // Position representation
89   Bitboard pieces() const;
90   Bitboard pieces(PieceType pt) const;
91   Bitboard pieces(PieceType pt1, PieceType pt2) const;
92   Bitboard pieces(Color c) const;
93   Bitboard pieces(Color c, PieceType pt) const;
94   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
95   Piece piece_on(Square s) const;
96   Square king_square(Color c) const;
97   Square ep_square() const;
98   bool empty(Square s) const;
99   template<PieceType Pt> int count(Color c) const;
100   template<PieceType Pt> const Square* list(Color c) const;
101
102   // Castling
103   int can_castle(Color c) const;
104   int can_castle(CastlingRight cr) const;
105   bool castling_impeded(CastlingRight cr) const;
106   Square castling_rook_square(CastlingRight cr) const;
107
108   // Checking
109   Bitboard checkers() const;
110   Bitboard discovered_check_candidates() const;
111   Bitboard pinned_pieces(Color c) const;
112
113   // Attacks to/from a given square
114   Bitboard attackers_to(Square s) const;
115   Bitboard attackers_to(Square s, Bitboard occ) const;
116   Bitboard attacks_from(Piece pc, Square s) const;
117   template<PieceType> Bitboard attacks_from(Square s) const;
118   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
119
120   // Properties of moves
121   bool legal(Move m, Bitboard pinned) const;
122   bool pseudo_legal(const Move m) const;
123   bool capture(Move m) const;
124   bool capture_or_promotion(Move m) const;
125   bool gives_check(Move m, const CheckInfo& ci) const;
126   bool advanced_pawn_push(Move m) const;
127   Piece moved_piece(Move m) const;
128   PieceType captured_piece_type() const;
129
130   // Piece specific
131   bool pawn_passed(Color c, Square s) const;
132   bool pawn_on_7th(Color c) const;
133   bool bishop_pair(Color c) const;
134   bool opposite_bishops() const;
135
136   // Doing and undoing moves
137   void do_move(Move m, StateInfo& st);
138   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
139   void undo_move(Move m);
140   void do_null_move(StateInfo& st);
141   void undo_null_move();
142
143   // Static exchange evaluation
144   Value see(Move m) const;
145   Value see_sign(Move m) const;
146
147   // Accessing hash keys
148   Key key() const;
149   Key exclusion_key() const;
150   Key pawn_key() const;
151   Key material_key() const;
152
153   // Incremental piece-square evaluation
154   Score psq_score() const;
155   Value non_pawn_material(Color c) const;
156
157   // Other properties of the position
158   Color side_to_move() const;
159   int game_ply() const;
160   bool is_chess960() const;
161   Thread* this_thread() const;
162   uint64_t nodes_searched() const;
163   void set_nodes_searched(uint64_t n);
164   bool is_draw() const;
165
166   // Position consistency check, for debugging
167   bool pos_is_ok(int* step = NULL) const;
168   void flip();
169
170 private:
171   // Initialization helpers (used while setting up a position)
172   void clear();
173   void set_castling_right(Color c, Square rfrom);
174   void set_state(StateInfo* si) const;
175
176   // Helper functions
177   Bitboard check_blockers(Color c, Color kingColor) const;
178   void put_piece(Square s, Color c, PieceType pt);
179   void remove_piece(Square s, Color c, PieceType pt);
180   void move_piece(Square from, Square to, Color c, PieceType pt);
181   template<bool Do>
182   void do_castling(Square from, Square& to, Square& rfrom, Square& rto);
183
184   // Board and pieces
185   Piece board[SQUARE_NB];
186   Bitboard byTypeBB[PIECE_TYPE_NB];
187   Bitboard byColorBB[COLOR_NB];
188   int pieceCount[COLOR_NB][PIECE_TYPE_NB];
189   Square pieceList[COLOR_NB][PIECE_TYPE_NB][16];
190   int index[SQUARE_NB];
191
192   // Other info
193   int castlingRightsMask[SQUARE_NB];
194   Square castlingRookSquare[CASTLING_RIGHT_NB];
195   Bitboard castlingPath[CASTLING_RIGHT_NB];
196   StateInfo startState;
197   uint64_t nodes;
198   int gamePly;
199   Color sideToMove;
200   Thread* thisThread;
201   StateInfo* st;
202   bool chess960;
203 };
204
205 inline uint64_t Position::nodes_searched() const {
206   return nodes;
207 }
208
209 inline void Position::set_nodes_searched(uint64_t n) {
210   nodes = n;
211 }
212
213 inline Piece Position::piece_on(Square s) const {
214   return board[s];
215 }
216
217 inline Piece Position::moved_piece(Move m) const {
218   return board[from_sq(m)];
219 }
220
221 inline bool Position::empty(Square s) const {
222   return board[s] == NO_PIECE;
223 }
224
225 inline Color Position::side_to_move() const {
226   return sideToMove;
227 }
228
229 inline Bitboard Position::pieces() const {
230   return byTypeBB[ALL_PIECES];
231 }
232
233 inline Bitboard Position::pieces(PieceType pt) const {
234   return byTypeBB[pt];
235 }
236
237 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
238   return byTypeBB[pt1] | byTypeBB[pt2];
239 }
240
241 inline Bitboard Position::pieces(Color c) const {
242   return byColorBB[c];
243 }
244
245 inline Bitboard Position::pieces(Color c, PieceType pt) const {
246   return byColorBB[c] & byTypeBB[pt];
247 }
248
249 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
250   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
251 }
252
253 template<PieceType Pt> inline int Position::count(Color c) const {
254   return pieceCount[c][Pt];
255 }
256
257 template<PieceType Pt> inline const Square* Position::list(Color c) const {
258   return pieceList[c][Pt];
259 }
260
261 inline Square Position::ep_square() const {
262   return st->epSquare;
263 }
264
265 inline Square Position::king_square(Color c) const {
266   return pieceList[c][KING][0];
267 }
268
269 inline int Position::can_castle(CastlingRight cr) const {
270   return st->castlingRights & cr;
271 }
272
273 inline int Position::can_castle(Color c) const {
274   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
275 }
276
277 inline bool Position::castling_impeded(CastlingRight cr) const {
278   return byTypeBB[ALL_PIECES] & castlingPath[cr];
279 }
280
281 inline Square Position::castling_rook_square(CastlingRight cr) const {
282   return castlingRookSquare[cr];
283 }
284
285 template<PieceType Pt>
286 inline Bitboard Position::attacks_from(Square s) const {
287
288   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
289         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
290         : StepAttacksBB[Pt][s];
291 }
292
293 template<>
294 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
295   return StepAttacksBB[make_piece(c, PAWN)][s];
296 }
297
298 inline Bitboard Position::attacks_from(Piece pc, Square s) const {
299   return attacks_bb(pc, s, byTypeBB[ALL_PIECES]);
300 }
301
302 inline Bitboard Position::attackers_to(Square s) const {
303   return attackers_to(s, byTypeBB[ALL_PIECES]);
304 }
305
306 inline Bitboard Position::checkers() const {
307   return st->checkersBB;
308 }
309
310 inline Bitboard Position::discovered_check_candidates() const {
311   return check_blockers(sideToMove, ~sideToMove);
312 }
313
314 inline Bitboard Position::pinned_pieces(Color c) const {
315   return check_blockers(c, c);
316 }
317
318 inline bool Position::pawn_passed(Color c, Square s) const {
319   return !(pieces(~c, PAWN) & passed_pawn_mask(c, s));
320 }
321
322 inline bool Position::advanced_pawn_push(Move m) const {
323   return   type_of(moved_piece(m)) == PAWN
324         && relative_rank(sideToMove, from_sq(m)) > RANK_4;
325 }
326
327 inline Key Position::key() const {
328   return st->key;
329 }
330
331 inline Key Position::pawn_key() const {
332   return st->pawnKey;
333 }
334
335 inline Key Position::material_key() const {
336   return st->materialKey;
337 }
338
339 inline Score Position::psq_score() const {
340   return st->psq;
341 }
342
343 inline Value Position::non_pawn_material(Color c) const {
344   return st->npMaterial[c];
345 }
346
347 inline int Position::game_ply() const {
348   return gamePly;
349 }
350
351 inline bool Position::opposite_bishops() const {
352
353   return   pieceCount[WHITE][BISHOP] == 1
354         && pieceCount[BLACK][BISHOP] == 1
355         && opposite_colors(pieceList[WHITE][BISHOP][0], pieceList[BLACK][BISHOP][0]);
356 }
357
358 inline bool Position::bishop_pair(Color c) const {
359
360   return   pieceCount[c][BISHOP] >= 2
361         && opposite_colors(pieceList[c][BISHOP][0], pieceList[c][BISHOP][1]);
362 }
363
364 inline bool Position::pawn_on_7th(Color c) const {
365   return pieces(c, PAWN) & rank_bb(relative_rank(c, RANK_7));
366 }
367
368 inline bool Position::is_chess960() const {
369   return chess960;
370 }
371
372 inline bool Position::capture_or_promotion(Move m) const {
373
374   assert(is_ok(m));
375   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
376 }
377
378 inline bool Position::capture(Move m) const {
379
380   // Note that castling is encoded as "king captures the rook"
381   assert(is_ok(m));
382   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
383 }
384
385 inline PieceType Position::captured_piece_type() const {
386   return st->capturedType;
387 }
388
389 inline Thread* Position::this_thread() const {
390   return thisThread;
391 }
392
393 inline void Position::put_piece(Square s, Color c, PieceType pt) {
394
395   board[s] = make_piece(c, pt);
396   byTypeBB[ALL_PIECES] |= s;
397   byTypeBB[pt] |= s;
398   byColorBB[c] |= s;
399   index[s] = pieceCount[c][pt]++;
400   pieceList[c][pt][index[s]] = s;
401 }
402
403 inline void Position::move_piece(Square from, Square to, Color c, PieceType pt) {
404
405   // index[from] is not updated and becomes stale. This works as long
406   // as index[] is accessed just by known occupied squares.
407   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
408   byTypeBB[ALL_PIECES] ^= from_to_bb;
409   byTypeBB[pt] ^= from_to_bb;
410   byColorBB[c] ^= from_to_bb;
411   board[from] = NO_PIECE;
412   board[to] = make_piece(c, pt);
413   index[to] = index[from];
414   pieceList[c][pt][index[to]] = to;
415 }
416
417 inline void Position::remove_piece(Square s, Color c, PieceType pt) {
418
419   // WARNING: This is not a reversible operation. If we remove a piece in
420   // do_move() and then replace it in undo_move() we will put it at the end of
421   // the list and not in its original place, it means index[] and pieceList[]
422   // are not guaranteed to be invariant to a do_move() + undo_move() sequence.
423   byTypeBB[ALL_PIECES] ^= s;
424   byTypeBB[pt] ^= s;
425   byColorBB[c] ^= s;
426   /* board[s] = NO_PIECE; */ // Not needed, will be overwritten by capturing
427   Square lastSquare = pieceList[c][pt][--pieceCount[c][pt]];
428   index[lastSquare] = index[s];
429   pieceList[c][pt][index[lastSquare]] = lastSquare;
430   pieceList[c][pt][pieceCount[c][pt]] = SQ_NONE;
431 }
432
433 #endif // #ifndef POSITION_H_INCLUDED