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