git.sesse.net Git - stockfish/blob - src/material.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2009 Marco Costalba
   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 #if !defined(MATERIAL_H_INCLUDED)
  22 #define MATERIAL_H_INCLUDED
  23
  24 ////
  25 //// Includes
  26 ////
  27
  28 #include "endgame.h"
  29 #include "position.h"
  30 #include "scale.h"
  31
  32
  33 ////
  34 //// Types
  35 ////
  36
  37 /// MaterialInfo is a class which contains various information about a
  38 /// material configuration. It contains a material balance evaluation,
  39 /// a function pointer to a special endgame evaluation function (which in
  40 /// most cases is NULL, meaning that the standard evaluation function will
  41 /// be used), and "scale factors" for black and white.
  42 ///
  43 /// The scale factors are used to scale the evaluation score up or down.
  44 /// For instance, in KRB vs KR endgames, the score is scaled down by a factor
  45 /// of 4, which will result in scores of absolute value less than one pawn.
  46
  47 class MaterialInfo {
  48
  49   friend class MaterialInfoTable;
  50
  51 public:
  52   MaterialInfo() : key(0) { clear(); }
  53
  54   Value mg_value() const;
  55   Value eg_value() const;
  56   ScaleFactor scale_factor(const Position& pos, Color c) const;
  57   int space_weight() const;
  58   bool specialized_eval_exists() const;
  59   Value evaluate(const Position& pos) const;
  60
  61 private:
  62   void clear();
  63
  64   Key key;
  65   int16_t mgValue;
  66   int16_t egValue;
  67   uint8_t factor[2];
  68   EndgameEvaluationFunctionBase* evaluationFunction;
  69   EndgameScalingFunctionBase* scalingFunction[2];
  70   int spaceWeight;
  71 };
  72
  73
  74 /// EndgameFunctions class stores the endgame evaluation functions std::map.
  75 /// Because STL library is not thread safe even for read access, the maps,
  76 /// although with identical content, are replicated for each thread. This
  77 /// is faster then using locks with an unique set of global maps.
  78
  79 class EndgameFunctions;
  80
  81
  82 /// The MaterialInfoTable class represents a pawn hash table. It is basically
  83 /// just an array of MaterialInfo objects and a few methods for accessing these
  84 /// objects. The most important method is get_material_info, which looks up a
  85 /// position in the table and returns a pointer to a MaterialInfo object.
  86
  87 class MaterialInfoTable {
  88
  89 public:
  90   MaterialInfoTable(unsigned numOfEntries);
  91   ~MaterialInfoTable();
  92   MaterialInfo* get_material_info(const Position& pos);
  93
  94 private:
  95   unsigned size;
  96   MaterialInfo* entries;
  97   EndgameFunctions* funcs;
  98 };
  99
 100
 101 ////
 102 //// Inline functions
 103 ////
 104
 105 /// MaterialInfo::mg_value and MaterialInfo::eg_value simply returns the
 106 /// material balance evaluation for the middle game and the endgame.
 107
 108 inline Value MaterialInfo::mg_value() const {
 109
 110   return Value(mgValue);
 111 }
 112
 113 inline Value MaterialInfo::eg_value() const {
 114
 115   return Value(egValue);
 116 }
 117
 118
 119 /// MaterialInfo::clear() resets a MaterialInfo object to an empty state,
 120 /// with all slots at their default values but the key.
 121
 122 inline void MaterialInfo::clear() {
 123
 124   mgValue = egValue = 0;
 125   factor[WHITE] = factor[BLACK] = uint8_t(SCALE_FACTOR_NORMAL);
 126   evaluationFunction = NULL;
 127   scalingFunction[WHITE] = scalingFunction[BLACK] = NULL;
 128   spaceWeight = 0;
 129 }
 130
 131
 132 /// MaterialInfo::scale_factor takes a position and a color as input, and
 133 /// returns a scale factor for the given color. We have to provide the
 134 /// position in addition to the color, because the scale factor need not
 135 /// to be a constant: It can also be a function which should be applied to
 136 /// the position. For instance, in KBP vs K endgames, a scaling function
 137 /// which checks for draws with rook pawns and wrong-colored bishops.
 138
 139 inline ScaleFactor MaterialInfo::scale_factor(const Position& pos, Color c) const {
 140
 141   if (scalingFunction[c] != NULL)
 142   {
 143       ScaleFactor sf = scalingFunction[c]->apply(pos);
 144       if (sf != SCALE_FACTOR_NONE)
 145           return sf;
 146   }
 147   return ScaleFactor(factor[c]);
 148 }
 149
 150
 151 /// MaterialInfo::space_weight() simply returns the weight for the space
 152 /// evaluation for this material configuration.
 153
 154 inline int MaterialInfo::space_weight() const {
 155
 156   return spaceWeight;
 157 }
 158
 159
 160 /// MaterialInfo::specialized_eval_exists decides whether there is a
 161 /// specialized evaluation function for the current material configuration,
 162 /// or if the normal evaluation function should be used.
 163
 164 inline bool MaterialInfo::specialized_eval_exists() const {
 165
 166   return evaluationFunction != NULL;
 167 }
 168
 169
 170 /// MaterialInfo::evaluate applies a specialized evaluation function
 171 /// to a given position object. It should only be called when
 172 /// specialized_eval_exists() returns 'true'.
 173
 174 inline Value MaterialInfo::evaluate(const Position& pos) const {
 175
 176   return evaluationFunction->apply(pos);
 177 }
 178
 179 #endif // !defined(MATERIAL_H_INCLUDED)