aboutsummaryrefslogtreecommitdiff
path: root/src/dolphin/BitSet.h
blob: 424364eba936eb7d1981329e8509497ec73e13f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
// This file is under the public domain.

#pragma once

#include <cstddef>
#include <bitset>
#include <initializer_list>
#include <type_traits>
#include "../types.h"

namespace Common
{
using namespace melonDS;
#if defined(__GNUC__) || defined(__clang__)
__attribute((always_inline)) static constexpr int CountSetBits(u8 val)
{
  return __builtin_popcount(val);
}
__attribute((always_inline)) static constexpr int CountSetBits(u16 val)
{
  return __builtin_popcount(val);
}
__attribute((always_inline)) static constexpr int CountSetBits(u32 val)
{
  return __builtin_popcount(val);
}
__attribute((always_inline)) static constexpr int CountSetBits(u64 val)
{
  return __builtin_popcountll(val);
}
__attribute((always_inline)) static constexpr int LeastSignificantSetBit(u8 val)
{
  return __builtin_ctz(val);
}
__attribute((always_inline)) static constexpr int LeastSignificantSetBit(u16 val)
{
  return __builtin_ctz(val);
}
__attribute((always_inline)) static constexpr int LeastSignificantSetBit(u32 val)
{
  return __builtin_ctz(val);
}
__attribute((always_inline)) static constexpr int LeastSignificantSetBit(u64 val)
{
  return __builtin_ctzll(val);
}
#elif defined(_MSC_VER)
#include <intrin.h>
// MSVC __popcnt doesn't switch between hardware availability like gcc does, can't use it, let C++ implementation handle it
__forceinline static int CountSetBits(u8 val)
{
  return std::bitset<8>(val).count();
}
__forceinline static int CountSetBits(u16 val)
{
  return std::bitset<16>(val).count();
}
__forceinline static int CountSetBits(u32 val)
{
  return std::bitset<32>(val).count();
}
__forceinline static int CountSetBits(u64 val)
{
  return std::bitset<64>(val).count();
}
__forceinline static int LeastSignificantSetBit(u8 val)
{
  unsigned long count;
  _BitScanForward(&count, val);
  return count;
}
__forceinline static int LeastSignificantSetBit(u16 val)
{
  unsigned long count;
  _BitScanForward(&count, val);
  return count;
}
__forceinline static int LeastSignificantSetBit(u32 val)
{
  unsigned long count;
  _BitScanForward(&count, val);
  return count;
}
__forceinline static int LeastSignificantSetBit(u64 val)
{
#if defined(_WIN64)
  unsigned long count;
  _BitScanForward64(&count, val);
  return count;
#else
  unsigned long tmp;
  _BitScanForward(&tmp, (u32)(val & 0x00000000FFFFFFFFull));
  if (tmp)
    return tmp;
  _BitScanForward(&tmp, (u32)((val & 0xFFFFFFFF00000000ull) >> 32));
  return tmp ? tmp + 32 : 0;
#endif
}
#endif

// Similar to std::bitset, this is a class which encapsulates a bitset, i.e.
// using the set bits of an integer to represent a set of integers.  Like that
// class, it acts like an array of bools:
//     BitSet32 bs;
//     bs[1] = true;
// but also like the underlying integer ([0] = least significant bit):
//     BitSet32 bs2 = ...;
//     bs = (bs ^ bs2) & BitSet32(0xffff);
// The following additional functionality is provided:
// - Construction using an initializer list.
//     BitSet bs { 1, 2, 4, 8 };
// - Efficiently iterating through the set bits:
//     for (int i : bs)
//         [i is the *index* of a set bit]
//   (This uses the appropriate CPU instruction to find the next set bit in one
//   operation.)
// - Counting set bits using .Count() - see comment on that method.

// TODO: use constexpr when MSVC gets out of the Dark Ages

template <typename IntTy>
class BitSet
{
  static_assert(!std::is_signed<IntTy>::value, "BitSet should not be used with signed types");

public:
  // A reference to a particular bit, returned from operator[].
  class Ref
  {
  public:
    constexpr Ref(Ref&& other) : m_bs(other.m_bs), m_mask(other.m_mask) {}
    constexpr Ref(BitSet* bs, IntTy mask) : m_bs(bs), m_mask(mask) {}
    constexpr operator bool() const { return (m_bs->m_val & m_mask) != 0; }
    bool operator=(bool set)
    {
      m_bs->m_val = (m_bs->m_val & ~m_mask) | (set ? m_mask : 0);
      return set;
    }

