Remove duplicated enum Phase definition
[stockfish] / src / position.cpp
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 #include <cassert>
21 #include <cstring>
22 #include <fstream>
23 #include <iostream>
24 #include <sstream>
25
26 #include "bitcount.h"
27 #include "movegen.h"
28 #include "position.h"
29 #include "psqtab.h"
30 #include "rkiss.h"
31 #include "thread.h"
32 #include "tt.h"
33 #include "ucioption.h"
34
35 using std::string;
36 using std::cout;
37 using std::endl;
38
39 Key Position::zobrist[2][8][64];
40 Key Position::zobEp[64];
41 Key Position::zobCastle[16];
42 Key Position::zobSideToMove;
43 Key Position::zobExclusion;
44
45 Score Position::pieceSquareTable[16][64];
46
47 // Material values arrays, indexed by Piece
48 const Value PieceValueMidgame[17] = {
49   VALUE_ZERO,
50   PawnValueMidgame, KnightValueMidgame, BishopValueMidgame,
51   RookValueMidgame, QueenValueMidgame,
52   VALUE_ZERO, VALUE_ZERO, VALUE_ZERO,
53   PawnValueMidgame, KnightValueMidgame, BishopValueMidgame,
54   RookValueMidgame, QueenValueMidgame
55 };
56
57 const Value PieceValueEndgame[17] = {
58   VALUE_ZERO,
59   PawnValueEndgame, KnightValueEndgame, BishopValueEndgame,
60   RookValueEndgame, QueenValueEndgame,
61   VALUE_ZERO, VALUE_ZERO, VALUE_ZERO,
62   PawnValueEndgame, KnightValueEndgame, BishopValueEndgame,
63   RookValueEndgame, QueenValueEndgame
64 };
65
66
67 namespace {
68
69   // Bonus for having the side to move (modified by Joona Kiiski)
70   const Score TempoValue = make_score(48, 22);
71
72   // To convert a Piece to and from a FEN char
73   const string PieceToChar(".PNBRQK  pnbrqk  ");
74 }
75
76
77 /// CheckInfo c'tor
78
79 CheckInfo::CheckInfo(const Position& pos) {
80
81   Color us = pos.side_to_move();
82   Color them = opposite_color(us);
83   Square ksq = pos.king_square(them);
84
85   dcCandidates = pos.discovered_check_candidates(us);
86   pinned = pos.pinned_pieces(us);
87
88   checkSq[PAWN]   = pos.attacks_from<PAWN>(ksq, them);
89   checkSq[KNIGHT] = pos.attacks_from<KNIGHT>(ksq);
90   checkSq[BISHOP] = pos.attacks_from<BISHOP>(ksq);
91   checkSq[ROOK]   = pos.attacks_from<ROOK>(ksq);
92   checkSq[QUEEN]  = checkSq[BISHOP] | checkSq[ROOK];
93   checkSq[KING]   = EmptyBoardBB;
94 }
95
96
97 /// Position c'tors. Here we always create a copy of the original position
98 /// or the FEN string, we want the new born Position object do not depend
99 /// on any external data so we detach state pointer from the source one.
100
101 Position::Position(const Position& pos, int th) {
102
103   memcpy(this, &pos, sizeof(Position));
104   detach(); // Always detach() in copy c'tor to avoid surprises
105   threadID = th;
106   nodes = 0;
107 }
108
109 Position::Position(const string& fen, bool isChess960, int th) {
110
111   from_fen(fen, isChess960);
112   threadID = th;
113 }
114
115
116 /// Position::detach() copies the content of the current state and castling
117 /// masks inside the position itself. This is needed when the st pointee could
118 /// become stale, as example because the caller is about to going out of scope.
119
120 void Position::detach() {
121
122   startState = *st;
123   st = &startState;
124   st->previous = NULL; // As a safe guard
125 }
126
127
128 /// Position::from_fen() initializes the position object with the given FEN
129 /// string. This function is not very robust - make sure that input FENs are
130 /// correct (this is assumed to be the responsibility of the GUI).
131
132 void Position::from_fen(const string& fen, bool isChess960) {
133 /*
134    A FEN string defines a particular position using only the ASCII character set.
135
136    A FEN string contains six fields. The separator between fields is a space. The fields are:
137
138    1) Piece placement (from white's perspective). Each rank is described, starting with rank 8 and ending
139       with rank 1; within each rank, the contents of each square are described from file A through file H.
140       Following the Standard Algebraic Notation (SAN), each piece is identified by a single letter taken
141       from the standard English names. White pieces are designated using upper-case letters ("PNBRQK")
142       while Black take lowercase ("pnbrqk"). Blank squares are noted using digits 1 through 8 (the number
143       of blank squares), and "/" separate ranks.
144
145    2) Active color. "w" means white moves next, "b" means black.
146
147    3) Castling availability. If neither side can castle, this is "-". Otherwise, this has one or more
148       letters: "K" (White can castle kingside), "Q" (White can castle queenside), "k" (Black can castle
149       kingside), and/or "q" (Black can castle queenside).
150
151    4) En passant target square in algebraic notation. If there's no en passant target square, this is "-".
152       If a pawn has just made a 2-square move, this is the position "behind" the pawn. This is recorded
153       regardless of whether there is a pawn in position to make an en passant capture.
154
155    5) Halfmove clock: This is the number of halfmoves since the last pawn advance or capture. This is used
156       to determine if a draw can be claimed under the fifty-move rule.
157
158    6) Fullmove number: The number of the full move. It starts at 1, and is incremented after Black's move.
159 */
160
161   char col, row, token;
162   size_t p;
163   Square sq = SQ_A8;
164   std::istringstream ss(fen);
165
166   clear();
167   ss >> std::noskipws;
168
169   // 1. Piece placement
170   while ((ss >> token) && !isspace(token))
171   {
172       if (token == '/')
173           sq -= Square(16); // Jump back of 2 rows
174
175       else if (isdigit(token))
176           sq += Square(token - '0'); // Skip the given number of files
177
178       else if ((p = PieceToChar.find(token)) != string::npos)
179       {
180           put_piece(Piece(p), sq);
181           sq++;
182       }
183   }
184
185   // 2. Active color
186   ss >> token;
187   sideToMove = (token == 'w' ? WHITE : BLACK);
188   ss >> token;
189
190   // 3. Castling availability
191   while ((ss >> token) && !isspace(token))
192       set_castling_rights(token);
193
194   // 4. En passant square. Ignore if no pawn capture is possible
195   if (   ((ss >> col) && (col >= 'a' && col <= 'h'))
196       && ((ss >> row) && (row == '3' || row == '6')))
197   {
198       st->epSquare = make_square(File(col - 'a'), Rank(row - '1'));
199       Color them = opposite_color(sideToMove);
200
201       if (!(attacks_from<PAWN>(st->epSquare, them) & pieces(PAWN, sideToMove)))
202           st->epSquare = SQ_NONE;
203   }
204
205   // 5-6. Halfmove clock and fullmove number
206   ss >> std::skipws >> st->rule50 >> fullMoves;
207
208   // Various initialisations
209   chess960 = isChess960;
210   st->checkersBB = attackers_to(king_square(sideToMove)) & pieces(opposite_color(sideToMove));
211
212   st->key = compute_key();
213   st->pawnKey = compute_pawn_key();
214   st->materialKey = compute_material_key();
215   st->value = compute_value();
216   st->npMaterial[WHITE] = compute_non_pawn_material(WHITE);
217   st->npMaterial[BLACK] = compute_non_pawn_material(BLACK);
218 }
219
220
221 /// Position::set_castle() is an helper function used to set
222 /// correct castling related flags.
223
224 void Position::set_castle(int f, Square ksq, Square rsq) {
225
226   st->castleRights |= f;
227   castleRightsMask[ksq] ^= f;
228   castleRightsMask[rsq] ^= f;
229   castleRookSquare[f] = rsq;
230 }
231
232
233 /// Position::set_castling_rights() sets castling parameters castling avaiability.
234 /// This function is compatible with 3 standards: Normal FEN standard, Shredder-FEN
235 /// that uses the letters of the columns on which the rooks began the game instead
236 /// of KQkq and also X-FEN standard that, in case of Chess960, if an inner Rook is
237 /// associated with the castling right, the traditional castling tag will be replaced
238 /// by the file letter of the involved rook as for the Shredder-FEN.
239
240 void Position::set_castling_rights(char token) {
241
242     Color c = islower(token) ? BLACK : WHITE;
243
244     Square sqA = relative_square(c, SQ_A1);
245     Square sqH = relative_square(c, SQ_H1);
246     Square rsq, ksq = king_square(c);
247
248     token = char(toupper(token));
249
250     if (token == 'K')
251         for (rsq = sqH; piece_on(rsq) != make_piece(c, ROOK); rsq--) {}
252
253     else if (token == 'Q')
254         for (rsq = sqA; piece_on(rsq) != make_piece(c, ROOK); rsq++) {}
255
256     else if (token >= 'A' && token <= 'H')
257         rsq = make_square(File(token - 'A'), relative_rank(c, RANK_1));
258
259     else return;
260
261     if (square_file(rsq) < square_file(ksq))
262         set_castle(WHITE_OOO << c, ksq, rsq);
263     else
264         set_castle(WHITE_OO << c, ksq, rsq);
265 }
266
267
268 /// Position::to_fen() returns a FEN representation of the position. In case
269 /// of Chess960 the Shredder-FEN notation is used. Mainly a debugging function.
270
271 const string Position::to_fen() const {
272
273   string fen;
274   Square sq;
275   char emptyCnt;
276
277   for (Rank rank = RANK_8; rank >= RANK_1; rank--, fen += '/')
278   {
279       emptyCnt = '0';
280
281       for (File file = FILE_A; file <= FILE_H; file++)
282       {
283           sq = make_square(file, rank);
284
285           if (!square_is_empty(sq))
286           {
287               if (emptyCnt != '0')
288               {
289                   fen += emptyCnt;
290                   emptyCnt = '0';
291               }
292               fen += PieceToChar[piece_on(sq)];
293           } else
294               emptyCnt++;
295       }
296
297       if (emptyCnt != '0')
298           fen += emptyCnt;
299   }
300
301   fen += (sideToMove == WHITE ? " w " : " b ");
302
303   if (st->castleRights != CASTLES_NONE)
304   {
305       if (can_castle(WHITE_OO))
306           fen += chess960 ? char(toupper(file_to_char(square_file(castle_rook_square(WHITE_OO))))) : 'K';
307
308       if (can_castle(WHITE_OOO))
309           fen += chess960 ? char(toupper(file_to_char(square_file(castle_rook_square(WHITE_OOO))))) : 'Q';
310
311       if (can_castle(BLACK_OO))
312           fen += chess960 ? file_to_char(square_file(castle_rook_square(BLACK_OO))) : 'k';
313
314       if (can_castle(BLACK_OOO))
315           fen += chess960 ? file_to_char(square_file(castle_rook_square(BLACK_OOO))) : 'q';
316   } else
317       fen += '-';
318
319   fen += (ep_square() == SQ_NONE ? " -" : " " + square_to_string(ep_square()));
320   return fen;
321 }
322
323
324 /// Position::print() prints an ASCII representation of the position to
325 /// the standard output. If a move is given then also the san is printed.
326
327 void Position::print(Move move) const {
328
329   const char* dottedLine = "\n+---+---+---+---+---+---+---+---+\n";
330
331   if (move)
332   {
333       Position p(*this, thread());
334       string dd = (piece_color(piece_on(move_from(move))) == BLACK ? ".." : "");
335       cout << "\nMove is: " << dd << move_to_san(p, move);
336   }
337
338   for (Rank rank = RANK_8; rank >= RANK_1; rank--)
339   {
340       cout << dottedLine << '|';
341       for (File file = FILE_A; file <= FILE_H; file++)
342       {
343           Square sq = make_square(file, rank);
344           Piece piece = piece_on(sq);
345
346           if (piece == PIECE_NONE && square_color(sq) == DARK)
347               piece = PIECE_NONE_DARK_SQ;
348
349           char c = (piece_color(piece_on(sq)) == BLACK ? '=' : ' ');
350           cout << c << PieceToChar[piece] << c << '|';
351       }
352   }
353   cout << dottedLine << "Fen is: " << to_fen() << "\nKey is: " << st->key << endl;
354 }
355
356
357 /// Position:hidden_checkers<>() returns a bitboard of all pinned (against the
358 /// king) pieces for the given color and for the given pinner type. Or, when
359 /// template parameter FindPinned is false, the pieces of the given color
360 /// candidate for a discovery check against the enemy king.
361 /// Bitboard checkersBB must be already updated when looking for pinners.
362
363 template<bool FindPinned>
364 Bitboard Position::hidden_checkers(Color c) const {
365
366   Bitboard result = EmptyBoardBB;
367   Bitboard pinners = pieces(FindPinned ? opposite_color(c) : c);
368
369   // Pinned pieces protect our king, dicovery checks attack
370   // the enemy king.
371   Square ksq = king_square(FindPinned ? c : opposite_color(c));
372
373   // Pinners are sliders, not checkers, that give check when candidate pinned is removed
374   pinners &= (pieces(ROOK, QUEEN) & RookPseudoAttacks[ksq]) | (pieces(BISHOP, QUEEN) & BishopPseudoAttacks[ksq]);
375
376   if (FindPinned && pinners)
377       pinners &= ~st->checkersBB;
378
379   while (pinners)
380   {
381       Square s = pop_1st_bit(&pinners);
382       Bitboard b = squares_between(s, ksq) & occupied_squares();
383
384       assert(b);
385
386       if (  !(b & (b - 1)) // Only one bit set?
387           && (b & pieces(c))) // Is an our piece?
388           result |= b;
389   }
390   return result;
391 }
392
393
394 /// Position:pinned_pieces() returns a bitboard of all pinned (against the
395 /// king) pieces for the given color. Note that checkersBB bitboard must
396 /// be already updated.
397
398 Bitboard Position::pinned_pieces(Color c) const {
399
400   return hidden_checkers<true>(c);
401 }
402
403
404 /// Position:discovered_check_candidates() returns a bitboard containing all
405 /// pieces for the given side which are candidates for giving a discovered
406 /// check. Contrary to pinned_pieces() here there is no need of checkersBB
407 /// to be already updated.
408
409 Bitboard Position::discovered_check_candidates(Color c) const {
410
411   return hidden_checkers<false>(c);
412 }
413
414 /// Position::attackers_to() computes a bitboard containing all pieces which
415 /// attacks a given square.
416
417 Bitboard Position::attackers_to(Square s) const {
418
419   return  (attacks_from<PAWN>(s, BLACK) & pieces(PAWN, WHITE))
420         | (attacks_from<PAWN>(s, WHITE) & pieces(PAWN, BLACK))
421         | (attacks_from<KNIGHT>(s)      & pieces(KNIGHT))
422         | (attacks_from<ROOK>(s)        & pieces(ROOK, QUEEN))
423         | (attacks_from<BISHOP>(s)      & pieces(BISHOP, QUEEN))
424         | (attacks_from<KING>(s)        & pieces(KING));
425 }
426
427 Bitboard Position::attackers_to(Square s, Bitboard occ) const {
428
429   return  (attacks_from<PAWN>(s, BLACK) & pieces(PAWN, WHITE))
430         | (attacks_from<PAWN>(s, WHITE) & pieces(PAWN, BLACK))
431         | (attacks_from<KNIGHT>(s)      & pieces(KNIGHT))
432         | (rook_attacks_bb(s, occ)      & pieces(ROOK, QUEEN))
433         | (bishop_attacks_bb(s, occ)    & pieces(BISHOP, QUEEN))
434         | (attacks_from<KING>(s)        & pieces(KING));
435 }
436
437 /// Position::attacks_from() computes a bitboard of all attacks
438 /// of a given piece put in a given square.
439
440 Bitboard Position::attacks_from(Piece p, Square s) const {
441
442   assert(square_is_ok(s));
443
444   switch (p)
445   {
446   case WB: case BB: return attacks_from<BISHOP>(s);
447   case WR: case BR: return attacks_from<ROOK>(s);
448   case WQ: case BQ: return attacks_from<QUEEN>(s);
449   default: return StepAttacksBB[p][s];
450   }
451 }
452
453 Bitboard Position::attacks_from(Piece p, Square s, Bitboard occ) {
454
455   assert(square_is_ok(s));
456
457   switch (p)
458   {
459   case WB: case BB: return bishop_attacks_bb(s, occ);
460   case WR: case BR: return rook_attacks_bb(s, occ);
461   case WQ: case BQ: return bishop_attacks_bb(s, occ) | rook_attacks_bb(s, occ);
462   default: return StepAttacksBB[p][s];
463   }
464 }
465
466
467 /// Position::move_attacks_square() tests whether a move from the current
468 /// position attacks a given square.
469
470 bool Position::move_attacks_square(Move m, Square s) const {
471
472   assert(move_is_ok(m));
473   assert(square_is_ok(s));
474
475   Bitboard occ, xray;
476   Square f = move_from(m), t = move_to(m);
477
478   assert(!square_is_empty(f));
479
480   if (bit_is_set(attacks_from(piece_on(f), t), s))
481       return true;
482
483   // Move the piece and scan for X-ray attacks behind it
484   occ = occupied_squares();
485   do_move_bb(&occ, make_move_bb(f, t));
486   xray = ( (rook_attacks_bb(s, occ)   & pieces(ROOK, QUEEN))
487           |(bishop_attacks_bb(s, occ) & pieces(BISHOP, QUEEN)))
488          & pieces(piece_color(piece_on(f)));
489
490   // If we have attacks we need to verify that are caused by our move
491   // and are not already existent ones.
492   return xray && (xray ^ (xray & attacks_from<QUEEN>(s)));
493 }
494
495
496 /// Position::pl_move_is_legal() tests whether a pseudo-legal move is legal
497
498 bool Position::pl_move_is_legal(Move m, Bitboard pinned) const {
499
500   assert(is_ok());
501   assert(move_is_ok(m));
502   assert(pinned == pinned_pieces(side_to_move()));
503
504   Color us = side_to_move();
505   Square from = move_from(m);
506
507   assert(piece_color(piece_on(from)) == us);
508   assert(piece_on(king_square(us)) == make_piece(us, KING));
509
510   // En passant captures are a tricky special case. Because they are
511   // rather uncommon, we do it simply by testing whether the king is attacked
512   // after the move is made
513   if (move_is_ep(m))
514   {
515       Color them = opposite_color(us);
516       Square to = move_to(m);
517       Square capsq = make_square(square_file(to), square_rank(from));
518       Square ksq = king_square(us);
519       Bitboard b = occupied_squares();
520
521       assert(to == ep_square());
522       assert(piece_on(from) == make_piece(us, PAWN));
523       assert(piece_on(capsq) == make_piece(them, PAWN));
524       assert(piece_on(to) == PIECE_NONE);
525
526       clear_bit(&b, from);
527       clear_bit(&b, capsq);
528       set_bit(&b, to);
529
530       return   !(rook_attacks_bb(ksq, b) & pieces(ROOK, QUEEN, them))
531             && !(bishop_attacks_bb(ksq, b) & pieces(BISHOP, QUEEN, them));
532   }
533
534   // If the moving piece is a king, check whether the destination
535   // square is attacked by the opponent. Castling moves are checked
536   // for legality during move generation.
537   if (piece_type(piece_on(from)) == KING)
538       return move_is_castle(m) || !(attackers_to(move_to(m)) & pieces(opposite_color(us)));
539
540   // A non-king move is legal if and only if it is not pinned or it
541   // is moving along the ray towards or away from the king.
542   return   !pinned
543         || !bit_is_set(pinned, from)
544         ||  squares_aligned(from, move_to(m), king_square(us));
545 }
546
547
548 /// Position::move_is_pl_slow() takes a move and tests whether the move
549 /// is pseudo legal. This version is not very fast and should be used
550 /// only in non time-critical paths.
551
552 bool Position::move_is_pl_slow(const Move m) const {
553
554   MoveStack mlist[MAX_MOVES];
555   MoveStack *cur, *last;
556
557   last = in_check() ? generate<MV_EVASION>(*this, mlist)
558                     : generate<MV_NON_EVASION>(*this, mlist);
559
560   for (cur = mlist; cur != last; cur++)
561       if (cur->move == m)
562           return true;
563
564   return false;
565 }
566
567
568 /// Fast version of Position::move_is_pl() that takes a move and a bitboard
569 /// of pinned pieces as input, and tests whether the move is pseudo legal.
570
571 bool Position::move_is_pl(const Move m) const {
572
573   assert(is_ok());
574
575   Color us = sideToMove;
576   Color them = opposite_color(sideToMove);
577   Square from = move_from(m);
578   Square to = move_to(m);
579   Piece pc = piece_on(from);
580
581   // Use a slower but simpler function for uncommon cases
582   if (move_is_special(m))
583       return move_is_pl_slow(m);
584
585   // Is not a promotion, so promotion piece must be empty
586   if (promotion_piece_type(m) - 2 != PIECE_TYPE_NONE)
587       return false;
588
589   // If the from square is not occupied by a piece belonging to the side to
590   // move, the move is obviously not legal.
591   if (pc == PIECE_NONE || piece_color(pc) != us)
592       return false;
593
594   // The destination square cannot be occupied by a friendly piece
595   if (piece_color(piece_on(to)) == us)
596       return false;
597
598   // Handle the special case of a pawn move
599   if (piece_type(pc) == PAWN)
600   {
601       // Move direction must be compatible with pawn color
602       int direction = to - from;
603       if ((us == WHITE) != (direction > 0))
604           return false;
605
606       // We have already handled promotion moves, so destination
607       // cannot be on the 8/1th rank.
608       if (square_rank(to) == RANK_8 || square_rank(to) == RANK_1)
609           return false;
610
611       // Proceed according to the square delta between the origin and
612       // destination squares.
613       switch (direction)
614       {
615       case DELTA_NW:
616       case DELTA_NE:
617       case DELTA_SW:
618       case DELTA_SE:
619       // Capture. The destination square must be occupied by an enemy
620       // piece (en passant captures was handled earlier).
621       if (piece_color(piece_on(to)) != them)
622           return false;
623
624       // From and to files must be one file apart, avoids a7h5
625       if (abs(square_file(from) - square_file(to)) != 1)
626           return false;
627       break;
628
629       case DELTA_N:
630       case DELTA_S:
631       // Pawn push. The destination square must be empty.
632       if (!square_is_empty(to))
633           return false;
634       break;
635
636       case DELTA_NN:
637       // Double white pawn push. The destination square must be on the fourth
638       // rank, and both the destination square and the square between the
639       // source and destination squares must be empty.
640       if (   square_rank(to) != RANK_4
641           || !square_is_empty(to)
642           || !square_is_empty(from + DELTA_N))
643           return false;
644       break;
645
646       case DELTA_SS:
647       // Double black pawn push. The destination square must be on the fifth
648       // rank, and both the destination square and the square between the
649       // source and destination squares must be empty.
650       if (   square_rank(to) != RANK_5
651           || !square_is_empty(to)
652           || !square_is_empty(from + DELTA_S))
653           return false;
654       break;
655
656       default:
657           return false;
658       }
659   }
660   else if (!bit_is_set(attacks_from(pc, from), to))
661       return false;
662
663   if (in_check())
664   {
665       // In case of king moves under check we have to remove king so to catch
666       // as invalid moves like b1a1 when opposite queen is on c1.
667       if (piece_type(piece_on(from)) == KING)
668       {
669           Bitboard b = occupied_squares();
670           clear_bit(&b, from);
671           if (attackers_to(move_to(m), b) & pieces(opposite_color(us)))
672               return false;
673       }
674       else
675       {
676           Bitboard target = checkers();
677           Square checksq = pop_1st_bit(&target);
678
679           if (target) // double check ? In this case a king move is required
680               return false;
681
682           // Our move must be a blocking evasion or a capture of the checking piece
683           target = squares_between(checksq, king_square(us)) | checkers();
684           if (!bit_is_set(target, move_to(m)))
685               return false;
686       }
687   }
688
689   return true;
690 }
691
692
693 /// Position::move_gives_check() tests whether a pseudo-legal move is a check
694
695 bool Position::move_gives_check(Move m, const CheckInfo& ci) const {
696
697   assert(is_ok());
698   assert(move_is_ok(m));
699   assert(ci.dcCandidates == discovered_check_candidates(side_to_move()));
700   assert(piece_color(piece_on(move_from(m))) == side_to_move());
701
702   Square from = move_from(m);
703   Square to = move_to(m);
704   PieceType pt = piece_type(piece_on(from));
705
706   // Direct check ?
707   if (bit_is_set(ci.checkSq[pt], to))
708       return true;
709
710   // Discovery check ?
711   if (ci.dcCandidates && bit_is_set(ci.dcCandidates, from))
712   {
713       // For pawn and king moves we need to verify also direction
714       if (  (pt != PAWN && pt != KING)
715           || !squares_aligned(from, to, king_square(opposite_color(side_to_move()))))
716           return true;
717   }
718
719   // Can we skip the ugly special cases ?
720   if (!move_is_special(m))
721       return false;
722
723   Color us = side_to_move();
724   Bitboard b = occupied_squares();
725   Square ksq = king_square(opposite_color(us));
726
727   // Promotion with check ?
728   if (move_is_promotion(m))
729   {
730       clear_bit(&b, from);
731
732       switch (promotion_piece_type(m))
733       {
734       case KNIGHT:
735           return bit_is_set(attacks_from<KNIGHT>(to), ksq);
736       case BISHOP:
737           return bit_is_set(bishop_attacks_bb(to, b), ksq);
738       case ROOK:
739           return bit_is_set(rook_attacks_bb(to, b), ksq);
740       case QUEEN:
741           return bit_is_set(queen_attacks_bb(to, b), ksq);
742       default:
743           assert(false);
744       }
745   }
746
747   // En passant capture with check ? We have already handled the case
748   // of direct checks and ordinary discovered check, the only case we
749   // need to handle is the unusual case of a discovered check through
750   // the captured pawn.
751   if (move_is_ep(m))
752   {
753       Square capsq = make_square(square_file(to), square_rank(from));
754       clear_bit(&b, from);
755       clear_bit(&b, capsq);
756       set_bit(&b, to);
757       return  (rook_attacks_bb(ksq, b) & pieces(ROOK, QUEEN, us))
758             ||(bishop_attacks_bb(ksq, b) & pieces(BISHOP, QUEEN, us));
759   }
760
761   // Castling with check ?
762   if (move_is_castle(m))
763   {
764       Square kfrom, kto, rfrom, rto;
765       kfrom = from;
766       rfrom = to;
767
768       if (rfrom > kfrom)
769       {
770           kto = relative_square(us, SQ_G1);
771           rto = relative_square(us, SQ_F1);
772       } else {
773           kto = relative_square(us, SQ_C1);
774           rto = relative_square(us, SQ_D1);
775       }
776       clear_bit(&b, kfrom);
777       clear_bit(&b, rfrom);
778       set_bit(&b, rto);
779       set_bit(&b, kto);
780       return bit_is_set(rook_attacks_bb(rto, b), ksq);
781   }
782
783   return false;
784 }
785
786
787 /// Position::do_setup_move() makes a permanent move on the board. It should
788 /// be used when setting up a position on board. You can't undo the move.
789
790 void Position::do_setup_move(Move m) {
791
792   StateInfo newSt;
793
794   // Update the number of full moves after black's move
795   if (sideToMove == BLACK)
796       fullMoves++;
797
798   do_move(m, newSt);
799
800   // Reset "game ply" in case we made a non-reversible move.
801   // "game ply" is used for repetition detection.
802   if (st->rule50 == 0)
803       st->gamePly = 0;
804
805   // Our StateInfo newSt is about going out of scope so copy
806   // its content before it disappears.
807   detach();
808 }
809
810
811 /// Position::do_move() makes a move, and saves all information necessary
812 /// to a StateInfo object. The move is assumed to be legal. Pseudo-legal
813 /// moves should be filtered out before this function is called.
814
815 void Position::do_move(Move m, StateInfo& newSt) {
816
817   CheckInfo ci(*this);
818   do_move(m, newSt, ci, move_gives_check(m, ci));
819 }
820
821 void Position::do_move(Move m, StateInfo& newSt, const CheckInfo& ci, bool moveIsCheck) {
822
823   assert(is_ok());
824   assert(move_is_ok(m));
825   assert(&newSt != st);
826
827   nodes++;
828   Key key = st->key;
829
830   // Copy some fields of old state to our new StateInfo object except the
831   // ones which are recalculated from scratch anyway, then switch our state
832   // pointer to point to the new, ready to be updated, state.
833   struct ReducedStateInfo {
834     Key pawnKey, materialKey;
835     int castleRights, rule50, gamePly, pliesFromNull;
836     Square epSquare;
837     Score value;
838     Value npMaterial[2];
839   };
840
841   memcpy(&newSt, st, sizeof(ReducedStateInfo));
842
843   newSt.previous = st;
844   st = &newSt;
845
846   // Save the current key to the history[] array, in order to be able to
847   // detect repetition draws.
848   history[st->gamePly++] = key;
849
850   // Update side to move
851   key ^= zobSideToMove;
852
853   // Increment the 50 moves rule draw counter. Resetting it to zero in the
854   // case of non-reversible moves is taken care of later.
855   st->rule50++;
856   st->pliesFromNull++;
857
858   if (move_is_castle(m))
859   {
860       st->key = key;
861       do_castle_move(m);
862       return;
863   }
864
865   Color us = side_to_move();
866   Color them = opposite_color(us);
867   Square from = move_from(m);
868   Square to = move_to(m);
869   bool ep = move_is_ep(m);
870   bool pm = move_is_promotion(m);
871
872   Piece piece = piece_on(from);
873   PieceType pt = piece_type(piece);
874   PieceType capture = ep ? PAWN : piece_type(piece_on(to));
875
876   assert(piece_color(piece_on(from)) == us);
877   assert(piece_color(piece_on(to)) == them || square_is_empty(to));
878   assert(!(ep || pm) || piece == make_piece(us, PAWN));
879   assert(!pm || relative_rank(us, to) == RANK_8);
880
881   if (capture)
882       do_capture_move(key, capture, them, to, ep);
883
884   // Update hash key
885   key ^= zobrist[us][pt][from] ^ zobrist[us][pt][to];
886
887   // Reset en passant square
888   if (st->epSquare != SQ_NONE)
889   {
890       key ^= zobEp[st->epSquare];
891       st->epSquare = SQ_NONE;
892   }
893
894   // Update castle rights if needed
895   if (    st->castleRights != CASTLES_NONE
896       && (castleRightsMask[from] & castleRightsMask[to]) != ALL_CASTLES)
897   {
898       key ^= zobCastle[st->castleRights];
899       st->castleRights &= castleRightsMask[from] & castleRightsMask[to];
900       key ^= zobCastle[st->castleRights];
901   }
902
903   // Prefetch TT access as soon as we know key is updated
904   prefetch((char*)TT.first_entry(key));
905
906   // Move the piece
907   Bitboard move_bb = make_move_bb(from, to);
908   do_move_bb(&(byColorBB[us]), move_bb);
909   do_move_bb(&(byTypeBB[pt]), move_bb);
910   do_move_bb(&(byTypeBB[0]), move_bb); // HACK: byTypeBB[0] == occupied squares
911
912   board[to] = board[from];
913   board[from] = PIECE_NONE;
914
915   // Update piece lists, note that index[from] is not updated and
916   // becomes stale. This works as long as index[] is accessed just
917   // by known occupied squares.
918   index[to] = index[from];
919   pieceList[us][pt][index[to]] = to;
920
921   // If the moving piece was a pawn do some special extra work
922   if (pt == PAWN)
923   {
924       // Reset rule 50 draw counter
925       st->rule50 = 0;
926
927       // Update pawn hash key and prefetch in L1/L2 cache
928       st->pawnKey ^= zobrist[us][PAWN][from] ^ zobrist[us][PAWN][to];
929
930       // Set en passant square, only if moved pawn can be captured
931       if ((to ^ from) == 16)
932       {
933           if (attacks_from<PAWN>(from + (us == WHITE ? DELTA_N : DELTA_S), us) & pieces(PAWN, them))
934           {
935               st->epSquare = Square((int(from) + int(to)) / 2);
936               key ^= zobEp[st->epSquare];
937           }
938       }
939
940       if (pm) // promotion ?
941       {
942           PieceType promotion = promotion_piece_type(m);
943
944           assert(promotion >= KNIGHT && promotion <= QUEEN);
945
946           // Insert promoted piece instead of pawn
947           clear_bit(&(byTypeBB[PAWN]), to);
948           set_bit(&(byTypeBB[promotion]), to);
949           board[to] = make_piece(us, promotion);
950
951           // Update piece counts
952           pieceCount[us][promotion]++;
953           pieceCount[us][PAWN]--;
954
955           // Update material key
956           st->materialKey ^= zobrist[us][PAWN][pieceCount[us][PAWN]];
957           st->materialKey ^= zobrist[us][promotion][pieceCount[us][promotion]-1];
958
959           // Update piece lists, move the last pawn at index[to] position
960           // and shrink the list. Add a new promotion piece to the list.
961           Square lastPawnSquare = pieceList[us][PAWN][pieceCount[us][PAWN]];
962           index[lastPawnSquare] = index[to];
963           pieceList[us][PAWN][index[lastPawnSquare]] = lastPawnSquare;
964           pieceList[us][PAWN][pieceCount[us][PAWN]] = SQ_NONE;
965           index[to] = pieceCount[us][promotion] - 1;
966           pieceList[us][promotion][index[to]] = to;
967
968           // Partially revert hash keys update
969           key ^= zobrist[us][PAWN][to] ^ zobrist[us][promotion][to];
970           st->pawnKey ^= zobrist[us][PAWN][to];
971
972           // Partially revert and update incremental scores
973           st->value -= pst(make_piece(us, PAWN), to);
974           st->value += pst(make_piece(us, promotion), to);
975
976           // Update material
977           st->npMaterial[us] += PieceValueMidgame[promotion];
978       }
979   }
980
981   // Prefetch pawn and material hash tables
982   Threads[threadID].pawnTable.prefetch(st->pawnKey);
983   Threads[threadID].materialTable.prefetch(st->materialKey);
984
985   // Update incremental scores
986   st->value += pst_delta(piece, from, to);
987
988   // Set capture piece
989   st->capturedType = capture;
990
991   // Update the key with the final value
992   st->key = key;
993
994   // Update checkers bitboard, piece must be already moved
995   st->checkersBB = EmptyBoardBB;
996
997   if (moveIsCheck)
998   {
999       if (ep | pm)
1000           st->checkersBB = attackers_to(king_square(them)) & pieces(us);
1001       else
1002       {
1003           // Direct checks
1004           if (bit_is_set(ci.checkSq[pt], to))
1005               st->checkersBB = SetMaskBB[to];
1006
1007           // Discovery checks
1008           if (ci.dcCandidates && bit_is_set(ci.dcCandidates, from))
1009           {
1010               if (pt != ROOK)
1011                   st->checkersBB |= (attacks_from<ROOK>(king_square(them)) & pieces(ROOK, QUEEN, us));
1012
1013               if (pt != BISHOP)
1014                   st->checkersBB |= (attacks_from<BISHOP>(king_square(them)) & pieces(BISHOP, QUEEN, us));
1015           }
1016       }
1017   }
1018
1019   // Finish
1020   sideToMove = opposite_color(sideToMove);
1021   st->value += (sideToMove == WHITE ?  TempoValue : -TempoValue);
1022
1023   assert(is_ok());
1024 }
1025
1026
1027 /// Position::do_capture_move() is a private method used to update captured
1028 /// piece info. It is called from the main Position::do_move function.
1029
1030 void Position::do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep) {
1031
1032     assert(capture != KING);
1033
1034     Square capsq = to;
1035
1036     // If the captured piece was a pawn, update pawn hash key,
1037     // otherwise update non-pawn material.
1038     if (capture == PAWN)
1039     {
1040         if (ep) // en passant ?
1041         {
1042             capsq = (them == BLACK)? (to - DELTA_N) : (to - DELTA_S);
1043
1044             assert(to == st->epSquare);
1045             assert(relative_rank(opposite_color(them), to) == RANK_6);
1046             assert(piece_on(to) == PIECE_NONE);
1047             assert(piece_on(capsq) == make_piece(them, PAWN));
1048
1049             board[capsq] = PIECE_NONE;
1050         }
1051         st->pawnKey ^= zobrist[them][PAWN][capsq];
1052     }
1053     else
1054         st->npMaterial[them] -= PieceValueMidgame[capture];
1055
1056     // Remove captured piece
1057     clear_bit(&(byColorBB[them]), capsq);
1058     clear_bit(&(byTypeBB[capture]), capsq);
1059     clear_bit(&(byTypeBB[0]), capsq);
1060
1061     // Update hash key
1062     key ^= zobrist[them][capture][capsq];
1063
1064     // Update incremental scores
1065     st->value -= pst(make_piece(them, capture), capsq);
1066
1067     // Update piece count
1068     pieceCount[them][capture]--;
1069
1070     // Update material hash key
1071     st->materialKey ^= zobrist[them][capture][pieceCount[them][capture]];
1072
1073     // Update piece list, move the last piece at index[capsq] position
1074     //
1075     // WARNING: This is a not perfectly revresible operation. When we
1076     // will reinsert the captured piece in undo_move() we will put it
1077     // at the end of the list and not in its original place, it means
1078     // index[] and pieceList[] are not guaranteed to be invariant to a
1079     // do_move() + undo_move() sequence.
1080     Square lastPieceSquare = pieceList[them][capture][pieceCount[them][capture]];
1081     index[lastPieceSquare] = index[capsq];
1082     pieceList[them][capture][index[lastPieceSquare]] = lastPieceSquare;
1083     pieceList[them][capture][pieceCount[them][capture]] = SQ_NONE;
1084
1085     // Reset rule 50 counter
1086     st->rule50 = 0;
1087 }
1088
1089
1090 /// Position::do_castle_move() is a private method used to make a castling
1091 /// move. It is called from the main Position::do_move function. Note that
1092 /// castling moves are encoded as "king captures friendly rook" moves, for
1093 /// instance white short castling in a non-Chess960 game is encoded as e1h1.
1094
1095 void Position::do_castle_move(Move m) {
1096
1097   assert(move_is_ok(m));
1098   assert(move_is_castle(m));
1099
1100   Color us = side_to_move();
1101   Color them = opposite_color(us);
1102
1103   // Reset capture field
1104   st->capturedType = PIECE_TYPE_NONE;
1105
1106   // Find source squares for king and rook
1107   Square kfrom = move_from(m);
1108   Square rfrom = move_to(m);  // HACK: See comment at beginning of function
1109   Square kto, rto;
1110
1111   assert(piece_on(kfrom) == make_piece(us, KING));
1112   assert(piece_on(rfrom) == make_piece(us, ROOK));
1113
1114   // Find destination squares for king and rook
1115   if (rfrom > kfrom) // O-O
1116   {
1117       kto = relative_square(us, SQ_G1);
1118       rto = relative_square(us, SQ_F1);
1119   } else { // O-O-O
1120       kto = relative_square(us, SQ_C1);
1121       rto = relative_square(us, SQ_D1);
1122   }
1123
1124   // Remove pieces from source squares:
1125   clear_bit(&(byColorBB[us]), kfrom);
1126   clear_bit(&(byTypeBB[KING]), kfrom);
1127   clear_bit(&(byTypeBB[0]), kfrom); // HACK: byTypeBB[0] == occupied squares
1128   clear_bit(&(byColorBB[us]), rfrom);
1129   clear_bit(&(byTypeBB[ROOK]), rfrom);
1130   clear_bit(&(byTypeBB[0]), rfrom); // HACK: byTypeBB[0] == occupied squares
1131
1132   // Put pieces on destination squares:
1133   set_bit(&(byColorBB[us]), kto);
1134   set_bit(&(byTypeBB[KING]), kto);
1135   set_bit(&(byTypeBB[0]), kto); // HACK: byTypeBB[0] == occupied squares
1136   set_bit(&(byColorBB[us]), rto);
1137   set_bit(&(byTypeBB[ROOK]), rto);
1138   set_bit(&(byTypeBB[0]), rto); // HACK: byTypeBB[0] == occupied squares
1139
1140   // Update board array
1141   Piece king = make_piece(us, KING);
1142   Piece rook = make_piece(us, ROOK);
1143   board[kfrom] = board[rfrom] = PIECE_NONE;
1144   board[kto] = king;
1145   board[rto] = rook;
1146
1147   // Update piece lists
1148   pieceList[us][KING][index[kfrom]] = kto;
1149   pieceList[us][ROOK][index[rfrom]] = rto;
1150   int tmp = index[rfrom]; // In Chess960 could be rto == kfrom
1151   index[kto] = index[kfrom];
1152   index[rto] = tmp;
1153
1154   // Update incremental scores
1155   st->value += pst_delta(king, kfrom, kto);
1156   st->value += pst_delta(rook, rfrom, rto);
1157
1158   // Update hash key
1159   st->key ^= zobrist[us][KING][kfrom] ^ zobrist[us][KING][kto];
1160   st->key ^= zobrist[us][ROOK][rfrom] ^ zobrist[us][ROOK][rto];
1161
1162   // Clear en passant square
1163   if (st->epSquare != SQ_NONE)
1164   {
1165       st->key ^= zobEp[st->epSquare];
1166       st->epSquare = SQ_NONE;
1167   }
1168
1169   // Update castling rights
1170   st->key ^= zobCastle[st->castleRights];
1171   st->castleRights &= castleRightsMask[kfrom];
1172   st->key ^= zobCastle[st->castleRights];
1173
1174   // Reset rule 50 counter
1175   st->rule50 = 0;
1176
1177   // Update checkers BB
1178   st->checkersBB = attackers_to(king_square(them)) & pieces(us);
1179
1180   // Finish
1181   sideToMove = opposite_color(sideToMove);
1182   st->value += (sideToMove == WHITE ?  TempoValue : -TempoValue);
1183
1184   assert(is_ok());
1185 }
1186
1187
1188 /// Position::undo_move() unmakes a move. When it returns, the position should
1189 /// be restored to exactly the same state as before the move was made.
1190
1191 void Position::undo_move(Move m) {
1192
1193   assert(is_ok());
1194   assert(move_is_ok(m));
1195
1196   sideToMove = opposite_color(sideToMove);
1197
1198   if (move_is_castle(m))
1199   {
1200       undo_castle_move(m);
1201       return;
1202   }
1203
1204   Color us = side_to_move();
1205   Color them = opposite_color(us);
1206   Square from = move_from(m);
1207   Square to = move_to(m);
1208   bool ep = move_is_ep(m);
1209   bool pm = move_is_promotion(m);
1210
1211   PieceType pt = piece_type(piece_on(to));
1212
1213   assert(square_is_empty(from));
1214   assert(piece_color(piece_on(to)) == us);
1215   assert(!pm || relative_rank(us, to) == RANK_8);
1216   assert(!ep || to == st->previous->epSquare);
1217   assert(!ep || relative_rank(us, to) == RANK_6);
1218   assert(!ep || piece_on(to) == make_piece(us, PAWN));
1219
1220   if (pm) // promotion ?
1221   {
1222       PieceType promotion = promotion_piece_type(m);
1223       pt = PAWN;
1224
1225       assert(promotion >= KNIGHT && promotion <= QUEEN);
1226       assert(piece_on(to) == make_piece(us, promotion));
1227
1228       // Replace promoted piece with a pawn
1229       clear_bit(&(byTypeBB[promotion]), to);
1230       set_bit(&(byTypeBB[PAWN]), to);
1231
1232       // Update piece counts
1233       pieceCount[us][promotion]--;
1234       pieceCount[us][PAWN]++;
1235
1236       // Update piece list replacing promotion piece with a pawn
1237       Square lastPromotionSquare = pieceList[us][promotion][pieceCount[us][promotion]];
1238       index[lastPromotionSquare] = index[to];
1239       pieceList[us][promotion][index[lastPromotionSquare]] = lastPromotionSquare;
1240       pieceList[us][promotion][pieceCount[us][promotion]] = SQ_NONE;
1241       index[to] = pieceCount[us][PAWN] - 1;
1242       pieceList[us][PAWN][index[to]] = to;
1243   }
1244
1245   // Put the piece back at the source square
1246   Bitboard move_bb = make_move_bb(to, from);
1247   do_move_bb(&(byColorBB[us]), move_bb);
1248   do_move_bb(&(byTypeBB[pt]), move_bb);
1249   do_move_bb(&(byTypeBB[0]), move_bb); // HACK: byTypeBB[0] == occupied squares
1250
1251   board[from] = make_piece(us, pt);
1252   board[to] = PIECE_NONE;
1253
1254   // Update piece list
1255   index[from] = index[to];
1256   pieceList[us][pt][index[from]] = from;
1257
1258   if (st->capturedType)
1259   {
1260       Square capsq = to;
1261
1262       if (ep)
1263           capsq = (us == WHITE)? (to - DELTA_N) : (to - DELTA_S);
1264
1265       assert(st->capturedType != KING);
1266       assert(!ep || square_is_empty(capsq));
1267
1268       // Restore the captured piece
1269       set_bit(&(byColorBB[them]), capsq);
1270       set_bit(&(byTypeBB[st->capturedType]), capsq);
1271       set_bit(&(byTypeBB[0]), capsq);
1272
1273       board[capsq] = make_piece(them, st->capturedType);
1274
1275       // Update piece count
1276       pieceCount[them][st->capturedType]++;
1277
1278       // Update piece list, add a new captured piece in capsq square
1279       index[capsq] = pieceCount[them][st->capturedType] - 1;
1280       pieceList[them][st->capturedType][index[capsq]] = capsq;
1281   }
1282
1283   // Finally point our state pointer back to the previous state
1284   st = st->previous;
1285
1286   assert(is_ok());
1287 }
1288
1289
1290 /// Position::undo_castle_move() is a private method used to unmake a castling
1291 /// move. It is called from the main Position::undo_move function. Note that
1292 /// castling moves are encoded as "king captures friendly rook" moves, for
1293 /// instance white short castling in a non-Chess960 game is encoded as e1h1.
1294
1295 void Position::undo_castle_move(Move m) {
1296
1297   assert(move_is_ok(m));
1298   assert(move_is_castle(m));
1299
1300   // When we have arrived here, some work has already been done by
1301   // Position::undo_move.  In particular, the side to move has been switched,
1302   // so the code below is correct.
1303   Color us = side_to_move();
1304
1305   // Find source squares for king and rook
1306   Square kfrom = move_from(m);
1307   Square rfrom = move_to(m);  // HACK: See comment at beginning of function
1308   Square kto, rto;
1309
1310   // Find destination squares for king and rook
1311   if (rfrom > kfrom) // O-O
1312   {
1313       kto = relative_square(us, SQ_G1);
1314       rto = relative_square(us, SQ_F1);
1315   } else { // O-O-O
1316       kto = relative_square(us, SQ_C1);
1317       rto = relative_square(us, SQ_D1);
1318   }
1319
1320   assert(piece_on(kto) == make_piece(us, KING));
1321   assert(piece_on(rto) == make_piece(us, ROOK));
1322
1323   // Remove pieces from destination squares:
1324   clear_bit(&(byColorBB[us]), kto);
1325   clear_bit(&(byTypeBB[KING]), kto);
1326   clear_bit(&(byTypeBB[0]), kto); // HACK: byTypeBB[0] == occupied squares
1327   clear_bit(&(byColorBB[us]), rto);
1328   clear_bit(&(byTypeBB[ROOK]), rto);
1329   clear_bit(&(byTypeBB[0]), rto); // HACK: byTypeBB[0] == occupied squares
1330
1331   // Put pieces on source squares:
1332   set_bit(&(byColorBB[us]), kfrom);
1333   set_bit(&(byTypeBB[KING]), kfrom);
1334   set_bit(&(byTypeBB[0]), kfrom); // HACK: byTypeBB[0] == occupied squares
1335   set_bit(&(byColorBB[us]), rfrom);
1336   set_bit(&(byTypeBB[ROOK]), rfrom);
1337   set_bit(&(byTypeBB[0]), rfrom); // HACK: byTypeBB[0] == occupied squares
1338
1339   // Update board
1340   board[rto] = board[kto] = PIECE_NONE;
1341   board[rfrom] = make_piece(us, ROOK);
1342   board[kfrom] = make_piece(us, KING);
1343
1344   // Update piece lists
1345   pieceList[us][KING][index[kto]] = kfrom;
1346   pieceList[us][ROOK][index[rto]] = rfrom;
1347   int tmp = index[rto];  // In Chess960 could be rto == kfrom
1348   index[kfrom] = index[kto];
1349   index[rfrom] = tmp;
1350
1351   // Finally point our state pointer back to the previous state
1352   st = st->previous;
1353
1354   assert(is_ok());
1355 }
1356
1357
1358 /// Position::do_null_move makes() a "null move": It switches the side to move
1359 /// and updates the hash key without executing any move on the board.
1360
1361 void Position::do_null_move(StateInfo& backupSt) {
1362
1363   assert(is_ok());
1364   assert(!in_check());
1365
1366   // Back up the information necessary to undo the null move to the supplied
1367   // StateInfo object.
1368   // Note that differently from normal case here backupSt is actually used as
1369   // a backup storage not as a new state to be used.
1370   backupSt.key      = st->key;
1371   backupSt.epSquare = st->epSquare;
1372   backupSt.value    = st->value;
1373   backupSt.previous = st->previous;
1374   backupSt.pliesFromNull = st->pliesFromNull;
1375   st->previous = &backupSt;
1376
1377   // Save the current key to the history[] array, in order to be able to
1378   // detect repetition draws.
1379   history[st->gamePly++] = st->key;
1380
1381   // Update the necessary information
1382   if (st->epSquare != SQ_NONE)
1383       st->key ^= zobEp[st->epSquare];
1384
1385   st->key ^= zobSideToMove;
1386   prefetch((char*)TT.first_entry(st->key));
1387
1388   sideToMove = opposite_color(sideToMove);
1389   st->epSquare = SQ_NONE;
1390   st->rule50++;
1391   st->pliesFromNull = 0;
1392   st->value += (sideToMove == WHITE) ?  TempoValue : -TempoValue;
1393 }
1394
1395
1396 /// Position::undo_null_move() unmakes a "null move".
1397
1398 void Position::undo_null_move() {
1399
1400   assert(is_ok());
1401   assert(!in_check());
1402
1403   // Restore information from the our backup StateInfo object
1404   StateInfo* backupSt = st->previous;
1405   st->key      = backupSt->key;
1406   st->epSquare = backupSt->epSquare;
1407   st->value    = backupSt->value;
1408   st->previous = backupSt->previous;
1409   st->pliesFromNull = backupSt->pliesFromNull;
1410
1411   // Update the necessary information
1412   sideToMove = opposite_color(sideToMove);
1413   st->rule50--;
1414   st->gamePly--;
1415 }
1416
1417
1418 /// Position::see() is a static exchange evaluator: It tries to estimate the
1419 /// material gain or loss resulting from a move. There are three versions of
1420 /// this function: One which takes a destination square as input, one takes a
1421 /// move, and one which takes a 'from' and a 'to' square. The function does
1422 /// not yet understand promotions captures.
1423
1424 int Position::see_sign(Move m) const {
1425
1426   assert(move_is_ok(m));
1427
1428   Square from = move_from(m);
1429   Square to = move_to(m);
1430
1431   // Early return if SEE cannot be negative because captured piece value
1432   // is not less then capturing one. Note that king moves always return
1433   // here because king midgame value is set to 0.
1434   if (piece_value_midgame(piece_on(to)) >= piece_value_midgame(piece_on(from)))
1435       return 1;
1436
1437   return see(m);
1438 }
1439
1440 int Position::see(Move m) const {
1441
1442   Square from, to;
1443   Bitboard occupied, attackers, stmAttackers, b;
1444   int swapList[32], slIndex = 1;
1445   PieceType capturedType, pt;
1446   Color stm;
1447
1448   assert(move_is_ok(m));
1449
1450   // As castle moves are implemented as capturing the rook, they have
1451   // SEE == RookValueMidgame most of the times (unless the rook is under
1452   // attack).
1453   if (move_is_castle(m))
1454       return 0;
1455
1456   from = move_from(m);
1457   to = move_to(m);
1458   capturedType = piece_type(piece_on(to));
1459   occupied = occupied_squares();
1460
1461   // Handle en passant moves
1462   if (st->epSquare == to && piece_type(piece_on(from)) == PAWN)
1463   {
1464       Square capQq = (side_to_move() == WHITE ? to - DELTA_N : to - DELTA_S);
1465
1466       assert(capturedType == PIECE_TYPE_NONE);
1467       assert(piece_type(piece_on(capQq)) == PAWN);
1468
1469       // Remove the captured pawn
1470       clear_bit(&occupied, capQq);
1471       capturedType = PAWN;
1472   }
1473
1474   // Find all attackers to the destination square, with the moving piece
1475   // removed, but possibly an X-ray attacker added behind it.
1476   clear_bit(&occupied, from);
1477   attackers = attackers_to(to, occupied);
1478
1479   // If the opponent has no attackers we are finished
1480   stm = opposite_color(piece_color(piece_on(from)));
1481   stmAttackers = attackers & pieces(stm);
1482   if (!stmAttackers)
1483       return PieceValueMidgame[capturedType];
1484
1485   // The destination square is defended, which makes things rather more
1486   // difficult to compute. We proceed by building up a "swap list" containing
1487   // the material gain or loss at each stop in a sequence of captures to the
1488   // destination square, where the sides alternately capture, and always
1489   // capture with the least valuable piece. After each capture, we look for
1490   // new X-ray attacks from behind the capturing piece.
1491   swapList[0] = PieceValueMidgame[capturedType];
1492   capturedType = piece_type(piece_on(from));
1493
1494   do {
1495       // Locate the least valuable attacker for the side to move. The loop
1496       // below looks like it is potentially infinite, but it isn't. We know
1497       // that the side to move still has at least one attacker left.
1498       for (pt = PAWN; !(stmAttackers & pieces(pt)); pt++)
1499           assert(pt < KING);
1500
1501       // Remove the attacker we just found from the 'occupied' bitboard,
1502       // and scan for new X-ray attacks behind the attacker.
1503       b = stmAttackers & pieces(pt);
1504       occupied ^= (b & (~b + 1));
1505       attackers |=  (rook_attacks_bb(to, occupied)   & pieces(ROOK, QUEEN))
1506                   | (bishop_attacks_bb(to, occupied) & pieces(BISHOP, QUEEN));
1507
1508       attackers &= occupied; // Cut out pieces we've already done
1509
1510       // Add the new entry to the swap list
1511       assert(slIndex < 32);
1512       swapList[slIndex] = -swapList[slIndex - 1] + PieceValueMidgame[capturedType];
1513       slIndex++;
1514
1515       // Remember the value of the capturing piece, and change the side to
1516       // move before beginning the next iteration.
1517       capturedType = pt;
1518       stm = opposite_color(stm);
1519       stmAttackers = attackers & pieces(stm);
1520
1521       // Stop before processing a king capture
1522       if (capturedType == KING && stmAttackers)
1523       {
1524           assert(slIndex < 32);
1525           swapList[slIndex++] = QueenValueMidgame*10;
1526           break;
1527       }
1528   } while (stmAttackers);
1529
1530   // Having built the swap list, we negamax through it to find the best
1531   // achievable score from the point of view of the side to move.
1532   while (--slIndex)
1533       swapList[slIndex-1] = Min(-swapList[slIndex], swapList[slIndex-1]);
1534
1535   return swapList[0];
1536 }
1537
1538
1539 /// Position::clear() erases the position object to a pristine state, with an
1540 /// empty board, white to move, and no castling rights.
1541
1542 void Position::clear() {
1543
1544   st = &startState;
1545   memset(st, 0, sizeof(StateInfo));
1546   st->epSquare = SQ_NONE;
1547
1548   memset(byColorBB,  0, sizeof(Bitboard) * 2);
1549   memset(byTypeBB,   0, sizeof(Bitboard) * 8);
1550   memset(pieceCount, 0, sizeof(int) * 2 * 8);
1551   memset(index,      0, sizeof(int) * 64);
1552
1553   for (int i = 0; i < 8; i++)
1554       for (int j = 0; j < 16; j++)
1555           pieceList[0][i][j] = pieceList[1][i][j] = SQ_NONE;
1556
1557   for (Square sq = SQ_A1; sq <= SQ_H8; sq++)
1558   {
1559       board[sq] = PIECE_NONE;
1560       castleRightsMask[sq] = ALL_CASTLES;
1561   }
1562   sideToMove = WHITE;
1563   fullMoves = 1;
1564   nodes = 0;
1565 }
1566
1567
1568 /// Position::put_piece() puts a piece on the given square of the board,
1569 /// updating the board array, pieces list, bitboards, and piece counts.
1570
1571 void Position::put_piece(Piece p, Square s) {
1572
1573   Color c = piece_color(p);
1574   PieceType pt = piece_type(p);
1575
1576   board[s] = p;
1577   index[s] = pieceCount[c][pt]++;
1578   pieceList[c][pt][index[s]] = s;
1579
1580   set_bit(&byTypeBB[pt], s);
1581   set_bit(&byColorBB[c], s);
1582   set_bit(&byTypeBB[0], s); // HACK: byTypeBB[0] contains all occupied squares.
1583 }
1584
1585
1586 /// Position::compute_key() computes the hash key of the position. The hash
1587 /// key is usually updated incrementally as moves are made and unmade, the
1588 /// compute_key() function is only used when a new position is set up, and
1589 /// to verify the correctness of the hash key when running in debug mode.
1590
1591 Key Position::compute_key() const {
1592
1593   Key result = zobCastle[st->castleRights];
1594
1595   for (Square s = SQ_A1; s <= SQ_H8; s++)
1596       if (!square_is_empty(s))
1597           result ^= zobrist[piece_color(piece_on(s))][piece_type(piece_on(s))][s];
1598
1599   if (ep_square() != SQ_NONE)
1600       result ^= zobEp[ep_square()];
1601
1602   if (side_to_move() == BLACK)
1603       result ^= zobSideToMove;
1604
1605   return result;
1606 }
1607
1608
1609 /// Position::compute_pawn_key() computes the hash key of the position. The
1610 /// hash key is usually updated incrementally as moves are made and unmade,
1611 /// the compute_pawn_key() function is only used when a new position is set
1612 /// up, and to verify the correctness of the pawn hash key when running in
1613 /// debug mode.
1614
1615 Key Position::compute_pawn_key() const {
1616
1617   Bitboard b;
1618   Key result = 0;
1619
1620   for (Color c = WHITE; c <= BLACK; c++)
1621   {
1622       b = pieces(PAWN, c);
1623       while (b)
1624           result ^= zobrist[c][PAWN][pop_1st_bit(&b)];
1625   }
1626   return result;
1627 }
1628
1629
1630 /// Position::compute_material_key() computes the hash key of the position.
1631 /// The hash key is usually updated incrementally as moves are made and unmade,
1632 /// the compute_material_key() function is only used when a new position is set
1633 /// up, and to verify the correctness of the material hash key when running in
1634 /// debug mode.
1635
1636 Key Position::compute_material_key() const {
1637
1638   Key result = 0;
1639
1640   for (Color c = WHITE; c <= BLACK; c++)
1641       for (PieceType pt = PAWN; pt <= QUEEN; pt++)
1642           for (int i = 0, cnt = piece_count(c, pt); i < cnt; i++)
1643               result ^= zobrist[c][pt][i];
1644
1645   return result;
1646 }
1647
1648
1649 /// Position::compute_value() compute the incremental scores for the middle
1650 /// game and the endgame. These functions are used to initialize the incremental
1651 /// scores when a new position is set up, and to verify that the scores are correctly
1652 /// updated by do_move and undo_move when the program is running in debug mode.
1653 Score Position::compute_value() const {
1654
1655   Bitboard b;
1656   Score result = SCORE_ZERO;
1657
1658   for (Color c = WHITE; c <= BLACK; c++)
1659       for (PieceType pt = PAWN; pt <= KING; pt++)
1660       {
1661           b = pieces(pt, c);
1662           while (b)
1663               result += pst(make_piece(c, pt), pop_1st_bit(&b));
1664       }
1665
1666   result += (side_to_move() == WHITE ? TempoValue / 2 : -TempoValue / 2);
1667   return result;
1668 }
1669
1670
1671 /// Position::compute_non_pawn_material() computes the total non-pawn middle
1672 /// game material value for the given side. Material values are updated
1673 /// incrementally during the search, this function is only used while
1674 /// initializing a new Position object.
1675
1676 Value Position::compute_non_pawn_material(Color c) const {
1677
1678   Value result = VALUE_ZERO;
1679
1680   for (PieceType pt = KNIGHT; pt <= QUEEN; pt++)
1681       result += piece_count(c, pt) * PieceValueMidgame[pt];
1682
1683   return result;
1684 }
1685
1686
1687 /// Position::is_draw() tests whether the position is drawn by material,
1688 /// repetition, or the 50 moves rule. It does not detect stalemates, this
1689 /// must be done by the search.
1690 template<bool SkipRepetition>
1691 bool Position::is_draw() const {
1692
1693   // Draw by material?
1694   if (   !pieces(PAWN)
1695       && (non_pawn_material(WHITE) + non_pawn_material(BLACK) <= BishopValueMidgame))
1696       return true;
1697
1698   // Draw by the 50 moves rule?
1699   if (st->rule50 > 99 && !is_mate())
1700       return true;
1701
1702   // Draw by repetition?
1703   if (!SkipRepetition)
1704       for (int i = 4, e = Min(Min(st->gamePly, st->rule50), st->pliesFromNull); i <= e; i += 2)
1705           if (history[st->gamePly - i] == st->key)
1706               return true;
1707
1708   return false;
1709 }
1710
1711 // Explicit template instantiations
1712 template bool Position::is_draw<false>() const;
1713 template bool Position::is_draw<true>() const;
1714
1715
1716 /// Position::is_mate() returns true or false depending on whether the
1717 /// side to move is checkmated.
1718
1719 bool Position::is_mate() const {
1720
1721   MoveStack moves[MAX_MOVES];
1722   return in_check() && generate<MV_LEGAL>(*this, moves) == moves;
1723 }
1724
1725
1726 /// Position::init() is a static member function which initializes at
1727 /// startup the various arrays used to compute hash keys and the piece
1728 /// square tables. The latter is a two-step operation: First, the white
1729 /// halves of the tables are copied from the MgPST[][] and EgPST[][] arrays.
1730 /// Second, the black halves of the tables are initialized by mirroring
1731 /// and changing the sign of the corresponding white scores.
1732
1733 void Position::init() {
1734
1735   RKISS rk;
1736
1737   for (Color c = WHITE; c <= BLACK; c++)
1738       for (PieceType pt = PAWN; pt <= KING; pt++)
1739           for (Square s = SQ_A1; s <= SQ_H8; s++)
1740               zobrist[c][pt][s] = rk.rand<Key>();
1741
1742   for (Square s = SQ_A1; s <= SQ_H8; s++)
1743       zobEp[s] = rk.rand<Key>();
1744
1745   for (int i = 0; i < 16; i++)
1746       zobCastle[i] = rk.rand<Key>();
1747
1748   zobSideToMove = rk.rand<Key>();
1749   zobExclusion  = rk.rand<Key>();
1750
1751   for (Square s = SQ_A1; s <= SQ_H8; s++)
1752       for (Piece p = WP; p <= WK; p++)
1753           pieceSquareTable[p][s] = make_score(MgPST[p][s], EgPST[p][s]);
1754
1755   for (Square s = SQ_A1; s <= SQ_H8; s++)
1756       for (Piece p = BP; p <= BK; p++)
1757           pieceSquareTable[p][s] = -pieceSquareTable[p-8][flip_square(s)];
1758 }
1759
1760
1761 /// Position::flip() flips position with the white and black sides reversed. This
1762 /// is only useful for debugging especially for finding evaluation symmetry bugs.
1763
1764 void Position::flip() {
1765
1766   assert(is_ok());
1767
1768   // Make a copy of current position before to start changing
1769   const Position pos(*this, threadID);
1770
1771   clear();
1772   threadID = pos.thread();
1773
1774   // Board
1775   for (Square s = SQ_A1; s <= SQ_H8; s++)
1776       if (!pos.square_is_empty(s))
1777           put_piece(Piece(pos.piece_on(s) ^ 8), flip_square(s));
1778
1779   // Side to move
1780   sideToMove = opposite_color(pos.side_to_move());
1781
1782   // Castling rights
1783   if (pos.can_castle(WHITE_OO))
1784       set_castle(BLACK_OO,  king_square(BLACK), flip_square(pos.castle_rook_square(WHITE_OO)));
1785   if (pos.can_castle(WHITE_OOO))
1786       set_castle(BLACK_OOO, king_square(BLACK), flip_square(pos.castle_rook_square(WHITE_OOO)));
1787   if (pos.can_castle(BLACK_OO))
1788       set_castle(WHITE_OO,  king_square(WHITE), flip_square(pos.castle_rook_square(BLACK_OO)));
1789   if (pos.can_castle(BLACK_OOO))
1790       set_castle(WHITE_OOO, king_square(WHITE), flip_square(pos.castle_rook_square(BLACK_OOO)));
1791
1792   // En passant square
1793   if (pos.st->epSquare != SQ_NONE)
1794       st->epSquare = flip_square(pos.st->epSquare);
1795
1796   // Checkers
1797   st->checkersBB = attackers_to(king_square(sideToMove)) & pieces(opposite_color(sideToMove));
1798
1799   // Hash keys
1800   st->key = compute_key();
1801   st->pawnKey = compute_pawn_key();
1802   st->materialKey = compute_material_key();
1803
1804   // Incremental scores
1805   st->value = compute_value();
1806
1807   // Material
1808   st->npMaterial[WHITE] = compute_non_pawn_material(WHITE);
1809   st->npMaterial[BLACK] = compute_non_pawn_material(BLACK);
1810
1811   assert(is_ok());
1812 }
1813
1814
1815 /// Position::is_ok() performs some consitency checks for the position object.
1816 /// This is meant to be helpful when debugging.
1817
1818 bool Position::is_ok(int* failedStep) const {
1819
1820   // What features of the position should be verified?
1821   const bool debugAll = false;
1822
1823   const bool debugBitboards       = debugAll || false;
1824   const bool debugKingCount       = debugAll || false;
1825   const bool debugKingCapture     = debugAll || false;
1826   const bool debugCheckerCount    = debugAll || false;
1827   const bool debugKey             = debugAll || false;
1828   const bool debugMaterialKey     = debugAll || false;
1829   const bool debugPawnKey         = debugAll || false;
1830   const bool debugIncrementalEval = debugAll || false;
1831   const bool debugNonPawnMaterial = debugAll || false;
1832   const bool debugPieceCounts     = debugAll || false;
1833   const bool debugPieceList       = debugAll || false;
1834   const bool debugCastleSquares   = debugAll || false;
1835
1836   if (failedStep) *failedStep = 1;
1837
1838   // Side to move OK?
1839   if (side_to_move() != WHITE && side_to_move() != BLACK)
1840       return false;
1841
1842   // Are the king squares in the position correct?
1843   if (failedStep) (*failedStep)++;
1844   if (piece_on(king_square(WHITE)) != WK)
1845       return false;
1846
1847   if (failedStep) (*failedStep)++;
1848   if (piece_on(king_square(BLACK)) != BK)
1849       return false;
1850
1851   // Do both sides have exactly one king?
1852   if (failedStep) (*failedStep)++;
1853   if (debugKingCount)
1854   {
1855       int kingCount[2] = {0, 0};
1856       for (Square s = SQ_A1; s <= SQ_H8; s++)
1857           if (piece_type(piece_on(s)) == KING)
1858               kingCount[piece_color(piece_on(s))]++;
1859
1860       if (kingCount[0] != 1 || kingCount[1] != 1)
1861           return false;
1862   }
1863
1864   // Can the side to move capture the opponent's king?
1865   if (failedStep) (*failedStep)++;
1866   if (debugKingCapture)
1867   {
1868       Color us = side_to_move();
1869       Color them = opposite_color(us);
1870       Square ksq = king_square(them);
1871       if (attackers_to(ksq) & pieces(us))
1872           return false;
1873   }
1874
1875   // Is there more than 2 checkers?
1876   if (failedStep) (*failedStep)++;
1877   if (debugCheckerCount && count_1s<CNT32>(st->checkersBB) > 2)
1878       return false;
1879
1880   // Bitboards OK?
1881   if (failedStep) (*failedStep)++;
1882   if (debugBitboards)
1883   {
1884       // The intersection of the white and black pieces must be empty
1885       if ((pieces(WHITE) & pieces(BLACK)) != EmptyBoardBB)
1886           return false;
1887
1888       // The union of the white and black pieces must be equal to all
1889       // occupied squares
1890       if ((pieces(WHITE) | pieces(BLACK)) != occupied_squares())
1891           return false;
1892
1893       // Separate piece type bitboards must have empty intersections
1894       for (PieceType p1 = PAWN; p1 <= KING; p1++)
1895           for (PieceType p2 = PAWN; p2 <= KING; p2++)
1896               if (p1 != p2 && (pieces(p1) & pieces(p2)))
1897                   return false;
1898   }
1899
1900   // En passant square OK?
1901   if (failedStep) (*failedStep)++;
1902   if (ep_square() != SQ_NONE)
1903   {
1904       // The en passant square must be on rank 6, from the point of view of the
1905       // side to move.
1906       if (relative_rank(side_to_move(), ep_square()) != RANK_6)
1907           return false;
1908   }
1909
1910   // Hash key OK?
1911   if (failedStep) (*failedStep)++;
1912   if (debugKey && st->key != compute_key())
1913       return false;
1914
1915   // Pawn hash key OK?
1916   if (failedStep) (*failedStep)++;
1917   if (debugPawnKey && st->pawnKey != compute_pawn_key())
1918       return false;
1919
1920   // Material hash key OK?
1921   if (failedStep) (*failedStep)++;
1922   if (debugMaterialKey && st->materialKey != compute_material_key())
1923       return false;
1924
1925   // Incremental eval OK?
1926   if (failedStep) (*failedStep)++;
1927   if (debugIncrementalEval && st->value != compute_value())
1928       return false;
1929
1930   // Non-pawn material OK?
1931   if (failedStep) (*failedStep)++;
1932   if (debugNonPawnMaterial)
1933   {
1934       if (st->npMaterial[WHITE] != compute_non_pawn_material(WHITE))
1935           return false;
1936
1937       if (st->npMaterial[BLACK] != compute_non_pawn_material(BLACK))
1938           return false;
1939   }
1940
1941   // Piece counts OK?
1942   if (failedStep) (*failedStep)++;
1943   if (debugPieceCounts)
1944       for (Color c = WHITE; c <= BLACK; c++)
1945           for (PieceType pt = PAWN; pt <= KING; pt++)
1946               if (pieceCount[c][pt] != count_1s<CNT32>(pieces(pt, c)))
1947                   return false;
1948
1949   if (failedStep) (*failedStep)++;
1950   if (debugPieceList)
1951       for (Color c = WHITE; c <= BLACK; c++)
1952           for (PieceType pt = PAWN; pt <= KING; pt++)
1953               for (int i = 0; i < pieceCount[c][pt]; i++)
1954               {
1955                   if (piece_on(piece_list(c, pt)[i]) != make_piece(c, pt))
1956                       return false;
1957
1958                   if (index[piece_list(c, pt)[i]] != i)
1959                       return false;
1960               }
1961
1962   if (failedStep) (*failedStep)++;
1963   if (debugCastleSquares)
1964       for (CastleRight f = WHITE_OO; f <= BLACK_OOO; f = CastleRight(f << 1))
1965       {
1966           if (!can_castle(f))
1967               continue;
1968
1969           Piece rook = (f & (WHITE_OO | WHITE_OOO) ? WR : BR);
1970
1971           if (   castleRightsMask[castleRookSquare[f]] != (ALL_CASTLES ^ f)
1972               || piece_on(castleRookSquare[f]) != rook)
1973               return false;
1974       }
1975
1976   if (failedStep) *failedStep = 0;
1977   return true;
1978 }