Introduce enum VALUE_ZERO instead of Value(0)
[stockfish] / src / value.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-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 #if !defined(VALUE_H_INCLUDED)
22 #define VALUE_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "piece.h"
29
30
31 ////
32 //// Types
33 ////
34
35 enum ValueType {
36   VALUE_TYPE_NONE  = 0,
37   VALUE_TYPE_UPPER = 1,  // Upper bound
38   VALUE_TYPE_LOWER = 2,  // Lower bound
39   VALUE_TYPE_EXACT = VALUE_TYPE_UPPER | VALUE_TYPE_LOWER
40 };
41
42
43 enum Value {
44   VALUE_ZERO      = 0,
45   VALUE_DRAW      = 0,
46   VALUE_KNOWN_WIN = 15000,
47   VALUE_MATE      = 30000,
48   VALUE_INFINITE  = 30001,
49   VALUE_NONE      = 30002,
50   VALUE_ENSURE_SIGNED = -1
51 };
52
53
54 enum ScaleFactor {
55   SCALE_FACTOR_ZERO   = 0,
56   SCALE_FACTOR_NORMAL = 64,
57   SCALE_FACTOR_MAX    = 128,
58   SCALE_FACTOR_NONE   = 255
59 };
60
61
62 /// Score enum keeps a midgame and an endgame value in a single
63 /// integer (enum), first LSB 16 bits are used to store endgame
64 /// value, while upper bits are used for midgame value.
65
66 // Compiler is free to choose the enum type as long as can keep
67 // its data, so ensure Score to be an integer type.
68 enum Score { ENSURE_32_BITS_SIZE_P = (1 << 16), ENSURE_32_BITS_SIZE_N = -(1 << 16)};
69
70 // Extracting the _signed_ lower and upper 16 bits it not so trivial
71 // because according to the standard a simple cast to short is
72 // implementation defined and so is a right shift of a signed integer.
73 inline Value mg_value(Score s) { return Value(((int(s) + 32768) & ~0xffff) / 0x10000); }
74
75 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
76 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
77 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
78 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
79 #else
80 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
81 #endif
82
83 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
84
85 // Division must be handled separately for each term
86 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
87
88 // Only declared but not defined. We don't want to multiply two scores due to
89 // a very high risk of overflow. So user should explicitly convert to integer.
90 inline Score operator*(Score s1, Score s2);
91
92
93 ////
94 //// Constants and variables
95 ////
96
97 /// Piece values, middle game and endgame
98
99 /// Important: If the material values are changed, one must also
100 /// adjust the piece square tables, and the method game_phase() in the
101 /// Position class!
102 ///
103 /// Values modified by Joona Kiiski
104
105 const Value PawnValueMidgame   = Value(0x0C6);
106 const Value PawnValueEndgame   = Value(0x102);
107 const Value KnightValueMidgame = Value(0x331);
108 const Value KnightValueEndgame = Value(0x34E);
109 const Value BishopValueMidgame = Value(0x344);
110 const Value BishopValueEndgame = Value(0x359);
111 const Value RookValueMidgame   = Value(0x4F6);
112 const Value RookValueEndgame   = Value(0x4FE);
113 const Value QueenValueMidgame  = Value(0x9D9);
114 const Value QueenValueEndgame  = Value(0x9FE);
115
116 const Value PieceValueMidgame[17] = {
117   VALUE_ZERO,
118   PawnValueMidgame, KnightValueMidgame, BishopValueMidgame,
119   RookValueMidgame, QueenValueMidgame,
120   VALUE_ZERO, VALUE_ZERO, VALUE_ZERO,
121   PawnValueMidgame, KnightValueMidgame, BishopValueMidgame,
122   RookValueMidgame, QueenValueMidgame,
123   VALUE_ZERO, VALUE_ZERO, VALUE_ZERO
124 };
125
126 const Value PieceValueEndgame[17] = {
127   VALUE_ZERO,
128   PawnValueEndgame, KnightValueEndgame, BishopValueEndgame,
129   RookValueEndgame, QueenValueEndgame,
130   VALUE_ZERO, VALUE_ZERO, VALUE_ZERO,
131   PawnValueEndgame, KnightValueEndgame, BishopValueEndgame,
132   RookValueEndgame, QueenValueEndgame,
133   VALUE_ZERO, VALUE_ZERO, VALUE_ZERO
134 };
135
136 /// Bonus for having the side to move (modified by Joona Kiiski)
137
138 const Score TempoValue = make_score(48, 22);
139
140
141 ////
142 //// Inline functions
143 ////
144
145 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
146 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
147
148
149 inline Value value_mate_in(int ply) {
150   return VALUE_MATE - ply;
151 }
152
153 inline Value value_mated_in(int ply) {
154   return -VALUE_MATE + ply;
155 }
156
157 inline bool is_upper_bound(ValueType vt) {
158   return (int(vt) & int(VALUE_TYPE_UPPER)) != 0;
159 }
160
161 inline bool is_lower_bound(ValueType vt) {
162   return (int(vt) & int(VALUE_TYPE_LOWER)) != 0;
163 }
164
165 inline Value piece_value_midgame(PieceType pt) {
166   return PieceValueMidgame[pt];
167 }
168
169 inline Value piece_value_endgame(PieceType pt) {
170   return PieceValueEndgame[pt];
171 }
172
173 inline Value piece_value_midgame(Piece p) {
174   return PieceValueMidgame[p];
175 }
176
177 inline Value piece_value_endgame(Piece p) {
178   return PieceValueEndgame[p];
179 }
180
181 #endif // !defined(VALUE_H_INCLUDED)