Endgame's apply() method can be 'const'
[stockfish] / src / endgame.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
21 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26
27 #include "bitbase.h"
28 #include "bitcount.h"
29 #include "endgame.h"
30
31
32 ////
33 //// Local definitions
34 ////
35
36 namespace {
37
38   // Table used to drive the defending king towards the edge of the board
39   // in KX vs K and KQ vs KR endgames.
40   const uint8_t MateTable[64] = {
41     100, 90, 80, 70, 70, 80, 90, 100,
42      90, 70, 60, 50, 50, 60, 70,  90,
43      80, 60, 40, 30, 30, 40, 60,  80,
44      70, 50, 30, 20, 20, 30, 50,  70,
45      70, 50, 30, 20, 20, 30, 50,  70,
46      80, 60, 40, 30, 30, 40, 60,  80,
47      90, 70, 60, 50, 50, 60, 70,  90,
48     100, 90, 80, 70, 70, 80, 90, 100,
49   };
50
51   // Table used to drive the defending king towards a corner square of the
52   // right color in KBN vs K endgames.
53   const uint8_t KBNKMateTable[64] = {
54     200, 190, 180, 170, 160, 150, 140, 130,
55     190, 180, 170, 160, 150, 140, 130, 140,
56     180, 170, 155, 140, 140, 125, 140, 150,
57     170, 160, 140, 120, 110, 140, 150, 160,
58     160, 150, 140, 110, 120, 140, 160, 170,
59     150, 140, 125, 140, 140, 155, 170, 180,
60     140, 130, 140, 150, 160, 170, 180, 190,
61     130, 140, 150, 160, 170, 180, 190, 200
62   };
63
64   // The attacking side is given a descending bonus based on distance between
65   // the two kings in basic endgames.
66   const int DistanceBonus[8] = { 0, 0, 100, 80, 60, 40, 20, 10 };
67
68   // Bitbase for KP vs K
69   uint8_t KPKBitbase[24576];
70
71   // Penalty for big distance between king and knight for the defending king
72   // and knight in KR vs KN endgames.
73   const int KRKNKingKnightDistancePenalty[8] = { 0, 0, 4, 10, 20, 32, 48, 70 };
74
75   // Various inline functions for accessing the above arrays
76   inline Value mate_table(Square s) {
77     return Value(MateTable[s]);
78   }
79
80   inline Value kbnk_mate_table(Square s) {
81     return Value(KBNKMateTable[s]);
82   }
83
84   inline Value distance_bonus(int d) {
85     return Value(DistanceBonus[d]);
86   }
87
88   inline Value krkn_king_knight_distance_penalty(int d) {
89     return Value(KRKNKingKnightDistancePenalty[d]);
90   }
91
92   // Function for probing the KP vs K bitbase
93   int probe_kpk(Square wksq, Square wpsq, Square bksq, Color stm);
94
95 }
96
97
98 ////
99 //// Functions
100 ////
101
102 /// Mate with KX vs K. This function is used to evaluate positions with
103 /// King and plenty of material vs a lone king. It simply gives the
104 /// attacking side a bonus for driving the defending king towards the edge
105 /// of the board, and for keeping the distance between the two kings small.
106 template<>
107 Value EvaluationFunction<KXK>::apply(const Position& pos) const {
108
109   assert(pos.non_pawn_material(weakerSide) == Value(0));
110   assert(pos.piece_count(weakerSide, PAWN) == Value(0));
111
112   Square winnerKSq = pos.king_square(strongerSide);
113   Square loserKSq = pos.king_square(weakerSide);
114
115   Value result =   pos.non_pawn_material(strongerSide)
116                  + pos.piece_count(strongerSide, PAWN) * PawnValueEndgame
117                  + mate_table(loserKSq)
118                  + distance_bonus(square_distance(winnerKSq, loserKSq));
119
120   if (   pos.piece_count(strongerSide, QUEEN) > 0
121       || pos.piece_count(strongerSide, ROOK) > 0
122       || pos.piece_count(strongerSide, BISHOP) > 1)
123       // TODO: check for two equal-colored bishops!
124       result += VALUE_KNOWN_WIN;
125
126   return (strongerSide == pos.side_to_move() ? result : -result);
127 }
128
129
130 /// Mate with KBN vs K. This is similar to KX vs K, but we have to drive the
131 /// defending king towards a corner square of the right color.
132 template<>
133 Value EvaluationFunction<KBNK>::apply(const Position& pos) const {
134
135   assert(pos.non_pawn_material(weakerSide) == Value(0));
136   assert(pos.piece_count(weakerSide, PAWN) == Value(0));
137   assert(pos.non_pawn_material(strongerSide) == KnightValueMidgame + BishopValueMidgame);
138   assert(pos.piece_count(strongerSide, BISHOP) == 1);
139   assert(pos.piece_count(strongerSide, KNIGHT) == 1);
140   assert(pos.piece_count(strongerSide, PAWN) == 0);
141
142   Square winnerKSq = pos.king_square(strongerSide);
143   Square loserKSq = pos.king_square(weakerSide);
144   Square bishopSquare = pos.piece_list(strongerSide, BISHOP, 0);
145
146   if (square_color(bishopSquare) == BLACK)
147   {
148       winnerKSq = flop_square(winnerKSq);
149       loserKSq = flop_square(loserKSq);
150   }
151
152   Value result =  VALUE_KNOWN_WIN
153                 + distance_bonus(square_distance(winnerKSq, loserKSq))
154                 + kbnk_mate_table(loserKSq);
155
156   return (strongerSide == pos.side_to_move() ? result : -result);
157 }
158
159
160 /// KP vs K. This endgame is evaluated with the help of a bitbase.
161 template<>
162 Value EvaluationFunction<KPK>::apply(const Position& pos) const {
163
164   assert(pos.non_pawn_material(strongerSide) == Value(0));
165   assert(pos.non_pawn_material(weakerSide) == Value(0));
166   assert(pos.piece_count(strongerSide, PAWN) == 1);
167   assert(pos.piece_count(weakerSide, PAWN) == 0);
168
169   Square wksq, bksq, wpsq;
170   Color stm;
171
172   if (strongerSide == WHITE)
173   {
174       wksq = pos.king_square(WHITE);
175       bksq = pos.king_square(BLACK);
176       wpsq = pos.piece_list(WHITE, PAWN, 0);
177       stm = pos.side_to_move();
178   }
179   else
180   {
181       wksq = flip_square(pos.king_square(BLACK));
182       bksq = flip_square(pos.king_square(WHITE));
183       wpsq = flip_square(pos.piece_list(BLACK, PAWN, 0));
184       stm = opposite_color(pos.side_to_move());
185   }
186
187   if (square_file(wpsq) >= FILE_E)
188   {
189     wksq = flop_square(wksq);
190     bksq = flop_square(bksq);
191     wpsq = flop_square(wpsq);
192   }
193
194   if (!probe_kpk(wksq, wpsq, bksq, stm))
195       return VALUE_DRAW;
196
197   Value result =  VALUE_KNOWN_WIN
198                 + PawnValueEndgame
199                 + Value(square_rank(wpsq));
200
201   return (strongerSide == pos.side_to_move() ? result : -result);
202 }
203
204
205 /// KR vs KP. This is a somewhat tricky endgame to evaluate precisely without
206 /// a bitbase. The function below returns drawish scores when the pawn is
207 /// far advanced with support of the king, while the attacking king is far
208 /// away.
209 template<>
210 Value EvaluationFunction<KRKP>::apply(const Position& pos) const {
211
212   assert(pos.non_pawn_material(strongerSide) == RookValueMidgame);
213   assert(pos.piece_count(strongerSide, PAWN) == 0);
214   assert(pos.non_pawn_material(weakerSide) == 0);
215   assert(pos.piece_count(weakerSide, PAWN) == 1);
216
217   Square wksq, wrsq, bksq, bpsq;
218   int tempo = (pos.side_to_move() == strongerSide);
219
220   wksq = pos.king_square(strongerSide);
221   wrsq = pos.piece_list(strongerSide, ROOK, 0);
222   bksq = pos.king_square(weakerSide);
223   bpsq = pos.piece_list(weakerSide, PAWN, 0);
224
225   if (strongerSide == BLACK)
226   {
227       wksq = flip_square(wksq);
228       wrsq = flip_square(wrsq);
229       bksq = flip_square(bksq);
230       bpsq = flip_square(bpsq);
231   }
232
233   Square queeningSq = make_square(square_file(bpsq), RANK_1);
234   Value result;
235
236   // If the stronger side's king is in front of the pawn, it's a win
237   if (wksq < bpsq && square_file(wksq) == square_file(bpsq))
238       result = RookValueEndgame - Value(square_distance(wksq, bpsq));
239
240   // If the weaker side's king is too far from the pawn and the rook,
241   // it's a win
242   else if (   square_distance(bksq, bpsq) - (tempo^1) >= 3
243            && square_distance(bksq, wrsq) >= 3)
244       result = RookValueEndgame - Value(square_distance(wksq, bpsq));
245
246   // If the pawn is far advanced and supported by the defending king,
247   // the position is drawish
248   else if (   square_rank(bksq) <= RANK_3
249            && square_distance(bksq, bpsq) == 1
250            && square_rank(wksq) >= RANK_4
251            && square_distance(wksq, bpsq) - tempo > 2)
252       result = Value(80 - square_distance(wksq, bpsq) * 8);
253
254   else
255       result =  Value(200)
256               - Value(square_distance(wksq, bpsq + DELTA_S) * 8)
257               + Value(square_distance(bksq, bpsq + DELTA_S) * 8)
258               + Value(square_distance(bpsq, queeningSq) * 8);
259
260   return (strongerSide == pos.side_to_move() ? result : -result);
261 }
262
263
264 /// KR vs KB. This is very simple, and always returns drawish scores.  The
265 /// score is slightly bigger when the defending king is close to the edge.
266 template<>
267 Value EvaluationFunction<KRKB>::apply(const Position& pos) const {
268
269   assert(pos.non_pawn_material(strongerSide) == RookValueMidgame);
270   assert(pos.piece_count(strongerSide, PAWN) == 0);
271   assert(pos.non_pawn_material(weakerSide) == BishopValueMidgame);
272   assert(pos.piece_count(weakerSide, PAWN) == 0);
273   assert(pos.piece_count(weakerSide, BISHOP) == 1);
274
275   Value result = mate_table(pos.king_square(weakerSide));
276   return (pos.side_to_move() == strongerSide ? result : -result);
277 }
278
279
280 /// KR vs KN.  The attacking side has slightly better winning chances than
281 /// in KR vs KB, particularly if the king and the knight are far apart.
282 template<>
283 Value EvaluationFunction<KRKN>::apply(const Position& pos) const {
284
285   assert(pos.non_pawn_material(strongerSide) == RookValueMidgame);
286   assert(pos.piece_count(strongerSide, PAWN) == 0);
287   assert(pos.non_pawn_material(weakerSide) == KnightValueMidgame);
288   assert(pos.piece_count(weakerSide, PAWN) == 0);
289   assert(pos.piece_count(weakerSide, KNIGHT) == 1);
290
291   Square defendingKSq = pos.king_square(weakerSide);
292   Square nSq = pos.piece_list(weakerSide, KNIGHT, 0);
293
294   Value result = Value(10) + mate_table(defendingKSq) +
295     krkn_king_knight_distance_penalty(square_distance(defendingKSq, nSq));
296
297   return (strongerSide == pos.side_to_move())? result : -result;
298 }
299
300
301 /// KQ vs KR.  This is almost identical to KX vs K:  We give the attacking
302 /// king a bonus for having the kings close together, and for forcing the
303 /// defending king towards the edge.  If we also take care to avoid null move
304 /// for the defending side in the search, this is usually sufficient to be
305 /// able to win KQ vs KR.
306 template<>
307 Value EvaluationFunction<KQKR>::apply(const Position& pos) const {
308
309   assert(pos.non_pawn_material(strongerSide) == QueenValueMidgame);
310   assert(pos.piece_count(strongerSide, PAWN) == 0);
311   assert(pos.non_pawn_material(weakerSide) == RookValueMidgame);
312   assert(pos.piece_count(weakerSide, PAWN) == 0);
313
314   Square winnerKSq = pos.king_square(strongerSide);
315   Square loserKSq = pos.king_square(weakerSide);
316
317   Value result =  QueenValueEndgame
318                 - RookValueEndgame
319                 + mate_table(loserKSq)
320                 + distance_bonus(square_distance(winnerKSq, loserKSq));
321
322   return (strongerSide == pos.side_to_move())? result : -result;
323 }
324
325 template<>
326 Value EvaluationFunction<KBBKN>::apply(const Position& pos) const {
327
328   assert(pos.piece_count(strongerSide, BISHOP) == 2);
329   assert(pos.non_pawn_material(strongerSide) == 2*BishopValueMidgame);
330   assert(pos.piece_count(weakerSide, KNIGHT) == 1);
331   assert(pos.non_pawn_material(weakerSide) == KnightValueMidgame);
332   assert(pos.pieces(PAWN) == EmptyBoardBB);
333
334   Value result = BishopValueEndgame;
335   Square wksq = pos.king_square(strongerSide);
336   Square bksq = pos.king_square(weakerSide);
337   Square nsq = pos.piece_list(weakerSide, KNIGHT, 0);
338
339   // Bonus for attacking king close to defending king
340   result += distance_bonus(square_distance(wksq, bksq));
341
342   // Bonus for driving the defending king and knight apart
343   result += Value(square_distance(bksq, nsq) * 32);
344
345   // Bonus for restricting the knight's mobility
346   result += Value((8 - count_1s_max_15(pos.attacks_from<KNIGHT>(nsq))) * 8);
347
348   return (strongerSide == pos.side_to_move() ? result : -result);
349 }
350
351
352 /// K and two minors vs K and one or two minors or K and two knights against
353 /// king alone are always draw.
354 template<>
355 Value EvaluationFunction<KmmKm>::apply(const Position&) const {
356   return Value(0);
357 }
358
359 template<>
360 Value EvaluationFunction<KNNK>::apply(const Position&) const {
361   return Value(0);
362 }
363
364 /// KBPKScalingFunction scales endgames where the stronger side has king,
365 /// bishop and one or more pawns. It checks for draws with rook pawns and a
366 /// bishop of the wrong color. If such a draw is detected, ScaleFactor(0) is
367 /// returned. If not, the return value is SCALE_FACTOR_NONE, i.e. no scaling
368 /// will be used.
369 template<>
370 ScaleFactor ScalingFunction<KBPsK>::apply(const Position& pos) const {
371
372   assert(pos.non_pawn_material(strongerSide) == BishopValueMidgame);
373   assert(pos.piece_count(strongerSide, BISHOP) == 1);
374   assert(pos.piece_count(strongerSide, PAWN) >= 1);
375
376   // No assertions about the material of weakerSide, because we want draws to
377   // be detected even when the weaker side has some pawns.
378
379   Bitboard pawns = pos.pieces(PAWN, strongerSide);
380   File pawnFile = square_file(pos.piece_list(strongerSide, PAWN, 0));
381
382   // All pawns are on a single rook file ?
383   if (   (pawnFile == FILE_A || pawnFile == FILE_H)
384       && (pawns & ~file_bb(pawnFile)) == EmptyBoardBB)
385   {
386       Square bishopSq = pos.piece_list(strongerSide, BISHOP, 0);
387       Square queeningSq = relative_square(strongerSide, make_square(pawnFile, RANK_8));
388       Square kingSq = pos.king_square(weakerSide);
389
390       if (   square_color(queeningSq) != square_color(bishopSq)
391           && file_distance(square_file(kingSq), pawnFile) <= 1)
392       {
393           // The bishop has the wrong color, and the defending king is on the
394           // file of the pawn(s) or the neighboring file. Find the rank of the
395           // frontmost pawn.
396           Rank rank;
397           if (strongerSide == WHITE)
398           {
399               for (rank = RANK_7; (rank_bb(rank) & pawns) == EmptyBoardBB; rank--) {}
400               assert(rank >= RANK_2 && rank <= RANK_7);
401           }
402           else
403           {
404               for(rank = RANK_2; (rank_bb(rank) & pawns) == EmptyBoardBB; rank++) {}
405               rank = Rank(rank^7);  // HACK to get the relative rank
406               assert(rank >= RANK_2 && rank <= RANK_7);
407           }
408           // If the defending king has distance 1 to the promotion square or
409           // is placed somewhere in front of the pawn, it's a draw.
410           if (   square_distance(kingSq, queeningSq) <= 1
411               || relative_rank(strongerSide, kingSq) >= rank)
412               return ScaleFactor(0);
413       }
414   }
415   return SCALE_FACTOR_NONE;
416 }
417
418
419 /// KQKRPScalingFunction scales endgames where the stronger side has only
420 /// king and queen, while the weaker side has at least a rook and a pawn.
421 /// It tests for fortress draws with a rook on the third rank defended by
422 /// a pawn.
423 template<>
424 ScaleFactor ScalingFunction<KQKRPs>::apply(const Position& pos) const {
425
426   assert(pos.non_pawn_material(strongerSide) == QueenValueMidgame);
427   assert(pos.piece_count(strongerSide, QUEEN) == 1);
428   assert(pos.piece_count(strongerSide, PAWN) == 0);
429   assert(pos.piece_count(weakerSide, ROOK) == 1);
430   assert(pos.piece_count(weakerSide, PAWN) >= 1);
431
432   Square kingSq = pos.king_square(weakerSide);
433   if (   relative_rank(weakerSide, kingSq) <= RANK_2
434       && relative_rank(weakerSide, pos.king_square(strongerSide)) >= RANK_4
435       && (pos.pieces(ROOK, weakerSide) & relative_rank_bb(weakerSide, RANK_3))
436       && (pos.pieces(PAWN, weakerSide) & relative_rank_bb(weakerSide, RANK_2))
437       && (pos.attacks_from<KING>(kingSq) & pos.pieces(PAWN, weakerSide)))
438   {
439       Square rsq = pos.piece_list(weakerSide, ROOK, 0);
440       if (pos.attacks_from<PAWN>(rsq, strongerSide) & pos.pieces(PAWN, weakerSide))
441           return ScaleFactor(0);
442   }
443   return SCALE_FACTOR_NONE;
444 }
445
446
447 /// KRPKRScalingFunction scales KRP vs KR endgames. This function knows a
448 /// handful of the most important classes of drawn positions, but is far
449 /// from perfect. It would probably be a good idea to add more knowledge
450 /// in the future.
451 ///
452 /// It would also be nice to rewrite the actual code for this function,
453 /// which is mostly copied from Glaurung 1.x, and not very pretty.
454 template<>
455 ScaleFactor ScalingFunction<KRPKR>::apply(const Position& pos) const {
456
457   assert(pos.non_pawn_material(strongerSide) == RookValueMidgame);
458   assert(pos.piece_count(strongerSide, PAWN) == 1);
459   assert(pos.non_pawn_material(weakerSide) == RookValueMidgame);
460   assert(pos.piece_count(weakerSide, PAWN) == 0);
461
462   Square wksq = pos.king_square(strongerSide);
463   Square wrsq = pos.piece_list(strongerSide, ROOK, 0);
464   Square wpsq = pos.piece_list(strongerSide, PAWN, 0);
465   Square bksq = pos.king_square(weakerSide);
466   Square brsq = pos.piece_list(weakerSide, ROOK, 0);
467
468   // Orient the board in such a way that the stronger side is white, and the
469   // pawn is on the left half of the board.
470   if (strongerSide == BLACK)
471   {
472       wksq = flip_square(wksq);
473       wrsq = flip_square(wrsq);
474       wpsq = flip_square(wpsq);
475       bksq = flip_square(bksq);
476       brsq = flip_square(brsq);
477   }
478   if (square_file(wpsq) > FILE_D)
479   {
480       wksq = flop_square(wksq);
481       wrsq = flop_square(wrsq);
482       wpsq = flop_square(wpsq);
483       bksq = flop_square(bksq);
484       brsq = flop_square(brsq);
485   }
486
487   File f = square_file(wpsq);
488   Rank r = square_rank(wpsq);
489   Square queeningSq = make_square(f, RANK_8);
490   int tempo = (pos.side_to_move() == strongerSide);
491
492   // If the pawn is not too far advanced and the defending king defends the
493   // queening square, use the third-rank defence.
494   if (   r <= RANK_5
495       && square_distance(bksq, queeningSq) <= 1
496       && wksq <= SQ_H5
497       && (square_rank(brsq) == RANK_6 || (r <= RANK_3 && square_rank(wrsq) != RANK_6)))
498       return ScaleFactor(0);
499
500   // The defending side saves a draw by checking from behind in case the pawn
501   // has advanced to the 6th rank with the king behind.
502   if (   r == RANK_6
503       && square_distance(bksq, queeningSq) <= 1
504       && square_rank(wksq) + tempo <= RANK_6
505       && (square_rank(brsq) == RANK_1 || (!tempo && abs(square_file(brsq) - f) >= 3)))
506       return ScaleFactor(0);
507
508   if (   r >= RANK_6
509       && bksq == queeningSq
510       && square_rank(brsq) == RANK_1
511       && (!tempo || square_distance(wksq, wpsq) >= 2))
512       return ScaleFactor(0);
513
514   // White pawn on a7 and rook on a8 is a draw if black's king is on g7 or h7
515   // and the black rook is behind the pawn.
516   if (   wpsq == SQ_A7
517       && wrsq == SQ_A8
518       && (bksq == SQ_H7 || bksq == SQ_G7)
519       && square_file(brsq) == FILE_A
520       && (square_rank(brsq) <= RANK_3 || square_file(wksq) >= FILE_D || square_rank(wksq) <= RANK_5))
521       return ScaleFactor(0);
522
523   // If the defending king blocks the pawn and the attacking king is too far
524   // away, it's a draw.
525   if (   r <= RANK_5
526       && bksq == wpsq + DELTA_N
527       && square_distance(wksq, wpsq) - tempo >= 2
528       && square_distance(wksq, brsq) - tempo >= 2)
529       return ScaleFactor(0);
530
531   // Pawn on the 7th rank supported by the rook from behind usually wins if the
532   // attacking king is closer to the queening square than the defending king,
533   // and the defending king cannot gain tempi by threatening the attacking rook.
534   if (   r == RANK_7
535       && f != FILE_A
536       && square_file(wrsq) == f
537       && wrsq != queeningSq
538       && (square_distance(wksq, queeningSq) < square_distance(bksq, queeningSq) - 2 + tempo)
539       && (square_distance(wksq, queeningSq) < square_distance(bksq, wrsq) + tempo))
540       return ScaleFactor(SCALE_FACTOR_MAX - 2 * square_distance(wksq, queeningSq));
541
542   // Similar to the above, but with the pawn further back
543   if (   f != FILE_A
544       && square_file(wrsq) == f
545       && wrsq < wpsq
546       && (square_distance(wksq, queeningSq) < square_distance(bksq, queeningSq) - 2 + tempo)
547       && (square_distance(wksq, wpsq + DELTA_N) < square_distance(bksq, wpsq + DELTA_N) - 2 + tempo)
548       && (  square_distance(bksq, wrsq) + tempo >= 3
549           || (    square_distance(wksq, queeningSq) < square_distance(bksq, wrsq) + tempo
550               && (square_distance(wksq, wpsq + DELTA_N) < square_distance(bksq, wrsq) + tempo))))
551       return ScaleFactor(  SCALE_FACTOR_MAX
552                          - (8 * square_distance(wpsq, queeningSq)
553                          + 2 * square_distance(wksq, queeningSq)));
554
555   // If the pawn is not far advanced, and the defending king is somewhere in
556   // the pawn's path, it's probably a draw.
557   if (r <= RANK_4 && bksq > wpsq)
558   {
559       if (square_file(bksq) == square_file(wpsq))
560           return ScaleFactor(10);
561       if (   abs(square_file(bksq) - square_file(wpsq)) == 1
562           && square_distance(wksq, bksq) > 2)
563           return ScaleFactor(24 - 2 * square_distance(wksq, bksq));
564   }
565   return SCALE_FACTOR_NONE;
566 }
567
568
569 /// KRPPKRPScalingFunction scales KRPP vs KRP endgames. There is only a
570 /// single pattern: If the stronger side has no pawns and the defending king
571 /// is actively placed, the position is drawish.
572 template<>
573 ScaleFactor ScalingFunction<KRPPKRP>::apply(const Position& pos) const {
574
575   assert(pos.non_pawn_material(strongerSide) == RookValueMidgame);
576   assert(pos.piece_count(strongerSide, PAWN) == 2);
577   assert(pos.non_pawn_material(weakerSide) == RookValueMidgame);
578   assert(pos.piece_count(weakerSide, PAWN) == 1);
579
580   Square wpsq1 = pos.piece_list(strongerSide, PAWN, 0);
581   Square wpsq2 = pos.piece_list(strongerSide, PAWN, 1);
582   Square bksq = pos.king_square(weakerSide);
583
584   // Does the stronger side have a passed pawn?
585   if (   pos.pawn_is_passed(strongerSide, wpsq1)
586       || pos.pawn_is_passed(strongerSide, wpsq2))
587       return SCALE_FACTOR_NONE;
588
589   Rank r = Max(relative_rank(strongerSide, wpsq1), relative_rank(strongerSide, wpsq2));
590
591   if (   file_distance(bksq, wpsq1) <= 1
592       && file_distance(bksq, wpsq2) <= 1
593       && relative_rank(strongerSide, bksq) > r)
594   {
595       switch (r) {
596       case RANK_2: return ScaleFactor(10);
597       case RANK_3: return ScaleFactor(10);
598       case RANK_4: return ScaleFactor(15);
599       case RANK_5: return ScaleFactor(20);
600       case RANK_6: return ScaleFactor(40);
601       default: assert(false);
602       }
603   }
604   return SCALE_FACTOR_NONE;
605 }
606
607
608 /// KPsKScalingFunction scales endgames with king and two or more pawns
609 /// against king. There is just a single rule here: If all pawns are on
610 /// the same rook file and are blocked by the defending king, it's a draw.
611 template<>
612 ScaleFactor ScalingFunction<KPsK>::apply(const Position& pos) const {
613
614   assert(pos.non_pawn_material(strongerSide) == Value(0));
615   assert(pos.piece_count(strongerSide, PAWN) >= 2);
616   assert(pos.non_pawn_material(weakerSide) == Value(0));
617   assert(pos.piece_count(weakerSide, PAWN) == 0);
618
619   Bitboard pawns = pos.pieces(PAWN, strongerSide);
620
621   // Are all pawns on the 'a' file?
622   if ((pawns & ~FileABB) == EmptyBoardBB)
623   {
624       // Does the defending king block the pawns?
625       Square ksq = pos.king_square(weakerSide);
626       if (square_distance(ksq, relative_square(strongerSide, SQ_A8)) <= 1)
627           return ScaleFactor(0);
628       else if(   square_file(ksq) == FILE_A
629               && (in_front_bb(strongerSide, ksq) & pawns) == EmptyBoardBB)
630           return ScaleFactor(0);
631       else
632           return SCALE_FACTOR_NONE;
633   }
634   // Are all pawns on the 'h' file?
635   else if ((pawns & ~FileHBB) == EmptyBoardBB)
636   {
637     // Does the defending king block the pawns?
638     Square ksq = pos.king_square(weakerSide);
639     if (square_distance(ksq, relative_square(strongerSide, SQ_H8)) <= 1)
640         return ScaleFactor(0);
641     else if (   square_file(ksq) == FILE_H
642              && (in_front_bb(strongerSide, ksq) & pawns) == EmptyBoardBB)
643         return ScaleFactor(0);
644     else
645         return SCALE_FACTOR_NONE;
646   }
647   else
648       return SCALE_FACTOR_NONE;
649 }
650
651
652 /// KBPKBScalingFunction scales KBP vs KB endgames. There are two rules:
653 /// If the defending king is somewhere along the path of the pawn, and the
654 /// square of the king is not of the same color as the stronger side's bishop,
655 /// it's a draw. If the two bishops have opposite color, it's almost always
656 /// a draw.
657 template<>
658 ScaleFactor ScalingFunction<KBPKB>::apply(const Position& pos) const {
659
660   assert(pos.non_pawn_material(strongerSide) == BishopValueMidgame);
661   assert(pos.piece_count(strongerSide, BISHOP) == 1);
662   assert(pos.piece_count(strongerSide, PAWN) == 1);
663   assert(pos.non_pawn_material(weakerSide) == BishopValueMidgame);
664   assert(pos.piece_count(weakerSide, BISHOP) == 1);
665   assert(pos.piece_count(weakerSide, PAWN) == 0);
666
667   Square pawnSq = pos.piece_list(strongerSide, PAWN, 0);
668   Square strongerBishopSq = pos.piece_list(strongerSide, BISHOP, 0);
669   Square weakerBishopSq = pos.piece_list(weakerSide, BISHOP, 0);
670   Square weakerKingSq = pos.king_square(weakerSide);
671
672   // Case 1: Defending king blocks the pawn, and cannot be driven away
673   if (   square_file(weakerKingSq) == square_file(pawnSq)
674       && relative_rank(strongerSide, pawnSq) < relative_rank(strongerSide, weakerKingSq)
675       && (   square_color(weakerKingSq) != square_color(strongerBishopSq)
676           || relative_rank(strongerSide, weakerKingSq) <= RANK_6))
677       return ScaleFactor(0);
678
679   // Case 2: Opposite colored bishops
680   if (square_color(strongerBishopSq) != square_color(weakerBishopSq))
681   {
682       // We assume that the position is drawn in the following three situations:
683       //
684       //   a. The pawn is on rank 5 or further back.
685       //   b. The defending king is somewhere in the pawn's path.
686       //   c. The defending bishop attacks some square along the pawn's path,
687       //      and is at least three squares away from the pawn.
688       //
689       // These rules are probably not perfect, but in practice they work
690       // reasonably well.
691
692       if (relative_rank(strongerSide, pawnSq) <= RANK_5)
693           return ScaleFactor(0);
694       else
695       {
696           Bitboard ray = ray_bb(pawnSq, (strongerSide == WHITE)? SIGNED_DIR_N : SIGNED_DIR_S);
697           if (ray & pos.pieces(KING, weakerSide))
698               return ScaleFactor(0);
699           if(  (pos.attacks_from<BISHOP>(weakerBishopSq) & ray)
700              && square_distance(weakerBishopSq, pawnSq) >= 3)
701               return ScaleFactor(0);
702       }
703   }
704   return SCALE_FACTOR_NONE;
705 }
706
707
708 /// KBPPKBScalingFunction scales KBPP vs KB endgames. It detects a few basic
709 /// draws with opposite-colored bishops.
710 template<>
711 ScaleFactor ScalingFunction<KBPPKB>::apply(const Position& pos) const {
712
713   assert(pos.non_pawn_material(strongerSide) == BishopValueMidgame);
714   assert(pos.piece_count(strongerSide, BISHOP) == 1);
715   assert(pos.piece_count(strongerSide, PAWN) == 2);
716   assert(pos.non_pawn_material(weakerSide) == BishopValueMidgame);
717   assert(pos.piece_count(weakerSide, BISHOP) == 1);
718   assert(pos.piece_count(weakerSide, PAWN) == 0);
719
720   Square wbsq = pos.piece_list(strongerSide, BISHOP, 0);
721   Square bbsq = pos.piece_list(weakerSide, BISHOP, 0);
722
723   if (square_color(wbsq) == square_color(bbsq))
724       // Not opposite-colored bishops, no scaling
725       return SCALE_FACTOR_NONE;
726
727   Square ksq = pos.king_square(weakerSide);
728   Square psq1 = pos.piece_list(strongerSide, PAWN, 0);
729   Square psq2 = pos.piece_list(strongerSide, PAWN, 1);
730   Rank r1 = square_rank(psq1);
731   Rank r2 = square_rank(psq2);
732   Square blockSq1, blockSq2;
733
734   if (relative_rank(strongerSide, psq1) > relative_rank(strongerSide, psq2))
735   {
736       blockSq1 = psq1 + pawn_push(strongerSide);
737       blockSq2 = make_square(square_file(psq2), square_rank(psq1));
738   }
739   else
740   {
741       blockSq1 = psq2 + pawn_push(strongerSide);
742       blockSq2 = make_square(square_file(psq1), square_rank(psq2));
743   }
744
745   switch (file_distance(psq1, psq2))
746   {
747   case 0:
748     // Both pawns are on the same file. Easy draw if defender firmly controls
749     // some square in the frontmost pawn's path.
750     if (   square_file(ksq) == square_file(blockSq1)
751         && relative_rank(strongerSide, ksq) >= relative_rank(strongerSide, blockSq1)
752         && square_color(ksq) != square_color(wbsq))
753         return ScaleFactor(0);
754     else
755         return SCALE_FACTOR_NONE;
756
757   case 1:
758     // Pawns on neighboring files. Draw if defender firmly controls the square
759     // in front of the frontmost pawn's path, and the square diagonally behind
760     // this square on the file of the other pawn.
761     if (   ksq == blockSq1
762         && square_color(ksq) != square_color(wbsq)
763         && (   bbsq == blockSq2
764             || (pos.attacks_from<BISHOP>(blockSq2) & pos.pieces(BISHOP, weakerSide))
765             || rank_distance(r1, r2) >= 2))
766         return ScaleFactor(0);
767     else if (   ksq == blockSq2
768              && square_color(ksq) != square_color(wbsq)
769              && (   bbsq == blockSq1
770                  || (pos.attacks_from<BISHOP>(blockSq1) & pos.pieces(BISHOP, weakerSide))))
771         return ScaleFactor(0);
772     else
773         return SCALE_FACTOR_NONE;
774
775   default:
776     // The pawns are not on the same file or adjacent files. No scaling.
777     return SCALE_FACTOR_NONE;
778   }
779 }
780
781
782 /// KBPKNScalingFunction scales KBP vs KN endgames. There is a single rule:
783 /// If the defending king is somewhere along the path of the pawn, and the
784 /// square of the king is not of the same color as the stronger side's bishop,
785 /// it's a draw.
786 template<>
787 ScaleFactor ScalingFunction<KBPKN>::apply(const Position& pos) const {
788
789   assert(pos.non_pawn_material(strongerSide) == BishopValueMidgame);
790   assert(pos.piece_count(strongerSide, BISHOP) == 1);
791   assert(pos.piece_count(strongerSide, PAWN) == 1);
792   assert(pos.non_pawn_material(weakerSide) == KnightValueMidgame);
793   assert(pos.piece_count(weakerSide, KNIGHT) == 1);
794   assert(pos.piece_count(weakerSide, PAWN) == 0);
795
796   Square pawnSq = pos.piece_list(strongerSide, PAWN, 0);
797   Square strongerBishopSq = pos.piece_list(strongerSide, BISHOP, 0);
798   Square weakerKingSq = pos.king_square(weakerSide);
799
800   if (   square_file(weakerKingSq) == square_file(pawnSq)
801       && relative_rank(strongerSide, pawnSq) < relative_rank(strongerSide, weakerKingSq)
802       && (   square_color(weakerKingSq) != square_color(strongerBishopSq)
803           || relative_rank(strongerSide, weakerKingSq) <= RANK_6))
804       return ScaleFactor(0);
805
806   return SCALE_FACTOR_NONE;
807 }
808
809
810 /// KNPKScalingFunction scales KNP vs K endgames. There is a single rule:
811 /// If the pawn is a rook pawn on the 7th rank and the defending king prevents
812 /// the pawn from advancing, the position is drawn.
813 template<>
814 ScaleFactor ScalingFunction<KNPK>::apply(const Position& pos) const {
815
816   assert(pos.non_pawn_material(strongerSide) == KnightValueMidgame);
817   assert(pos.piece_count(strongerSide, KNIGHT) == 1);
818   assert(pos.piece_count(strongerSide, PAWN) == 1);
819   assert(pos.non_pawn_material(weakerSide) == Value(0));
820   assert(pos.piece_count(weakerSide, PAWN) == 0);
821
822   Square pawnSq = pos.piece_list(strongerSide, PAWN, 0);
823   Square weakerKingSq = pos.king_square(weakerSide);
824
825   if (   pawnSq == relative_square(strongerSide, SQ_A7)
826       && square_distance(weakerKingSq, relative_square(strongerSide, SQ_A8)) <= 1)
827       return ScaleFactor(0);
828
829   if (   pawnSq == relative_square(strongerSide, SQ_H7)
830       && square_distance(weakerKingSq, relative_square(strongerSide, SQ_H8)) <= 1)
831       return ScaleFactor(0);
832
833   return SCALE_FACTOR_NONE;
834 }
835
836
837 /// KPKPScalingFunction scales KP vs KP endgames. This is done by removing
838 /// the weakest side's pawn and probing the KP vs K bitbase: If the weakest
839 /// side has a draw without the pawn, she probably has at least a draw with
840 /// the pawn as well. The exception is when the stronger side's pawn is far
841 /// advanced and not on a rook file; in this case it is often possible to win
842 /// (e.g. 8/4k3/3p4/3P4/6K1/8/8/8 w - - 0 1).
843 template<>
844 ScaleFactor ScalingFunction<KPKP>::apply(const Position& pos) const {
845
846   assert(pos.non_pawn_material(strongerSide) == Value(0));
847   assert(pos.non_pawn_material(weakerSide) == Value(0));
848   assert(pos.piece_count(WHITE, PAWN) == 1);
849   assert(pos.piece_count(BLACK, PAWN) == 1);
850
851   Square wksq, bksq, wpsq;
852   Color stm;
853
854   if (strongerSide == WHITE)
855   {
856       wksq = pos.king_square(WHITE);
857       bksq = pos.king_square(BLACK);
858       wpsq = pos.piece_list(WHITE, PAWN, 0);
859       stm = pos.side_to_move();
860   }
861   else
862   {
863       wksq = flip_square(pos.king_square(BLACK));
864       bksq = flip_square(pos.king_square(WHITE));
865       wpsq = flip_square(pos.piece_list(BLACK, PAWN, 0));
866       stm = opposite_color(pos.side_to_move());
867   }
868
869   if (square_file(wpsq) >= FILE_E)
870   {
871       wksq = flop_square(wksq);
872       bksq = flop_square(bksq);
873       wpsq = flop_square(wpsq);
874   }
875
876   // If the pawn has advanced to the fifth rank or further, and is not a
877   // rook pawn, it's too dangerous to assume that it's at least a draw.
878   if (   square_rank(wpsq) >= RANK_5
879       && square_file(wpsq) != FILE_A)
880       return SCALE_FACTOR_NONE;
881
882   // Probe the KPK bitbase with the weakest side's pawn removed. If it's a
883   // draw, it's probably at least a draw even with the pawn.
884   if (probe_kpk(wksq, wpsq, bksq, stm))
885       return SCALE_FACTOR_NONE;
886   else
887       return ScaleFactor(0);
888 }
889
890
891 /// init_bitbases() is called during program initialization, and simply loads
892 /// bitbases from disk into memory.  At the moment, there is only the bitbase
893 /// for KP vs K, but we may decide to add other bitbases later.
894
895 void init_bitbases() {
896   generate_kpk_bitbase(KPKBitbase);
897 }
898
899
900 namespace {
901
902   // Probe the KP vs K bitbase:
903
904   int probe_kpk(Square wksq, Square wpsq, Square bksq, Color stm) {
905
906     int wp = int(square_file(wpsq)) + (int(square_rank(wpsq)) - 1) * 4;
907     int index = int(stm) + 2*int(bksq) + 128*int(wksq) + 8192*wp;
908
909     assert(index >= 0 && index < 24576*8);
910     return KPKBitbase[index/8] & (1 << (index&7));
911   }
912 }