include/llvm/ADT/BitVector.h

   1 //===- llvm/ADT/BitVector.h - Bit vectors -----------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Evan Cheng and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the BitVector class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_BITVECTOR_H
  15 #define LLVM_ADT_BITVECTOR_H
  16
  17 #include "llvm/Support/MathExtras.h"
  18
  19 namespace llvm {
  20
  21 class BitVector {
  22   typedef unsigned long BitWord;
  23
  24   enum { BITS_PER_WORD = sizeof(BitWord) * 8 };
  25
  26   BitWord  *Bits;        // Actual bits.
  27   unsigned Size;         // Size of bitvector in bits.
  28   unsigned Capacity;     // Size of allocated memory in BitWord.
  29
  30 public:
  31   // Encapsulation of a single bit.
  32   class reference {
  33     friend class BitVector;
  34
  35     BitWord *WordRef;
  36     unsigned BitPos;
  37
  38     reference();  // Undefined
  39
  40   public:
  41     reference(BitVector &b, unsigned Idx) {
  42       WordRef = &b.Bits[Idx / BITS_PER_WORD];
  43       BitPos = Idx % BITS_PER_WORD;
  44     }
  45
  46     ~reference() {}
  47
  48     reference& operator=(bool t) {
  49       if (t)
  50         *WordRef |= 1L << BitPos;
  51       else
  52         *WordRef &= ~(1L << BitPos);
  53       return *this;
  54     }
  55
  56     reference& operator=(const reference& rhs) {
  57       if (*rhs.WordRef & (1 << rhs.BitPos))
  58         *WordRef |= 1L << BitPos;
  59       else
  60         *WordRef &= ~(1L << BitPos);
  61       return *this;
  62     }
  63
  64     operator bool() const {
  65       return (*WordRef) & (1L << BitPos);
  66     }
  67   };
  68
  69
  70   /// BitVector default ctor - Creates an empty bitvector.
  71   BitVector() : Size(0), Capacity(0) {
  72     Bits = NULL;
  73   }
  74
  75   /// BitVector ctor - Creates a bitvector of specified number of bits. All
  76   /// bits are initialized to the specified value.
  77   explicit BitVector(unsigned s, bool t = false) : Size(s) {
  78     Capacity = NumBitWords(s);
  79     Bits = new BitWord[Capacity];
  80     init_words(Bits, Capacity, t);
  81     if (t)
  82       clear_unused_bits();
  83   }
  84
  85   /// BitVector copy ctor.
  86   BitVector(const BitVector &RHS) : Size(RHS.size()) {
  87     if (Size == 0) {
  88       Bits = NULL;
  89       return;
  90     }
  91
  92     Capacity = NumBitWords(RHS.size());
  93     Bits = new BitWord[Capacity];
  94     std::copy(RHS.Bits, &RHS.Bits[Capacity], Bits);
  95   }
  96
  97   /// size - Returns the number of bits in this bitvector.
  98   unsigned size() const { return Size; }
  99
 100   /// count - Returns the number of bits which are set.
 101   unsigned count() const {
 102     unsigned NumBits = 0;
 103     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 104       if (sizeof(BitWord) == 4)
 105         NumBits += CountPopulation_32(Bits[i]);
 106       else if (sizeof(BitWord) == 8)
 107         NumBits += CountPopulation_64(Bits[i]);
 108       else
 109         assert(0 && "Unsupported!")
 110     return NumBits;
 111   }
 112
 113   /// any - Returns true if any bit is set.
 114   bool any() const {
 115     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 116       if (Bits[i] != 0)
 117         return true;
 118     return false;
 119   }
 120
 121   /// none - Returns true if none of the bits are set.
 122   bool none() const {
 123     return !any();
 124   }
 125
 126   /// find_first - Returns the index of the first set bit, -1 if none
 127   /// of the bits are set.
 128   int find_first() const {
 129     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 130       if (Bits[i] != 0)
 131         return i * BITS_PER_WORD + CountTrailingZeros_32(Bits[i]);
 132     return -1;
 133   }
 134
 135   /// find_next - Returns the index of the next set bit following the
 136   /// "Prev" bit. Returns -1 if the next set bit is not found.
 137   int find_next(unsigned Prev) const {
 138     ++Prev;
 139     if (Prev >= Size)
 140       return -1;
 141
 142     unsigned WordPos = Prev / BITS_PER_WORD;
 143     unsigned BitPos = Prev % BITS_PER_WORD;
 144     BitWord Copy = Bits[WordPos];
 145     // Mask off previous bits.
 146     Copy &= ~0 << BitPos;
 147
 148     if (Copy != 0)
 149       return WordPos * BITS_PER_WORD + CountTrailingZeros_32(Copy);
 150
 151     // Check subsequent words.
 152     for (unsigned i = WordPos+1; i < NumBitWords(size()); ++i)
 153       if (Bits[i] != 0)
 154         return i * BITS_PER_WORD + CountTrailingZeros_32(Bits[i]);
 155     return -1;
 156   }
 157
 158   /// clear - Clear all bits.
 159   void clear() {
 160     Size = 0;
 161   }
 162
 163   /// resize - Grow or shrink the bitvector.
 164   void resize(unsigned N, bool t = false) {
 165     if (N > Capacity * BITS_PER_WORD) {
 166       unsigned OldCapacity = Capacity;
 167       grow(N);
 168       init_words(&Bits[OldCapacity], (Capacity-OldCapacity), t);
 169     }
 170     Size = N;
 171     if (t)
 172       clear_unused_bits();
 173   }
 174
 175   void reserve(unsigned N) {
 176     if (N > Capacity * BITS_PER_WORD)
 177       grow(N);
 178   }
 179
 180   // Set, reset, flip
 181   BitVector &set() {
 182     init_words(Bits, Capacity, true);
 183     clear_unused_bits();
 184     return *this;
 185   }
 186
 187   BitVector &set(unsigned Idx) {
 188     Bits[Idx / BITS_PER_WORD] |= 1L << (Idx % BITS_PER_WORD);
 189     return *this;
 190   }
 191
 192   BitVector &reset() {
 193     init_words(Bits, Capacity, false);
 194     return *this;
 195   }
 196
 197   BitVector &reset(unsigned Idx) {
 198     Bits[Idx / BITS_PER_WORD] &= ~(1L << (Idx % BITS_PER_WORD));
 199     return *this;
 200   }
 201
 202   BitVector &flip() {
 203     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 204       Bits[i] = ~Bits[i];
 205     clear_unused_bits();
 206     return *this;
 207   }
 208
 209   BitVector &flip(unsigned Idx) {
 210     Bits[Idx / BITS_PER_WORD] ^= 1L << (Idx % BITS_PER_WORD);
 211     return *this;
 212   }
 213
 214   // No argument flip.
 215   BitVector operator~() const {
 216     return BitVector(*this).flip();
 217   }
 218
 219   // Indexing.
 220   reference operator[](unsigned Idx) {
 221     return reference(*this, Idx);
 222   }
 223
 224   bool operator[](unsigned Idx) const {
 225     BitWord Mask = 1L << (Idx % BITS_PER_WORD);
 226     return (Bits[Idx / BITS_PER_WORD] & Mask) != 0;
 227   }
 228
 229   bool test(unsigned Idx) const {
 230     return (*this)[Idx];
 231   }
 232
 233   // Comparison operators.
 234   bool operator==(const BitVector &RHS) const {
 235     if (Size != RHS.Size)
 236       return false;
 237
 238     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 239       if (Bits[i] != RHS.Bits[i])
 240         return false;
 241     return true;
 242   }
 243
 244   bool operator!=(const BitVector &RHS) const {
 245     return !(*this == RHS);
 246   }
 247
 248   // Intersection, union, disjoint union.
 249   BitVector operator&=(const BitVector &RHS) {
 250     assert(Size == RHS.Size && "Illegal operation!");
 251     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 252       Bits[i] &= RHS.Bits[i];
 253     return *this;
 254   }
 255
 256   BitVector operator|=(const BitVector &RHS) {
 257     assert(Size == RHS.Size && "Illegal operation!");
 258     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 259       Bits[i] |= RHS.Bits[i];
 260     return *this;
 261   }
 262
 263   BitVector operator^=(const BitVector &RHS) {
 264     assert(Size == RHS.Size && "Illegal operation!");
 265     for (unsigned i = 0; i < NumBitWords(size()); ++i)
 266       Bits[i] ^= RHS.Bits[i];
 267     return *this;
 268   }
 269
 270   // Assignment operator.
 271   const BitVector &operator=(const BitVector &RHS) {
 272     if (this == &RHS) return *this;
 273
 274     Size = RHS.size();
 275     unsigned RHSWords = NumBitWords(Size);
 276     if (Size <= Capacity * BITS_PER_WORD) {
 277       std::copy(RHS.Bits, &RHS.Bits[RHSWords], Bits);
 278       clear_unused_bits();
 279       return *this;
 280     }
 281
 282     // Grow the bitvector to have enough elements.
 283     Capacity = NumBitWords(Size);
 284     BitWord *NewBits = new BitWord[Capacity];
 285     std::copy(RHS.Bits, &RHS.Bits[RHSWords], NewBits);
 286
 287     // Destroy the old bits.
 288     delete[] Bits;
 289     Bits = NewBits;
 290
 291     return *this;
 292   }
 293
 294 private:
 295   unsigned NumBitWords(unsigned S) const {
 296     return (S + BITS_PER_WORD-1) / BITS_PER_WORD;
 297   }
 298
 299   // Clear the unused top bits in the high word.
 300   void clear_unused_bits() {
 301     if (Size) {
 302       unsigned ExtraBits = Size % BITS_PER_WORD;
 303       Bits[Size / BITS_PER_WORD] &= ~(~0 << ExtraBits);
 304     }
 305   }
 306
 307   void grow(unsigned NewSize) {
 308     unsigned OldCapacity = Capacity;
 309     Capacity = NumBitWords(NewSize);
 310     BitWord *NewBits = new BitWord[Capacity];
 311
 312     // Copy the old bits over.
 313     if (OldCapacity != 0)
 314       std::copy(Bits, &Bits[OldCapacity], NewBits);
 315
 316     // Destroy the old bits.
 317     delete[] Bits;
 318     Bits = NewBits;
 319   }
 320
 321   void init_words(BitWord *B, unsigned NumWords, bool t) {
 322     memset(B, 0 - (int)t, NumWords*sizeof(BitWord));
 323   }
 324 };
 325
 326 inline BitVector operator&(const BitVector &LHS, const BitVector &RHS) {
 327   BitVector Result(LHS);
 328   Result &= RHS;
 329   return Result;
 330 }
 331
 332 inline BitVector operator|(const BitVector &LHS, const BitVector &RHS) {
 333   BitVector Result(LHS);
 334   Result |= RHS;
 335   return Result;
 336 }
 337
 338 inline BitVector operator^(const BitVector &LHS, const BitVector &RHS) {
 339   BitVector Result(LHS);
 340   Result ^= RHS;
 341   return Result;
 342 }
 343
 344 } // End llvm namespace
 345 #endif