  private:
    BitSet* m_bs;
    IntTy m_mask;
  };

  // A STL-like iterator is required to be able to use range-based for loops.
  class Iterator
  {
  public:
    constexpr Iterator(const Iterator& other) : m_val(other.m_val), m_bit(other.m_bit) {}
    constexpr Iterator(IntTy val, int bit) : m_val(val), m_bit(bit) {}
    Iterator& operator=(Iterator other)
    {
      new (this) Iterator(other);
      return *this;
    }
    Iterator& operator++()
    {
      if (m_val == 0)
      {
        m_bit = -1;
      }
      else
      {
        int bit = LeastSignificantSetBit(m_val);
        m_val &= ~(1 << bit);
        m_bit = bit;
      }
      return *this;
    }
    Iterator operator++(int)
    {
      Iterator other(*this);
      ++*this;
      return other;
    }
    constexpr int operator*() const { return m_bit; }
    constexpr bool operator==(Iterator other) const { return m_bit == other.m_bit; }
    constexpr bool operator!=(Iterator other) const { return m_bit != other.m_bit; }

  private:
    IntTy m_val;
    int m_bit;
  };

  constexpr BitSet() : m_val(0) {}
  constexpr explicit BitSet(IntTy val) : m_val(val) {}
  BitSet(std::initializer_list<int> init)
  {
    m_val = 0;
    for (int bit : init)
      m_val |= (IntTy)1 << bit;
  }

  constexpr static BitSet AllTrue(size_t count)
  {
    return BitSet(count == sizeof(IntTy) * 8 ? ~(IntTy)0 : (((IntTy)1 << count) - 1));
  }

  Ref operator[](size_t bit) { return Ref(this, (IntTy)1 << bit); }
  constexpr const Ref operator[](size_t bit) const { return (*const_cast<BitSet*>(this))[bit]; }
  constexpr bool operator==(BitSet other) const { return m_val == other.m_val; }
  constexpr bool operator!=(BitSet other) const { return m_val != other.m_val; }
  constexpr bool operator<(BitSet other) const { return m_val < other.m_val; }
  constexpr bool operator>(BitSet other) const { return m_val > other.m_val; }
  constexpr BitSet operator|(BitSet other) const { return BitSet(m_val | other.m_val); }
  constexpr BitSet operator&(BitSet other) const { return BitSet(m_val & other.m_val); }
  constexpr BitSet operator^(BitSet other) const { return BitSet(m_val ^ other.m_val); }
  constexpr BitSet operator~() const { return BitSet(~m_val); }
  constexpr BitSet operator<<(IntTy shift) const { return BitSet(m_val << shift); }
  constexpr BitSet operator>>(IntTy shift) const { return BitSet(m_val >> shift); }
  constexpr explicit operator bool() const { return m_val != 0; }
  BitSet& operator|=(BitSet other) { return *this = *this | other; }
  BitSet& operator&=(BitSet other) { return *this = *this & other; }
  BitSet& operator^=(BitSet other) { return *this = *this ^ other; }
  BitSet& operator<<=(IntTy shift) { return *this = *this << shift; }
  BitSet& operator>>=(IntTy shift) { return *this = *this >> shift; }
  constexpr unsigned int Count() const { return CountSetBits(m_val); }
  constexpr Iterator begin() const { return ++Iterator(m_val, 0); }
  constexpr Iterator end() const { return Iterator(m_val, -1); }
  IntTy m_val;
};

using BitSet8 = BitSet<u8>;
using BitSet16 = BitSet<u16>;
using BitSet32 = BitSet<u32>;
using BitSet64 = BitSet<u64>;
}  // namespace Common