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