1
//===- llvm/ADT/SmallBitVector.h - 'Normally small' bit vectors -*- C++ -*-===//
3
// The LLVM Compiler Infrastructure
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
8
//===----------------------------------------------------------------------===//
10
// This file implements the SmallBitVector class.
12
//===----------------------------------------------------------------------===//
14
#ifndef LLVM_ADT_SMALLBITVECTOR_H
15
#define LLVM_ADT_SMALLBITVECTOR_H
17
#include "llvm/ADT/BitVector.h"
18
#include "llvm/ADT/PointerIntPair.h"
19
#include "llvm/Support/MathExtras.h"
24
/// SmallBitVector - This is a 'bitvector' (really, a variable-sized bit array),
25
/// optimized for the case when the array is small. It contains one
26
/// pointer-sized field, which is directly used as a plain collection of bits
27
/// when possible, or as a pointer to a larger heap-allocated array when
28
/// necessary. This allows normal "small" cases to be fast without losing
29
/// generality for large inputs.
31
class SmallBitVector {
32
// TODO: In "large" mode, a pointer to a BitVector is used, leading to an
33
// unnecessary level of indirection. It would be more efficient to use a
34
// pointer to memory containing size, allocation size, and the array of bits.
35
PointerIntPair<BitVector *, 1, uintptr_t> X;
37
// The number of bits in this class.
38
static const size_t NumBaseBits = sizeof(uintptr_t) * CHAR_BIT;
40
// One bit is used to discriminate between small and large mode. The
41
// remaining bits are used for the small-mode representation.
42
static const size_t SmallNumRawBits = NumBaseBits - 1;
44
// A few more bits are used to store the size of the bit set in small mode.
45
// Theoretically this is a ceil-log2. These bits are encoded in the most
46
// significant bits of the raw bits.
47
static const size_t SmallNumSizeBits = (NumBaseBits == 32 ? 5 :
48
NumBaseBits == 64 ? 6 :
51
// The remaining bits are used to store the actual set in small mode.
52
static const size_t SmallNumDataBits = SmallNumRawBits - SmallNumSizeBits;
54
bool isSmall() const {
58
void switchToSmall(uintptr_t NewSmallBits, size_t NewSize) {
60
setSmallSize(NewSize);
61
setSmallBits(NewSmallBits);
64
void switchToLarge(BitVector *BV) {
69
// Return all the bits used for the "small" representation; this includes
70
// bits for the size as well as the element bits.
71
uintptr_t getSmallRawBits() const {
72
return reinterpret_cast<uintptr_t>(X.getPointer()) >> 1;
75
void setSmallRawBits(uintptr_t NewRawBits) {
76
return X.setPointer(reinterpret_cast<BitVector *>(NewRawBits << 1));
80
size_t getSmallSize() const {
81
return getSmallRawBits() >> SmallNumDataBits;
84
void setSmallSize(size_t Size) {
85
setSmallRawBits(getSmallBits() | (Size << SmallNumDataBits));
88
// Return the element bits.
89
uintptr_t getSmallBits() const {
90
return getSmallRawBits() & ~(~uintptr_t(0) << SmallNumDataBits);
93
void setSmallBits(uintptr_t NewBits) {
94
setSmallRawBits((getSmallRawBits() & (~uintptr_t(0) << SmallNumDataBits)) |
95
(NewBits & ~(~uintptr_t(0) << getSmallSize())));
99
/// SmallBitVector default ctor - Creates an empty bitvector.
100
SmallBitVector() : X(0, 1) {}
102
/// SmallBitVector ctor - Creates a bitvector of specified number of bits. All
103
/// bits are initialized to the specified value.
104
explicit SmallBitVector(unsigned s, bool t = false) : X(0, 1) {
105
if (s <= SmallNumRawBits)
106
switchToSmall(t ? ~uintptr_t(0) : 0, s);
108
switchToLarge(new BitVector(s, t));
111
/// SmallBitVector copy ctor.
112
SmallBitVector(const SmallBitVector &RHS) {
116
switchToLarge(new BitVector(*RHS.X.getPointer()));
121
delete X.getPointer();
124
/// empty - Tests whether there are no bits in this bitvector.
126
return isSmall() ? getSmallSize() == 0 : X.getPointer()->empty();
129
/// size - Returns the number of bits in this bitvector.
130
size_t size() const {
131
return isSmall() ? getSmallSize() : X.getPointer()->size();
134
/// count - Returns the number of bits which are set.
135
unsigned count() const {
137
uintptr_t Bits = getSmallBits();
138
if (sizeof(uintptr_t) * CHAR_BIT == 32)
139
return CountPopulation_32(Bits);
140
if (sizeof(uintptr_t) * CHAR_BIT == 64)
141
return CountPopulation_64(Bits);
142
assert(0 && "Unsupported!");
144
return X.getPointer()->count();
147
/// any - Returns true if any bit is set.
150
return getSmallBits() != 0;
151
return X.getPointer()->any();
154
/// none - Returns true if none of the bits are set.
157
return getSmallBits() == 0;
158
return X.getPointer()->none();
161
/// find_first - Returns the index of the first set bit, -1 if none
162
/// of the bits are set.
163
int find_first() const {
165
uintptr_t Bits = getSmallBits();
166
if (sizeof(uintptr_t) * CHAR_BIT == 32)
167
return CountTrailingZeros_32(Bits);
168
if (sizeof(uintptr_t) * CHAR_BIT == 64)
169
return CountTrailingZeros_64(Bits);
170
assert(0 && "Unsupported!");
172
return X.getPointer()->find_first();
175
/// find_next - Returns the index of the next set bit following the
176
/// "Prev" bit. Returns -1 if the next set bit is not found.
177
int find_next(unsigned Prev) const {
179
uintptr_t Bits = getSmallBits();
180
// Mask off previous bits.
181
Bits &= ~uintptr_t(0) << Prev;
182
if (sizeof(uintptr_t) * CHAR_BIT == 32)
183
return CountTrailingZeros_32(Bits);
184
if (sizeof(uintptr_t) * CHAR_BIT == 64)
185
return CountTrailingZeros_64(Bits);
186
assert(0 && "Unsupported!");
188
return X.getPointer()->find_next(Prev);
191
/// clear - Clear all bits.
194
delete X.getPointer();
198
/// resize - Grow or shrink the bitvector.
199
void resize(unsigned N, bool t = false) {
201
X.getPointer()->resize(N, t);
202
} else if (getSmallSize() >= N) {
204
setSmallBits(getSmallBits());
206
BitVector *BV = new BitVector(N, t);
207
uintptr_t OldBits = getSmallBits();
208
for (size_t i = 0, e = getSmallSize(); i != e; ++i)
209
(*BV)[i] = (OldBits >> i) & 1;
214
void reserve(unsigned N) {
216
if (N > SmallNumDataBits) {
217
uintptr_t OldBits = getSmallRawBits();
218
size_t SmallSize = getSmallSize();
219
BitVector *BV = new BitVector(SmallSize);
220
for (size_t i = 0; i < SmallSize; ++i)
221
if ((OldBits >> i) & 1)
227
X.getPointer()->reserve(N);
232
SmallBitVector &set() {
234
setSmallBits(~uintptr_t(0));
236
X.getPointer()->set();
240
SmallBitVector &set(unsigned Idx) {
242
setSmallBits(getSmallBits() | (uintptr_t(1) << Idx));
244
X.getPointer()->set(Idx);
248
SmallBitVector &reset() {
252
X.getPointer()->reset();
256
SmallBitVector &reset(unsigned Idx) {
258
setSmallBits(getSmallBits() & ~(uintptr_t(1) << Idx));
260
X.getPointer()->reset(Idx);
264
SmallBitVector &flip() {
266
setSmallBits(~getSmallBits());
268
X.getPointer()->flip();
272
SmallBitVector &flip(unsigned Idx) {
274
setSmallBits(getSmallBits() ^ (uintptr_t(1) << Idx));
276
X.getPointer()->flip(Idx);
281
SmallBitVector operator~() const {
282
return SmallBitVector(*this).flip();
286
// TODO: Add an index operator which returns a "reference" (proxy class).
287
bool operator[](unsigned Idx) const {
288
assert(Idx < size() && "Out-of-bounds Bit access.");
290
return ((getSmallBits() >> Idx) & 1) != 0;
291
return X.getPointer()->operator[](Idx);
294
bool test(unsigned Idx) const {
298
// Comparison operators.
299
bool operator==(const SmallBitVector &RHS) const {
300
if (size() != RHS.size())
303
return getSmallBits() == RHS.getSmallBits();
305
return *X.getPointer() == *RHS.X.getPointer();
308
bool operator!=(const SmallBitVector &RHS) const {
309
return !(*this == RHS);
312
// Intersection, union, disjoint union.
313
SmallBitVector &operator&=(const SmallBitVector &RHS) {
314
resize(std::max(size(), RHS.size()));
316
setSmallBits(getSmallBits() & RHS.getSmallBits());
317
else if (!RHS.isSmall())
318
X.getPointer()->operator&=(*RHS.X.getPointer());
320
SmallBitVector Copy = RHS;
322
X.getPointer()->operator&=(*Copy.X.getPointer());
327
SmallBitVector &operator|=(const SmallBitVector &RHS) {
328
resize(std::max(size(), RHS.size()));
330
setSmallBits(getSmallBits() | RHS.getSmallBits());
331
else if (!RHS.isSmall())
332
X.getPointer()->operator|=(*RHS.X.getPointer());
334
SmallBitVector Copy = RHS;
336
X.getPointer()->operator|=(*Copy.X.getPointer());
341
SmallBitVector &operator^=(const SmallBitVector &RHS) {
342
resize(std::max(size(), RHS.size()));
344
setSmallBits(getSmallBits() ^ RHS.getSmallBits());
345
else if (!RHS.isSmall())
346
X.getPointer()->operator^=(*RHS.X.getPointer());
348
SmallBitVector Copy = RHS;
350
X.getPointer()->operator^=(*Copy.X.getPointer());
355
// Assignment operator.
356
const SmallBitVector &operator=(const SmallBitVector &RHS) {
361
switchToLarge(new BitVector(*RHS.X.getPointer()));
364
*X.getPointer() = *RHS.X.getPointer();
366
delete X.getPointer();
373
void swap(SmallBitVector &RHS) {
378
inline SmallBitVector
379
operator&(const SmallBitVector &LHS, const SmallBitVector &RHS) {
380
SmallBitVector Result(LHS);
385
inline SmallBitVector
386
operator|(const SmallBitVector &LHS, const SmallBitVector &RHS) {
387
SmallBitVector Result(LHS);
392
inline SmallBitVector
393
operator^(const SmallBitVector &LHS, const SmallBitVector &RHS) {
394
SmallBitVector Result(LHS);
399
} // End llvm namespace
402
/// Implement std::swap in terms of BitVector swap.
404
swap(llvm::SmallBitVector &LHS, llvm::SmallBitVector &RHS) {