Better naming and document some endgame functions

[stockfish] / src / material.h

diff --git a/src/material.h b/src/material.h
index 27c93807068174ee4d945e392718c9b1baa7ccad..8f9f375116e77c92fcfb06311e3f5d1c0fe5f0b3 100644 (file)
--- a/src/material.h
+++ b/src/material.h
@@ -49,45 +49,36 @@ class MaterialInfo {
   friend class MaterialInfoTable;
 
 public:
   friend class MaterialInfoTable;
 
 public:

-  Value mg_value() const;
-  Value eg_value() const;
+  MaterialInfo() : key(0) { clear(); }
+
+  Value material_value() const;

   ScaleFactor scale_factor(const Position& pos, Color c) const;
   int space_weight() const;
   bool specialized_eval_exists() const;
   Value evaluate(const Position& pos) const;
 
 private:
   ScaleFactor scale_factor(const Position& pos, Color c) const;
   int space_weight() const;
   bool specialized_eval_exists() const;
   Value evaluate(const Position& pos) const;
 
 private:

-  void clear();
+  inline void clear();

 
   Key key;
 
   Key key;

-  int16_t mgValue;
-  int16_t egValue;
+  int16_t value;

   uint8_t factor[2];
   EndgameEvaluationFunctionBase* evaluationFunction;
   EndgameScalingFunctionBase* scalingFunction[2];
   int spaceWeight;
 };
 
   uint8_t factor[2];
   EndgameEvaluationFunctionBase* evaluationFunction;
   EndgameScalingFunctionBase* scalingFunction[2];
   int spaceWeight;
 };
 

-
-/// EndgameFunctions class stores the endgame evaluation functions std::map.
-/// Because STL library is not thread safe even for read access, the maps,
-/// although with identical content, are replicated for each thread. This
-/// is faster then using locks with an unique set of global maps.
-
-class EndgameFunctions;
-
-

 /// The MaterialInfoTable class represents a pawn hash table. It is basically
 /// just an array of MaterialInfo objects and a few methods for accessing these
 /// objects. The most important method is get_material_info, which looks up a
 /// position in the table and returns a pointer to a MaterialInfo object.
 /// The MaterialInfoTable class represents a pawn hash table. It is basically
 /// just an array of MaterialInfo objects and a few methods for accessing these
 /// objects. The most important method is get_material_info, which looks up a
 /// position in the table and returns a pointer to a MaterialInfo object.

+class EndgameFunctions;

 
 class MaterialInfoTable {
 
 public:
   MaterialInfoTable(unsigned numOfEntries);
   ~MaterialInfoTable();
 
 class MaterialInfoTable {
 
 public:
   MaterialInfoTable(unsigned numOfEntries);
   ~MaterialInfoTable();

-  void clear();

   MaterialInfo* get_material_info(const Position& pos);
 
 private:
   MaterialInfo* get_material_info(const Position& pos);
 
 private:


@@ -101,35 +92,30 @@ private:
 //// Inline functions
 ////
 
 //// Inline functions
 ////
 

-/// MaterialInfo::mg_value and MaterialInfo::eg_value simply returns the
-/// material balance evaluation for the middle game and the endgame.
-
-inline Value MaterialInfo::mg_value() const {
-
-  return Value(mgValue);
-}
+/// MaterialInfo::material_value simply returns the material balance
+/// evaluation that is independent from game phase.

 
 

-inline Value MaterialInfo::eg_value() const {
+inline Value MaterialInfo::material_value() const {

 
 

-  return Value(egValue);
+  return Value(value);

 }
 
 
 /// MaterialInfo::clear() resets a MaterialInfo object to an empty state,
 }
 
 
 /// MaterialInfo::clear() resets a MaterialInfo object to an empty state,

-/// with all slots at their default values.
+/// with all slots at their default values but the key.

 
 inline void MaterialInfo::clear() {
 
 
 inline void MaterialInfo::clear() {
 

-  mgValue = egValue = 0;
+  value = 0;

   factor[WHITE] = factor[BLACK] = uint8_t(SCALE_FACTOR_NORMAL);
   factor[WHITE] = factor[BLACK] = uint8_t(SCALE_FACTOR_NORMAL);

-  spaceWeight = 0;

   evaluationFunction = NULL;
   scalingFunction[WHITE] = scalingFunction[BLACK] = NULL;
   evaluationFunction = NULL;
   scalingFunction[WHITE] = scalingFunction[BLACK] = NULL;

+  spaceWeight = 0;

 }
 
 
 /// MaterialInfo::scale_factor takes a position and a color as input, and
 }
 
 
 /// MaterialInfo::scale_factor takes a position and a color as input, and

-/// returns a scale factor for the given color.  We have to provide the
+/// returns a scale factor for the given color. We have to provide the

 /// position in addition to the color, because the scale factor need not
 /// to be a constant: It can also be a function which should be applied to
 /// the position. For instance, in KBP vs K endgames, a scaling function
 /// position in addition to the color, because the scale factor need not
 /// to be a constant: It can also be a function which should be applied to
 /// the position. For instance, in KBP vs K endgames, a scaling function


@@ -167,7 +153,7 @@ inline bool MaterialInfo::specialized_eval_exists() const {
 
 
 /// MaterialInfo::evaluate applies a specialized evaluation function
 
 
 /// MaterialInfo::evaluate applies a specialized evaluation function

-/// to a given position object.  It should only be called when
+/// to a given position object. It should only be called when

 /// specialized_eval_exists() returns 'true'.
 
 inline Value MaterialInfo::evaluate(const Position& pos) const {
 /// specialized_eval_exists() returns 'true'.
 
 inline Value MaterialInfo::evaluate(const Position& pos) const {