a69ad8e8418535fbe01645368800815d19491b9f
[stockfish] / src / bitcount.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-2012 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
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #if !defined(BITCOUNT_H_INCLUDED)
22 #define BITCOUNT_H_INCLUDED
23
24 #include <cassert>
25 #include "types.h"
26
27 enum BitCountType {
28   CNT_64,
29   CNT_64_MAX15,
30   CNT_32,
31   CNT_32_MAX15,
32   CNT_HW_POPCNT
33 };
34
35 /// Determine at compile time the best popcount<> specialization according if
36 /// platform is 32 or 64 bits, to the maximum number of nonzero bits to count
37 /// and if hardware popcnt instruction is available.
38 const BitCountType Full  = HasPopCnt ? CNT_HW_POPCNT : Is64Bit ? CNT_64 : CNT_32;
39 const BitCountType Max15 = HasPopCnt ? CNT_HW_POPCNT : Is64Bit ? CNT_64_MAX15 : CNT_32_MAX15;
40
41
42 /// popcount() counts the number of nonzero bits in a bitboard
43 template<BitCountType> inline int popcount(Bitboard);
44
45 template<>
46 inline int popcount<CNT_64>(Bitboard b) {
47   b -=  (b >> 1) & 0x5555555555555555ULL;
48   b  = ((b >> 2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
49   b  = ((b >> 4) + b) & 0x0F0F0F0F0F0F0F0FULL;
50   return (b * 0x0101010101010101ULL) >> 56;
51 }
52
53 template<>
54 inline int popcount<CNT_64_MAX15>(Bitboard b) {
55   b -=  (b >> 1) & 0x5555555555555555ULL;
56   b  = ((b >> 2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
57   return (b * 0x1111111111111111ULL) >> 60;
58 }
59
60 template<>
61 inline int popcount<CNT_32>(Bitboard b) {
62   unsigned w = unsigned(b >> 32), v = unsigned(b);
63   v -=  (v >> 1) & 0x55555555; // 0-2 in 2 bits
64   w -=  (w >> 1) & 0x55555555;
65   v  = ((v >> 2) & 0x33333333) + (v & 0x33333333); // 0-4 in 4 bits
66   w  = ((w >> 2) & 0x33333333) + (w & 0x33333333);
67   v  = ((v >> 4) + v + (w >> 4) + w) & 0x0F0F0F0F;
68   return (v * 0x01010101) >> 24;
69 }
70
71 template<>
72 inline int popcount<CNT_32_MAX15>(Bitboard b) {
73   unsigned w = unsigned(b >> 32), v = unsigned(b);
74   v -=  (v >> 1) & 0x55555555; // 0-2 in 2 bits
75   w -=  (w >> 1) & 0x55555555;
76   v  = ((v >> 2) & 0x33333333) + (v & 0x33333333); // 0-4 in 4 bits
77   w  = ((w >> 2) & 0x33333333) + (w & 0x33333333);
78   return ((v + w) * 0x11111111) >> 28;
79 }
80
81 template<>
82 inline int popcount<CNT_HW_POPCNT>(Bitboard b) {
83
84 #if !defined(USE_POPCNT)
85
86   assert(false);
87   return b != 0; // Avoid 'b not used' warning
88
89 #elif defined(_MSC_VER) && defined(__INTEL_COMPILER)
90
91   return _mm_popcnt_u64(b);
92
93 #elif defined(_MSC_VER)
94
95   return (int)__popcnt64(b);
96
97 #else
98
99   unsigned long ret;
100   __asm__("popcnt %1, %0" : "=r" (ret) : "r" (b));
101   return ret;
102
103 #endif
104 }
105
106 #endif // !defined(BITCOUNT_H_INCLUDED)