Clarify we want Score and Value to be integers
[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 #if !defined(VALUE_H_INCLUDED)
21 #define VALUE_H_INCLUDED
22
23 #include <climits>
24
25 #include "types.h"
26
27
28 enum ValueType {
29   VALUE_TYPE_NONE  = 0,
30   VALUE_TYPE_UPPER = 1,
31   VALUE_TYPE_LOWER = 2,
32   VALUE_TYPE_EXACT = VALUE_TYPE_UPPER | VALUE_TYPE_LOWER
33 };
34
35
36 enum Value {
37   VALUE_ZERO      = 0,
38   VALUE_DRAW      = 0,
39   VALUE_KNOWN_WIN = 15000,
40   VALUE_MATE      = 30000,
41   VALUE_INFINITE  = 30001,
42   VALUE_NONE      = 30002,
43   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
44   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
45 };
46
47 ENABLE_OPERATORS_ON(Value)
48
49 // Extra operators
50 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
51 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
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 {
69     SCORE_ZERO = 0,
70     SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
71     SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
72 };
73
74 // Extracting the _signed_ lower and upper 16 bits it not so trivial
75 // because according to the standard a simple cast to short is
76 // implementation defined and so is a right shift of a signed integer.
77 inline Value mg_value(Score s) { return Value(((int(s) + 32768) & ~0xffff) / 0x10000); }
78
79 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
80 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
81 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
82 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
83 #else
84 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
85 #endif
86
87 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
88
89 // Division must be handled separately for each term
90 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
91
92 // Only declared but not defined. We don't want to multiply two scores due to
93 // a very high risk of overflow. So user should explicitly convert to integer.
94 inline Score operator*(Score s1, Score s2);
95
96 // Remaining operators are standard
97 inline Score operator+ (const Score d1, const Score d2) { return Score(int(d1) + int(d2)); }
98 inline Score operator- (const Score d1, const Score d2) { return Score(int(d1) - int(d2)); }
99 inline Score operator* (int i, const Score d) {  return Score(i * int(d)); }
100 inline Score operator* (const Score d, int i) {  return Score(int(d) * i); }
101 inline Score operator- (const Score d) { return Score(-int(d)); }
102 inline void operator+= (Score& d1, const Score d2) { d1 = d1 + d2; }
103 inline void operator-= (Score& d1, const Score d2) { d1 = d1 - d2; }
104 inline void operator*= (Score& d, int i) { d = Score(int(d) * i); }
105 inline void operator/= (Score& d, int i) { d = Score(int(d) / i); }
106
107 inline Value value_mate_in(int ply) {
108   return VALUE_MATE - ply;
109 }
110
111 inline Value value_mated_in(int ply) {
112   return -VALUE_MATE + ply;
113 }
114
115 #endif // !defined(VALUE_H_INCLUDED)