rename shift variables.
[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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef POSITION_H_INCLUDED
22 #define POSITION_H_INCLUDED
23
24 #include <cassert>
25 #include <deque>
26 #include <memory> // For std::unique_ptr
27 #include <string>
28
29 #include "bitboard.h"
30 #include "types.h"
31
32
33 /// StateInfo struct stores information needed to restore a Position object to
34 /// its previous state when we retract a move. Whenever a move is made on the
35 /// board (by calling Position::do_move), a StateInfo object must be passed.
36
37 struct StateInfo {
38
39   // Copied when making a move
40   Key    pawnKey;
41   Key    materialKey;
42   Value  nonPawnMaterial[COLOR_NB];
43   int    castlingRights;
44   int    rule50;
45   int    pliesFromNull;
46   Score  psq;
47   Square epSquare;
48
49   // Not copied when making a move (will be recomputed anyhow)
50   Key        key;
51   Bitboard   checkersBB;
52   Piece      capturedPiece;
53   StateInfo* previous;
54   Bitboard   blockersForKing[COLOR_NB];
55   Bitboard   pinnersForKing[COLOR_NB];
56   Bitboard   checkSquares[PIECE_TYPE_NB];
57 };
58
59 /// A list to keep track of the position states along the setup moves (from the
60 /// start position to the position just before the search starts). Needed by
61 /// 'draw by repetition' detection. Use a std::deque because pointers to
62 /// elements are not invalidated upon list resizing.
63 typedef std::unique_ptr<std::deque<StateInfo>> StateListPtr;
64
65
66 /// Position class stores information regarding the board representation as
67 /// pieces, side to move, hash keys, castling info, etc. Important methods are
68 /// do_move() and undo_move(), used by the search to update node info when
69 /// traversing the search tree.
70 class Thread;
71
72 class Position {
73 public:
74   static void init();
75
76   Position() = default;
77   Position(const Position&) = delete;
78   Position& operator=(const Position&) = delete;
79
80   // FEN string input/output
81   Position& set(const std::string& fenStr, bool isChess960, StateInfo* si, Thread* th);
82   Position& set(const std::string& code, Color c, StateInfo* si);
83   const std::string fen() const;
84
85   // Position representation
86   Bitboard pieces() const;
87   Bitboard pieces(PieceType pt) const;
88   Bitboard pieces(PieceType pt1, PieceType pt2) const;
89   Bitboard pieces(Color c) const;
90   Bitboard pieces(Color c, PieceType pt) const;
91   Bitboard pieces(Color c, PieceType pt1, PieceType pt2) const;
92   Piece piece_on(Square s) const;
93   Square ep_square() const;
94   bool empty(Square s) const;
95   template<PieceType Pt> int count(Color c) const;
96   template<PieceType Pt> int count() const;
97   template<PieceType Pt> const Square* squares(Color c) const;
98   template<PieceType Pt> Square square(Color c) const;
99
100   // Castling
101   int can_castle(Color c) const;
102   int can_castle(CastlingRight cr) const;
103   bool castling_impeded(CastlingRight cr) const;
104   Square castling_rook_square(CastlingRight cr) const;
105
106   // Checking
107   Bitboard checkers() const;
108   Bitboard discovered_check_candidates() const;
109   Bitboard pinned_pieces(Color c) const;
110   Bitboard check_squares(PieceType pt) const;
111
112   // Attacks to/from a given square
113   Bitboard attackers_to(Square s) const;
114   Bitboard attackers_to(Square s, Bitboard occupied) const;
115   Bitboard attacks_from(PieceType pt, Square s) const;
116   template<PieceType> Bitboard attacks_from(Square s) const;
117   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
118   template<Color> Bitboard pawn_attacks(Bitboard b) const;
119   Bitboard slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const;
120
121   // Properties of moves
122   bool legal(Move m) const;
123   bool pseudo_legal(const Move m) const;
124   bool capture(Move m) const;
125   bool capture_or_promotion(Move m) const;
126   bool gives_check(Move m) const;
127   bool advanced_pawn_push(Move m) const;
128   Piece moved_piece(Move m) const;
129   Piece captured_piece() const;
130
131   // Piece specific
132   bool pawn_passed(Color c, Square s) const;
133   bool opposite_bishops() const;
134
135   // Doing and undoing moves
136   void do_move(Move m, StateInfo& newSt);
137   void do_move(Move m, StateInfo& newSt, bool givesCheck);
138   void undo_move(Move m);
139   void do_null_move(StateInfo& newSt);
140   void undo_null_move();
141
142   // Static Exchange Evaluation
143   bool see_ge(Move m, Value threshold = VALUE_ZERO) const;
144
145   // Accessing hash keys
146   Key key() const;
147   Key key_after(Move m) const;
148   Key material_key() const;
149   Key pawn_key() const;
150
151   // Other properties of the position
152   Color side_to_move() const;
153   int game_ply() const;
154   bool is_chess960() const;
155   Thread* this_thread() const;
156   bool is_draw(int ply) const;
157   int rule50_count() const;
158   Score psq_score() const;
159   Value non_pawn_material(Color c) const;
160   Value non_pawn_material() const;
161
162   // Position consistency check, for debugging
163   bool pos_is_ok() const;
164   void flip();
165
166 private:
167   // Initialization helpers (used while setting up a position)
168   void set_castling_right(Color c, Square rfrom);
169   void set_state(StateInfo* si) const;
170   void set_check_info(StateInfo* si) const;
171
172   // Other helpers
173   void put_piece(Piece pc, Square s);
174   void remove_piece(Piece pc, Square s);
175   void move_piece(Piece pc, Square from, Square to);
176   template<bool Do>
177   void do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto);
178
179   // Data members
180   Piece board[SQUARE_NB];
181   Bitboard byTypeBB[PIECE_TYPE_NB];
182   Bitboard byColorBB[COLOR_NB];
183   int pieceCount[PIECE_NB];
184   Square pieceList[PIECE_NB][16];
185   int index[SQUARE_NB];
186   int castlingRightsMask[SQUARE_NB];
187   Square castlingRookSquare[CASTLING_RIGHT_NB];
188   Bitboard castlingPath[CASTLING_RIGHT_NB];
189   int gamePly;
190   Color sideToMove;
191   Thread* thisThread;
192   StateInfo* st;
193   bool chess960;
194 };
195
196 extern std::ostream& operator<<(std::ostream& os, const Position& pos);
197
198 inline Color Position::side_to_move() const {
199   return sideToMove;
200 }
201
202 inline bool Position::empty(Square s) const {
203   return board[s] == NO_PIECE;
204 }
205
206 inline Piece Position::piece_on(Square s) const {
207   return board[s];
208 }
209
210 inline Piece Position::moved_piece(Move m) const {
211   return board[from_sq(m)];
212 }
213
214 inline Bitboard Position::pieces() const {
215   return byTypeBB[ALL_PIECES];
216 }
217
218 inline Bitboard Position::pieces(PieceType pt) const {
219   return byTypeBB[pt];
220 }
221
222 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
223   return byTypeBB[pt1] | byTypeBB[pt2];
224 }
225
226 inline Bitboard Position::pieces(Color c) const {
227   return byColorBB[c];
228 }
229
230 inline Bitboard Position::pieces(Color c, PieceType pt) const {
231   return byColorBB[c] & byTypeBB[pt];
232 }
233
234 inline Bitboard Position::pieces(Color c, PieceType pt1, PieceType pt2) const {
235   return byColorBB[c] & (byTypeBB[pt1] | byTypeBB[pt2]);
236 }
237
238 template<PieceType Pt> inline int Position::count(Color c) const {
239   return pieceCount[make_piece(c, Pt)];
240 }
241
242 template<PieceType Pt> inline int Position::count() const {
243   return pieceCount[make_piece(WHITE, Pt)] + pieceCount[make_piece(BLACK, Pt)];
244 }
245
246 template<PieceType Pt> inline const Square* Position::squares(Color c) const {
247   return pieceList[make_piece(c, Pt)];
248 }
249
250 template<PieceType Pt> inline Square Position::square(Color c) const {
251   assert(pieceCount[make_piece(c, Pt)] == 1);
252   return pieceList[make_piece(c, Pt)][0];
253 }
254
255 inline Square Position::ep_square() const {
256   return st->epSquare;
257 }
258
259 inline int Position::can_castle(CastlingRight cr) const {
260   return st->castlingRights & cr;
261 }
262
263 inline int Position::can_castle(Color c) const {
264   return st->castlingRights & ((WHITE_OO | WHITE_OOO) << (2 * c));
265 }
266
267 inline bool Position::castling_impeded(CastlingRight cr) const {
268   return byTypeBB[ALL_PIECES] & castlingPath[cr];
269 }
270
271 inline Square Position::castling_rook_square(CastlingRight cr) const {
272   return castlingRookSquare[cr];
273 }
274
275 template<PieceType Pt>
276 inline Bitboard Position::attacks_from(Square s) const {
277   assert(Pt != PAWN);
278   return  Pt == BISHOP || Pt == ROOK ? attacks_bb<Pt>(s, byTypeBB[ALL_PIECES])
279         : Pt == QUEEN  ? attacks_from<ROOK>(s) | attacks_from<BISHOP>(s)
280         : PseudoAttacks[Pt][s];
281 }
282
283 template<>
284 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
285   return PawnAttacks[c][s];
286 }
287
288 inline Bitboard Position::attacks_from(PieceType pt, Square s) const {
289   return attacks_bb(pt, s, byTypeBB[ALL_PIECES]);
290 }
291
292 template<Color c>
293 inline Bitboard Position::pawn_attacks(Bitboard b) const {
294   return c == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
295                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
296 }
297
298 inline Bitboard Position::attackers_to(Square s) const {
299   return attackers_to(s, byTypeBB[ALL_PIECES]);
300 }
301
302 inline Bitboard Position::checkers() const {
303   return st->checkersBB;
304 }
305
306 inline Bitboard Position::discovered_check_candidates() const {
307   return st->blockersForKing[~sideToMove] & pieces(sideToMove);
308 }
309
310 inline Bitboard Position::pinned_pieces(Color c) const {
311   return st->blockersForKing[c] & pieces(c);
312 }
313
314 inline Bitboard Position::check_squares(PieceType pt) const {
315   return st->checkSquares[pt];
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->nonPawnMaterial[c];
345 }
346
347 inline Value Position::non_pawn_material() const {
348   return st->nonPawnMaterial[WHITE] + st->nonPawnMaterial[BLACK];
349 }
350
351 inline int Position::game_ply() const {
352   return gamePly;
353 }
354
355 inline int Position::rule50_count() const {
356   return st->rule50;
357 }
358
359 inline bool Position::opposite_bishops() const {
360   return   pieceCount[W_BISHOP] == 1
361         && pieceCount[B_BISHOP] == 1
362         && opposite_colors(square<BISHOP>(WHITE), square<BISHOP>(BLACK));
363 }
364
365 inline bool Position::is_chess960() const {
366   return chess960;
367 }
368
369 inline bool Position::capture_or_promotion(Move m) const {
370   assert(is_ok(m));
371   return type_of(m) != NORMAL ? type_of(m) != CASTLING : !empty(to_sq(m));
372 }
373
374 inline bool Position::capture(Move m) const {
375   assert(is_ok(m));
376   // Castling is encoded as "king captures rook"
377   return (!empty(to_sq(m)) && type_of(m) != CASTLING) || type_of(m) == ENPASSANT;
378 }
379
380 inline Piece Position::captured_piece() const {
381   return st->capturedPiece;
382 }
383
384 inline Thread* Position::this_thread() const {
385   return thisThread;
386 }
387
388 inline void Position::put_piece(Piece pc, Square s) {
389
390   board[s] = pc;
391   byTypeBB[ALL_PIECES] |= s;
392   byTypeBB[type_of(pc)] |= s;
393   byColorBB[color_of(pc)] |= s;
394   index[s] = pieceCount[pc]++;
395   pieceList[pc][index[s]] = s;
396   pieceCount[make_piece(color_of(pc), ALL_PIECES)]++;
397 }
398
399 inline void Position::remove_piece(Piece pc, Square s) {
400
401   // WARNING: This is not a reversible operation. If we remove a piece in
402   // do_move() and then replace it in undo_move() we will put it at the end of
403   // the list and not in its original place, it means index[] and pieceList[]
404   // are not invariant to a do_move() + undo_move() sequence.
405   byTypeBB[ALL_PIECES] ^= s;
406   byTypeBB[type_of(pc)] ^= s;
407   byColorBB[color_of(pc)] ^= s;
408   /* board[s] = NO_PIECE;  Not needed, overwritten by the capturing one */
409   Square lastSquare = pieceList[pc][--pieceCount[pc]];
410   index[lastSquare] = index[s];
411   pieceList[pc][index[lastSquare]] = lastSquare;
412   pieceList[pc][pieceCount[pc]] = SQ_NONE;
413   pieceCount[make_piece(color_of(pc), ALL_PIECES)]--;
414 }
415
416 inline void Position::move_piece(Piece pc, Square from, Square to) {
417
418   // index[from] is not updated and becomes stale. This works as long as index[]
419   // is accessed just by known occupied squares.
420   Bitboard from_to_bb = SquareBB[from] ^ SquareBB[to];
421   byTypeBB[ALL_PIECES] ^= from_to_bb;
422   byTypeBB[type_of(pc)] ^= from_to_bb;
423   byColorBB[color_of(pc)] ^= from_to_bb;
424   board[from] = NO_PIECE;
425   board[to] = pc;
426   index[to] = index[from];
427   pieceList[pc][index[to]] = to;
428 }
429
430 inline void Position::do_move(Move m, StateInfo& newSt) {
431   do_move(m, newSt, gives_check(m));
432 }
433
434 #endif // #ifndef POSITION_H_INCLUDED