Updated copyright year to 2010
[stockfish] / src / pawns.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(PAWNS_H_INCLUDED)
22 #define PAWNS_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "bitboard.h"
29 #include "value.h"
30
31 ////
32 //// Types
33 ////
34
35 /// PawnInfo is a class which contains various information about a pawn
36 /// structure. Currently, it only includes a middle game and an end game
37 /// pawn structure evaluation, and a bitboard of passed pawns. We may want
38 /// to add further information in the future. A lookup to the pawn hash table
39 /// (performed by calling the get_pawn_info method in a PawnInfoTable object)
40 /// returns a pointer to a PawnInfo object.
41 class Position;
42
43 class PawnInfo {
44
45   friend class PawnInfoTable;
46
47 public:
48   PawnInfo() { clear(); }
49
50   Score pawns_value() const;
51   Value kingside_storm_value(Color c) const;
52   Value queenside_storm_value(Color c) const;
53   Bitboard pawn_attacks(Color c) const;
54   Bitboard passed_pawns() const;
55   int file_is_half_open(Color c, File f) const;
56   int has_open_file_to_left(Color c, File f) const;
57   int has_open_file_to_right(Color c, File f) const;
58   int get_king_shelter(const Position& pos, Color c, Square ksq);
59
60 private:
61   void clear();
62   int updateShelter(const Position& pos, Color c, Square ksq);
63
64   Key key;
65   Bitboard passedPawns;
66   Bitboard pawnAttacks[2];
67   Score value;
68   int16_t ksStormValue[2], qsStormValue[2];
69   uint8_t halfOpenFiles[2];
70   Square kingSquares[2];
71   uint8_t kingShelters[2];
72 };
73
74 /// The PawnInfoTable class represents a pawn hash table.  It is basically
75 /// just an array of PawnInfo objects and a few methods for accessing these
76 /// objects.  The most important method is get_pawn_info, which looks up a
77 /// position in the table and returns a pointer to a PawnInfo object.
78
79 class PawnInfoTable {
80
81 public:
82   PawnInfoTable(unsigned numOfEntries);
83   ~PawnInfoTable();
84   PawnInfo* get_pawn_info(const Position& pos);
85
86 private:
87   template<Color Us>
88   Score evaluate_pawns(const Position& pos, Bitboard ourPawns, Bitboard theirPawns, PawnInfo* pi);
89
90   unsigned size;
91   PawnInfo* entries;
92 };
93
94
95 ////
96 //// Inline functions
97 ////
98
99 inline Score PawnInfo::pawns_value() const {
100   return value;
101 }
102
103 inline Bitboard PawnInfo::passed_pawns() const {
104   return passedPawns;
105 }
106
107 inline Bitboard PawnInfo::pawn_attacks(Color c) const {
108   return pawnAttacks[c];
109 }
110
111 inline Value PawnInfo::kingside_storm_value(Color c) const {
112   return Value(ksStormValue[c]);
113 }
114
115 inline Value PawnInfo::queenside_storm_value(Color c) const {
116   return Value(qsStormValue[c]);
117 }
118
119 inline int PawnInfo::file_is_half_open(Color c, File f) const {
120   return (halfOpenFiles[c] & (1 << int(f)));
121 }
122
123 inline int PawnInfo::has_open_file_to_left(Color c, File f) const {
124   return halfOpenFiles[c] & ((1 << int(f)) - 1);
125 }
126
127 inline int PawnInfo::has_open_file_to_right(Color c, File f) const {
128   return halfOpenFiles[c] & ~((1 << int(f+1)) - 1);
129 }
130
131 inline int PawnInfo::get_king_shelter(const Position& pos, Color c, Square ksq) {
132   return (kingSquares[c] == ksq ? kingShelters[c] : updateShelter(pos, c, ksq));
133 }
134
135 #endif // !defined(PAWNS_H_INCLUDED)