Replace std::mins/max with clamp function (#2062)
[stockfish] / src / bitboard.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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2019 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 #include <bitset>
22 #include <algorithm>
23
24 #include "bitboard.h"
25 #include "misc.h"
26
27 uint8_t PopCnt16[1 << 16];
28 uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
29
30 Bitboard SquareBB[SQUARE_NB];
31 Bitboard ForwardRanksBB[COLOR_NB][RANK_NB];
32 Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
33 Bitboard LineBB[SQUARE_NB][SQUARE_NB];
34 Bitboard DistanceRingBB[SQUARE_NB][8];
35 Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
36 Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
37
38 Bitboard KingFlank[FILE_NB] = {
39   QueenSide ^ FileDBB, QueenSide, QueenSide,
40   CenterFiles, CenterFiles,
41   KingSide, KingSide, KingSide ^ FileEBB
42 };
43
44 Magic RookMagics[SQUARE_NB];
45 Magic BishopMagics[SQUARE_NB];
46
47 namespace {
48
49   Bitboard RookTable[0x19000];  // To store rook attacks
50   Bitboard BishopTable[0x1480]; // To store bishop attacks
51
52   void init_magics(Bitboard table[], Magic magics[], Direction directions[]);
53 }
54
55
56 /// Bitboards::pretty() returns an ASCII representation of a bitboard suitable
57 /// to be printed to standard output. Useful for debugging.
58
59 const std::string Bitboards::pretty(Bitboard b) {
60
61   std::string s = "+---+---+---+---+---+---+---+---+\n";
62
63   for (Rank r = RANK_8; r >= RANK_1; --r)
64   {
65       for (File f = FILE_A; f <= FILE_H; ++f)
66           s += b & make_square(f, r) ? "| X " : "|   ";
67
68       s += "|\n+---+---+---+---+---+---+---+---+\n";
69   }
70
71   return s;
72 }
73
74
75 /// Bitboards::init() initializes various bitboard tables. It is called at
76 /// startup and relies on global objects to be already zero-initialized.
77
78 void Bitboards::init() {
79
80   for (unsigned i = 0; i < (1 << 16); ++i)
81       PopCnt16[i] = std::bitset<16>(i).count();
82
83   for (Square s = SQ_A1; s <= SQ_H8; ++s)
84       SquareBB[s] = (1ULL << s);
85
86   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
87       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
88           {
89               SquareDistance[s1][s2] = std::max(distance<File>(s1, s2), distance<Rank>(s1, s2));
90               DistanceRingBB[s1][SquareDistance[s1][s2]] |= s2;
91           }
92
93   int steps[][5] = { {}, { 7, 9 }, { 6, 10, 15, 17 }, {}, {}, {}, { 1, 7, 8, 9 } };
94
95   for (Color c = WHITE; c <= BLACK; ++c)
96       for (PieceType pt : { PAWN, KNIGHT, KING })
97           for (Square s = SQ_A1; s <= SQ_H8; ++s)
98               for (int i = 0; steps[pt][i]; ++i)
99               {
100                   Square to = s + Direction(c == WHITE ? steps[pt][i] : -steps[pt][i]);
101
102                   if (is_ok(to) && distance(s, to) < 3)
103                   {
104                       if (pt == PAWN)
105                           PawnAttacks[c][s] |= to;
106                       else
107                           PseudoAttacks[pt][s] |= to;
108                   }
109               }
110
111   Direction RookDirections[] = { NORTH, EAST, SOUTH, WEST };
112   Direction BishopDirections[] = { NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST };
113
114   init_magics(RookTable, RookMagics, RookDirections);
115   init_magics(BishopTable, BishopMagics, BishopDirections);
116
117   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
118   {
119       PseudoAttacks[QUEEN][s1]  = PseudoAttacks[BISHOP][s1] = attacks_bb<BISHOP>(s1, 0);
120       PseudoAttacks[QUEEN][s1] |= PseudoAttacks[  ROOK][s1] = attacks_bb<  ROOK>(s1, 0);
121
122       for (PieceType pt : { BISHOP, ROOK })
123           for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
124               if (PseudoAttacks[pt][s1] & s2)
125               {
126                   LineBB[s1][s2] = (attacks_bb(pt, s1, 0) & attacks_bb(pt, s2, 0)) | s1 | s2;
127                   BetweenBB[s1][s2] = attacks_bb(pt, s1, square_bb(s2)) & attacks_bb(pt, s2, square_bb(s1));
128               }
129   }
130 }
131
132
133 namespace {
134
135   Bitboard sliding_attack(Direction directions[], Square sq, Bitboard occupied) {
136
137     Bitboard attack = 0;
138
139     for (int i = 0; i < 4; ++i)
140         for (Square s = sq + directions[i];
141              is_ok(s) && distance(s, s - directions[i]) == 1;
142              s += directions[i])
143         {
144             attack |= s;
145
146             if (occupied & s)
147                 break;
148         }
149
150     return attack;
151   }
152
153
154   // init_magics() computes all rook and bishop attacks at startup. Magic
155   // bitboards are used to look up attacks of sliding pieces. As a reference see
156   // www.chessprogramming.org/Magic_Bitboards. In particular, here we use the so
157   // called "fancy" approach.
158
159   void init_magics(Bitboard table[], Magic magics[], Direction directions[]) {
160
161     // Optimal PRNG seeds to pick the correct magics in the shortest time
162     int seeds[][RANK_NB] = { { 8977, 44560, 54343, 38998,  5731, 95205, 104912, 17020 },
163                              {  728, 10316, 55013, 32803, 12281, 15100,  16645,   255 } };
164
165     Bitboard occupancy[4096], reference[4096], edges, b;
166     int epoch[4096] = {}, cnt = 0, size = 0;
167
168     for (Square s = SQ_A1; s <= SQ_H8; ++s)
169     {
170         // Board edges are not considered in the relevant occupancies
171         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
172
173         // Given a square 's', the mask is the bitboard of sliding attacks from
174         // 's' computed on an empty board. The index must be big enough to contain
175         // all the attacks for each possible subset of the mask and so is 2 power
176         // the number of 1s of the mask. Hence we deduce the size of the shift to
177         // apply to the 64 or 32 bits word to get the index.
178         Magic& m = magics[s];
179         m.mask  = sliding_attack(directions, s, 0) & ~edges;
180         m.shift = (Is64Bit ? 64 : 32) - popcount(m.mask);
181
182         // Set the offset for the attacks table of the square. We have individual
183         // table sizes for each square with "Fancy Magic Bitboards".
184         m.attacks = s == SQ_A1 ? table : magics[s - 1].attacks + size;
185
186         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
187         // store the corresponding sliding attack bitboard in reference[].
188         b = size = 0;
189         do {
190             occupancy[size] = b;
191             reference[size] = sliding_attack(directions, s, b);
192
193             if (HasPext)
194                 m.attacks[pext(b, m.mask)] = reference[size];
195
196             size++;
197             b = (b - m.mask) & m.mask;
198         } while (b);
199
200         if (HasPext)
201             continue;
202
203         PRNG rng(seeds[Is64Bit][rank_of(s)]);
204
205         // Find a magic for square 's' picking up an (almost) random number
206         // until we find the one that passes the verification test.
207         for (int i = 0; i < size; )
208         {
209             for (m.magic = 0; popcount((m.magic * m.mask) >> 56) < 6; )
210                 m.magic = rng.sparse_rand<Bitboard>();
211
212             // A good magic must map every possible occupancy to an index that
213             // looks up the correct sliding attack in the attacks[s] database.
214             // Note that we build up the database for square 's' as a side
215             // effect of verifying the magic. Keep track of the attempt count
216             // and save it in epoch[], little speed-up trick to avoid resetting
217             // m.attacks[] after every failed attempt.
218             for (++cnt, i = 0; i < size; ++i)
219             {
220                 unsigned idx = m.index(occupancy[i]);
221
222                 if (epoch[idx] < cnt)
223                 {
224                     epoch[idx] = cnt;
225                     m.attacks[idx] = reference[i];
226                 }
227                 else if (m.attacks[idx] != reference[i])
228                     break;
229             }
230         }
231     }
232   }
233 }