include/llvm/ADT/SparseBitVector.h

   1 //===- llvm/ADT/SparseBitVector.h - Efficient Sparse BitVector -*- C++ -*- ===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the SparseBitVector class.  See the doxygen comment for
  11 // SparseBitVector for more details on the algorithm used.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ADT_SPARSEBITVECTOR_H
  16 #define LLVM_ADT_SPARSEBITVECTOR_H
  17
  18 #include <cassert>
  19 #include <cstring>
  20 #include "llvm/Support/DataTypes.h"
  21 #include "llvm/ADT/STLExtras.h"
  22 #include "llvm/Support/MathExtras.h"
  23 #include "llvm/ADT/ilist.h"
  24
  25 namespace llvm {
  26
  27 /// SparseBitVector is an implementation of a bitvector that is sparse by only
  28 /// storing the elements that have non-zero bits set.  In order to make this
  29 /// fast for the most common cases, SparseBitVector is implemented as a linked
  30 /// list of SparseBitVectorElements.  We maintain a pointer to the last
  31 /// SparseBitVectorElement accessed (in the form of a list iterator), in order
  32 /// to make multiple in-order test/set constant time after the first one is
  33 /// executed.  Note that using vectors to store SparseBitVectorElement's does
  34 /// not work out very well because it causes insertion in the middle to take
  35 /// enormous amounts of time with a large amount of bits.  Other structures that
  36 /// have better worst cases for insertion in the middle (various balanced trees,
  37 /// etc) do not perform as well in practice as a linked list with this iterator
  38 /// kept up to date.  They are also significantly more memory intensive.
  39
  40
  41 template <unsigned ElementSize = 128>
  42 struct SparseBitVectorElement
  43   : ilist_node<SparseBitVectorElement<ElementSize> > {
  44 public:
  45   typedef unsigned long BitWord;
  46   enum {
  47     BITWORD_SIZE = sizeof(BitWord) * 8,
  48     BITWORDS_PER_ELEMENT = (ElementSize + BITWORD_SIZE - 1) / BITWORD_SIZE,
  49     BITS_PER_ELEMENT = ElementSize
  50   };
  51
  52 private:
  53   // Index of Element in terms of where first bit starts.
  54   unsigned ElementIndex;
  55   BitWord Bits[BITWORDS_PER_ELEMENT];
  56   // Needed for sentinels
  57   friend class ilist_sentinel_traits<SparseBitVectorElement>;
  58   SparseBitVectorElement() {
  59     ElementIndex = ~0U;
  60     memset(&Bits[0], 0, sizeof (BitWord) * BITWORDS_PER_ELEMENT);
  61   }
  62
  63 public:
  64   explicit SparseBitVectorElement(unsigned Idx) {
  65     ElementIndex = Idx;
  66     memset(&Bits[0], 0, sizeof (BitWord) * BITWORDS_PER_ELEMENT);
  67   }
  68
  69   // Comparison.
  70   bool operator==(const SparseBitVectorElement &RHS) const {
  71     if (ElementIndex != RHS.ElementIndex)
  72       return false;
  73     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i)
  74       if (Bits[i] != RHS.Bits[i])
  75         return false;
  76     return true;
  77   }
  78
  79   bool operator!=(const SparseBitVectorElement &RHS) const {
  80     return !(*this == RHS);
  81   }
  82
  83   // Return the bits that make up word Idx in our element.
  84   BitWord word(unsigned Idx) const {
  85     assert (Idx < BITWORDS_PER_ELEMENT);
  86     return Bits[Idx];
  87   }
  88
  89   unsigned index() const {
  90     return ElementIndex;
  91   }
  92
  93   bool empty() const {
  94     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i)
  95       if (Bits[i])
  96         return false;
  97     return true;
  98   }
  99
 100   void set(unsigned Idx) {
 101     Bits[Idx / BITWORD_SIZE] |= 1L << (Idx % BITWORD_SIZE);
 102   }
 103
 104   bool test_and_set (unsigned Idx) {
 105     bool old = test(Idx);
 106     if (!old) {
 107       set(Idx);
 108       return true;
 109     }
 110     return false;
 111   }
 112
 113   void reset(unsigned Idx) {
 114     Bits[Idx / BITWORD_SIZE] &= ~(1L << (Idx % BITWORD_SIZE));
 115   }
 116
 117   bool test(unsigned Idx) const {
 118     return Bits[Idx / BITWORD_SIZE] & (1L << (Idx % BITWORD_SIZE));
 119   }
 120
 121   unsigned count() const {
 122     unsigned NumBits = 0;
 123     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i)
 124       if (sizeof(BitWord) == 4)
 125         NumBits += CountPopulation_32(Bits[i]);
 126       else if (sizeof(BitWord) == 8)
 127         NumBits += CountPopulation_64(Bits[i]);
 128       else
 129         assert(0 && "Unsupported!");
 130     return NumBits;
 131   }
 132
 133   /// find_first - Returns the index of the first set bit.
 134   int find_first() const {
 135     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i)
 136       if (Bits[i] != 0) {
 137         if (sizeof(BitWord) == 4)
 138           return i * BITWORD_SIZE + CountTrailingZeros_32(Bits[i]);
 139         else if (sizeof(BitWord) == 8)
 140           return i * BITWORD_SIZE + CountTrailingZeros_64(Bits[i]);
 141         else
 142           assert(0 && "Unsupported!");
 143       }
 144     assert(0 && "Illegal empty element");
 145     return 0; // Not reached
 146   }
 147
 148   /// find_next - Returns the index of the next set bit starting from the
 149   /// "Curr" bit. Returns -1 if the next set bit is not found.
 150   int find_next(unsigned Curr) const {
 151     if (Curr >= BITS_PER_ELEMENT)
 152       return -1;
 153
 154     unsigned WordPos = Curr / BITWORD_SIZE;
 155     unsigned BitPos = Curr % BITWORD_SIZE;
 156     BitWord Copy = Bits[WordPos];
 157     assert (WordPos <= BITWORDS_PER_ELEMENT
 158             && "Word Position outside of element");
 159
 160     // Mask off previous bits.
 161     Copy &= ~0L << BitPos;
 162
 163     if (Copy != 0) {
 164       if (sizeof(BitWord) == 4)
 165         return WordPos * BITWORD_SIZE + CountTrailingZeros_32(Copy);
 166       else if (sizeof(BitWord) == 8)
 167         return WordPos * BITWORD_SIZE + CountTrailingZeros_64(Copy);
 168       else
 169         assert(0 && "Unsupported!");
 170     }
 171
 172     // Check subsequent words.
 173     for (unsigned i = WordPos+1; i < BITWORDS_PER_ELEMENT; ++i)
 174       if (Bits[i] != 0) {
 175         if (sizeof(BitWord) == 4)
 176           return i * BITWORD_SIZE + CountTrailingZeros_32(Bits[i]);
 177         else if (sizeof(BitWord) == 8)
 178           return i * BITWORD_SIZE + CountTrailingZeros_64(Bits[i]);
 179         else
 180           assert(0 && "Unsupported!");
 181       }
 182     return -1;
 183   }
 184
 185   // Union this element with RHS and return true if this one changed.
 186   bool unionWith(const SparseBitVectorElement &RHS) {
 187     bool changed = false;
 188     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i) {
 189       BitWord old = changed ? 0 : Bits[i];
 190
 191       Bits[i] |= RHS.Bits[i];
 192       if (!changed && old != Bits[i])
 193         changed = true;
 194     }
 195     return changed;
 196   }
 197
 198   // Return true if we have any bits in common with RHS
 199   bool intersects(const SparseBitVectorElement &RHS) const {
 200     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i) {
 201       if (RHS.Bits[i] & Bits[i])
 202         return true;
 203     }
 204     return false;
 205   }
 206
 207   // Intersect this Element with RHS and return true if this one changed.
 208   // BecameZero is set to true if this element became all-zero bits.
 209   bool intersectWith(const SparseBitVectorElement &RHS,
 210                      bool &BecameZero) {
 211     bool changed = false;
 212     bool allzero = true;
 213
 214     BecameZero = false;
 215     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i) {
 216       BitWord old = changed ? 0 : Bits[i];
 217
 218       Bits[i] &= RHS.Bits[i];
 219       if (Bits[i] != 0)
 220         allzero = false;
 221
 222       if (!changed && old != Bits[i])
 223         changed = true;
 224     }
 225     BecameZero = allzero;
 226     return changed;
 227   }
 228   // Intersect this Element with the complement of RHS and return true if this
 229   // one changed.  BecameZero is set to true if this element became all-zero
 230   // bits.
 231   bool intersectWithComplement(const SparseBitVectorElement &RHS,
 232                                bool &BecameZero) {
 233     bool changed = false;
 234     bool allzero = true;
 235
 236     BecameZero = false;
 237     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i) {
 238       BitWord old = changed ? 0 : Bits[i];
 239
 240       Bits[i] &= ~RHS.Bits[i];
 241       if (Bits[i] != 0)
 242         allzero = false;
 243
 244       if (!changed && old != Bits[i])
 245         changed = true;
 246     }
 247     BecameZero = allzero;
 248     return changed;
 249   }
 250   // Three argument version of intersectWithComplement that intersects
 251   // RHS1 & ~RHS2 into this element
 252   void intersectWithComplement(const SparseBitVectorElement &RHS1,
 253                                const SparseBitVectorElement &RHS2,
 254                                bool &BecameZero) {
 255     bool allzero = true;
 256
 257     BecameZero = false;
 258     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i) {
 259       Bits[i] = RHS1.Bits[i] & ~RHS2.Bits[i];
 260       if (Bits[i] != 0)
 261         allzero = false;
 262     }
 263     BecameZero = allzero;
 264   }
 265
 266   // Get a hash value for this element;
 267   uint64_t getHashValue() const {
 268     uint64_t HashVal = 0;
 269     for (unsigned i = 0; i < BITWORDS_PER_ELEMENT; ++i) {
 270       HashVal ^= Bits[i];
 271     }
 272     return HashVal;
 273   }
 274 };
 275
 276 template <unsigned ElementSize = 128>
 277 class SparseBitVector {
 278   typedef ilist<SparseBitVectorElement<ElementSize> > ElementList;
 279   typedef typename ElementList::iterator ElementListIter;
 280   typedef typename ElementList::const_iterator ElementListConstIter;
 281   enum {
 282     BITWORD_SIZE = SparseBitVectorElement<ElementSize>::BITWORD_SIZE
 283   };
 284
 285   // Pointer to our current Element.
 286   ElementListIter CurrElementIter;
 287   ElementList Elements;
 288
 289   // This is like std::lower_bound, except we do linear searching from the
 290   // current position.
 291   ElementListIter FindLowerBound(unsigned ElementIndex) {
 292
 293     if (Elements.empty()) {
 294       CurrElementIter = Elements.begin();
 295       return Elements.begin();
 296     }
 297
 298     // Make sure our current iterator is valid.
 299     if (CurrElementIter == Elements.end())
 300       --CurrElementIter;
 301
 302     // Search from our current iterator, either backwards or forwards,
 303     // depending on what element we are looking for.
 304     ElementListIter ElementIter = CurrElementIter;
 305     if (CurrElementIter->index() == ElementIndex) {
 306       return ElementIter;
 307     } else if (CurrElementIter->index() > ElementIndex) {
 308       while (ElementIter != Elements.begin()
 309              && ElementIter->index() > ElementIndex)
 310         --ElementIter;
 311     } else {
 312       while (ElementIter != Elements.end() &&
 313              ElementIter->index() < ElementIndex)
 314         ++ElementIter;
 315     }
 316     CurrElementIter = ElementIter;
 317     return ElementIter;
 318   }
 319
 320   // Iterator to walk set bits in the bitmap.  This iterator is a lot uglier
 321   // than it would be, in order to be efficient.
 322   class SparseBitVectorIterator {
 323   private:
 324     bool AtEnd;
 325
 326     const SparseBitVector<ElementSize> *BitVector;
 327
 328     // Current element inside of bitmap.
 329     ElementListConstIter Iter;
 330
 331     // Current bit number inside of our bitmap.
 332     unsigned BitNumber;
 333
 334     // Current word number inside of our element.
 335     unsigned WordNumber;
 336
 337     // Current bits from the element.
 338     typename SparseBitVectorElement<ElementSize>::BitWord Bits;
 339
 340     // Move our iterator to the first non-zero bit in the bitmap.
 341     void AdvanceToFirstNonZero() {
 342       if (AtEnd)
 343         return;
 344       if (BitVector->Elements.empty()) {
 345         AtEnd = true;
 346         return;
 347       }
 348       Iter = BitVector->Elements.begin();
 349       BitNumber = Iter->index() * ElementSize;
 350       unsigned BitPos = Iter->find_first();
 351       BitNumber += BitPos;
 352       WordNumber = (BitNumber % ElementSize) / BITWORD_SIZE;
 353       Bits = Iter->word(WordNumber);
 354       Bits >>= BitPos % BITWORD_SIZE;
 355     }
 356
 357     // Move our iterator to the next non-zero bit.
 358     void AdvanceToNextNonZero() {
 359       if (AtEnd)
 360         return;
 361
 362       while (Bits && !(Bits & 1)) {
 363         Bits >>= 1;
 364         BitNumber += 1;
 365       }
 366
 367       // See if we ran out of Bits in this word.
 368       if (!Bits) {
 369         int NextSetBitNumber = Iter->find_next(BitNumber % ElementSize) ;
 370         // If we ran out of set bits in this element, move to next element.
 371         if (NextSetBitNumber == -1 || (BitNumber % ElementSize == 0)) {
 372           ++Iter;
 373           WordNumber = 0;
 374
 375           // We may run out of elements in the bitmap.
 376           if (Iter == BitVector->Elements.end()) {
 377             AtEnd = true;
 378             return;
 379           }
 380           // Set up for next non zero word in bitmap.
 381           BitNumber = Iter->index() * ElementSize;
 382           NextSetBitNumber = Iter->find_first();
 383           BitNumber += NextSetBitNumber;
 384           WordNumber = (BitNumber % ElementSize) / BITWORD_SIZE;
 385           Bits = Iter->word(WordNumber);
 386           Bits >>= NextSetBitNumber % BITWORD_SIZE;
 387         } else {
 388           WordNumber = (NextSetBitNumber % ElementSize) / BITWORD_SIZE;
 389           Bits = Iter->word(WordNumber);
 390           Bits >>= NextSetBitNumber % BITWORD_SIZE;
 391           BitNumber = Iter->index() * ElementSize;
 392           BitNumber += NextSetBitNumber;
 393         }
 394       }
 395     }
 396   public:
 397     // Preincrement.
 398     inline SparseBitVectorIterator& operator++() {
 399       ++BitNumber;
 400       Bits >>= 1;
 401       AdvanceToNextNonZero();
 402       return *this;
 403     }
 404
 405     // Postincrement.
 406     inline SparseBitVectorIterator operator++(int) {
 407       SparseBitVectorIterator tmp = *this;
 408       ++*this;
 409       return tmp;
 410     }
 411
 412     // Return the current set bit number.
 413     unsigned operator*() const {
 414       return BitNumber;
 415     }
 416
 417     bool operator==(const SparseBitVectorIterator &RHS) const {
 418       // If they are both at the end, ignore the rest of the fields.
 419       if (AtEnd && RHS.AtEnd)
 420         return true;
 421       // Otherwise they are the same if they have the same bit number and
 422       // bitmap.
 423       return AtEnd == RHS.AtEnd && RHS.BitNumber == BitNumber;
 424     }
 425     bool operator!=(const SparseBitVectorIterator &RHS) const {
 426       return !(*this == RHS);
 427     }
 428     SparseBitVectorIterator(): BitVector(NULL) {
 429     }
 430
 431
 432     SparseBitVectorIterator(const SparseBitVector<ElementSize> *RHS,
 433                             bool end = false):BitVector(RHS) {
 434       Iter = BitVector->Elements.begin();
 435       BitNumber = 0;
 436       Bits = 0;
 437       WordNumber = ~0;
 438       AtEnd = end;
 439       AdvanceToFirstNonZero();
 440     }
 441   };
 442 public:
 443   typedef SparseBitVectorIterator iterator;
 444
 445   SparseBitVector () {
 446     CurrElementIter = Elements.begin ();
 447   }
 448
 449   ~SparseBitVector() {
 450   }
 451
 452   // SparseBitVector copy ctor.
 453   SparseBitVector(const SparseBitVector &RHS) {
 454     ElementListConstIter ElementIter = RHS.Elements.begin();
 455     while (ElementIter != RHS.Elements.end()) {
 456       Elements.push_back(SparseBitVectorElement<ElementSize>(*ElementIter));
 457       ++ElementIter;
 458     }
 459
 460     CurrElementIter = Elements.begin ();
 461   }
 462
 463   // Clear.
 464   void clear() {
 465     Elements.clear();
 466   }
 467
 468   // Assignment
 469   SparseBitVector& operator=(const SparseBitVector& RHS) {
 470     Elements.clear();
 471
 472     ElementListConstIter ElementIter = RHS.Elements.begin();
 473     while (ElementIter != RHS.Elements.end()) {
 474       Elements.push_back(SparseBitVectorElement<ElementSize>(*ElementIter));
 475       ++ElementIter;
 476     }
 477
 478     CurrElementIter = Elements.begin ();
 479
 480     return *this;
 481   }
 482
 483   // Test, Reset, and Set a bit in the bitmap.
 484   bool test(unsigned Idx) {
 485     if (Elements.empty())
 486       return false;
 487
 488     unsigned ElementIndex = Idx / ElementSize;
 489     ElementListIter ElementIter = FindLowerBound(ElementIndex);
 490
 491     // If we can't find an element that is supposed to contain this bit, there
 492     // is nothing more to do.
 493     if (ElementIter == Elements.end() ||
 494         ElementIter->index() != ElementIndex)
 495       return false;
 496     return ElementIter->test(Idx % ElementSize);
 497   }
 498
 499   void reset(unsigned Idx) {
 500     if (Elements.empty())
 501       return;
 502
 503     unsigned ElementIndex = Idx / ElementSize;
 504     ElementListIter ElementIter = FindLowerBound(ElementIndex);
 505
 506     // If we can't find an element that is supposed to contain this bit, there
 507     // is nothing more to do.
 508     if (ElementIter == Elements.end() ||
 509         ElementIter->index() != ElementIndex)
 510       return;
 511     ElementIter->reset(Idx % ElementSize);
 512
 513     // When the element is zeroed out, delete it.
 514     if (ElementIter->empty()) {
 515       ++CurrElementIter;
 516       Elements.erase(ElementIter);
 517     }
 518   }
 519
 520   void set(unsigned Idx) {
 521     unsigned ElementIndex = Idx / ElementSize;
 522     SparseBitVectorElement<ElementSize> *Element;
 523     ElementListIter ElementIter;
 524     if (Elements.empty()) {
 525       Element = new SparseBitVectorElement<ElementSize>(ElementIndex);
 526       ElementIter = Elements.insert(Elements.end(), Element);
 527
 528     } else {
 529       ElementIter = FindLowerBound(ElementIndex);
 530
 531       if (ElementIter == Elements.end() ||
 532           ElementIter->index() != ElementIndex) {
 533         Element = new SparseBitVectorElement<ElementSize>(ElementIndex);
 534         // We may have hit the beginning of our SparseBitVector, in which case,
 535         // we may need to insert right after this element, which requires moving
 536         // the current iterator forward one, because insert does insert before.
 537         if (ElementIter != Elements.end() &&
 538             ElementIter->index() < ElementIndex)
 539           ElementIter = Elements.insert(++ElementIter, Element);
 540         else
 541           ElementIter = Elements.insert(ElementIter, Element);
 542       }
 543     }
 544     CurrElementIter = ElementIter;
 545
 546     ElementIter->set(Idx % ElementSize);
 547   }
 548
 549   bool test_and_set (unsigned Idx) {
 550     bool old = test(Idx);
 551     if (!old) {
 552       set(Idx);
 553       return true;
 554     }
 555     return false;
 556   }
 557
 558   bool operator!=(const SparseBitVector &RHS) const {
 559     return !(*this == RHS);
 560   }
 561
 562   bool operator==(const SparseBitVector &RHS) const {
 563     ElementListConstIter Iter1 = Elements.begin();
 564     ElementListConstIter Iter2 = RHS.Elements.begin();
 565
 566     for (; Iter1 != Elements.end() && Iter2 != RHS.Elements.end();
 567          ++Iter1, ++Iter2) {
 568       if (*Iter1 != *Iter2)
 569         return false;
 570     }
 571     return Iter1 == Elements.end() && Iter2 == RHS.Elements.end();
 572   }
 573
 574   // Union our bitmap with the RHS and return true if we changed.
 575   bool operator|=(const SparseBitVector &RHS) {
 576     bool changed = false;
 577     ElementListIter Iter1 = Elements.begin();
 578     ElementListConstIter Iter2 = RHS.Elements.begin();
 579
 580     // If RHS is empty, we are done
 581     if (RHS.Elements.empty())
 582       return false;
 583
 584     while (Iter2 != RHS.Elements.end()) {
 585       if (Iter1 == Elements.end() || Iter1->index() > Iter2->index()) {
 586         Elements.insert(Iter1,
 587                         new SparseBitVectorElement<ElementSize>(*Iter2));
 588         ++Iter2;
 589         changed = true;
 590       } else if (Iter1->index() == Iter2->index()) {
 591         changed |= Iter1->unionWith(*Iter2);
 592         ++Iter1;
 593         ++Iter2;
 594       } else {
 595         ++Iter1;
 596       }
 597     }
 598     CurrElementIter = Elements.begin();
 599     return changed;
 600   }
 601
 602   // Intersect our bitmap with the RHS and return true if ours changed.
 603   bool operator&=(const SparseBitVector &RHS) {
 604     bool changed = false;
 605     ElementListIter Iter1 = Elements.begin();
 606     ElementListConstIter Iter2 = RHS.Elements.begin();
 607
 608     // Check if both bitmaps are empty.
 609     if (Elements.empty() && RHS.Elements.empty())
 610       return false;
 611
 612     // Loop through, intersecting as we go, erasing elements when necessary.
 613     while (Iter2 != RHS.Elements.end()) {
 614       if (Iter1 == Elements.end()) {
 615         CurrElementIter = Elements.begin();
 616         return changed;
 617       }
 618
 619       if (Iter1->index() > Iter2->index()) {
 620         ++Iter2;
 621       } else if (Iter1->index() == Iter2->index()) {
 622         bool BecameZero;
 623         changed |= Iter1->intersectWith(*Iter2, BecameZero);
 624         if (BecameZero) {
 625           ElementListIter IterTmp = Iter1;
 626           ++Iter1;
 627           Elements.erase(IterTmp);
 628         } else {
 629           ++Iter1;
 630         }
 631         ++Iter2;
 632       } else {
 633         ElementListIter IterTmp = Iter1;
 634         ++Iter1;
 635         Elements.erase(IterTmp);
 636       }
 637     }
 638     Elements.erase(Iter1, Elements.end());
 639     CurrElementIter = Elements.begin();
 640     return changed;
 641   }
 642
 643   // Intersect our bitmap with the complement of the RHS and return true if ours
 644   // changed.
 645   bool intersectWithComplement(const SparseBitVector &RHS) {
 646     bool changed = false;
 647     ElementListIter Iter1 = Elements.begin();
 648     ElementListConstIter Iter2 = RHS.Elements.begin();
 649
 650     // If either our bitmap or RHS is empty, we are done
 651     if (Elements.empty() || RHS.Elements.empty())
 652       return false;
 653
 654     // Loop through, intersecting as we go, erasing elements when necessary.
 655     while (Iter2 != RHS.Elements.end()) {
 656       if (Iter1 == Elements.end()) {
 657         CurrElementIter = Elements.begin();
 658         return changed;
 659       }
 660
 661       if (Iter1->index() > Iter2->index()) {
 662         ++Iter2;
 663       } else if (Iter1->index() == Iter2->index()) {
 664         bool BecameZero;
 665         changed |= Iter1->intersectWithComplement(*Iter2, BecameZero);
 666         if (BecameZero) {
 667           ElementListIter IterTmp = Iter1;
 668           ++Iter1;
 669           Elements.erase(IterTmp);
 670         } else {
 671           ++Iter1;
 672         }
 673         ++Iter2;
 674       } else {
 675         ++Iter1;
 676       }
 677     }
 678     CurrElementIter = Elements.begin();
 679     return changed;
 680   }
 681
 682   bool intersectWithComplement(const SparseBitVector<ElementSize> *RHS) const {
 683     return intersectWithComplement(*RHS);
 684   }
 685
 686
 687   //  Three argument version of intersectWithComplement.  Result of RHS1 & ~RHS2
 688   //  is stored into this bitmap.
 689   void intersectWithComplement(const SparseBitVector<ElementSize> &RHS1,
 690                                const SparseBitVector<ElementSize> &RHS2)
 691   {
 692     Elements.clear();
 693     CurrElementIter = Elements.begin();
 694     ElementListConstIter Iter1 = RHS1.Elements.begin();
 695     ElementListConstIter Iter2 = RHS2.Elements.begin();
 696
 697     // If RHS1 is empty, we are done
 698     // If RHS2 is empty, we still have to copy RHS1
 699     if (RHS1.Elements.empty())
 700       return;
 701
 702     // Loop through, intersecting as we go, erasing elements when necessary.
 703     while (Iter2 != RHS2.Elements.end()) {
 704       if (Iter1 == RHS1.Elements.end())
 705         return;
 706
 707       if (Iter1->index() > Iter2->index()) {
 708         ++Iter2;
 709       } else if (Iter1->index() == Iter2->index()) {
 710         bool BecameZero = false;
 711         SparseBitVectorElement<ElementSize> *NewElement =
 712           new SparseBitVectorElement<ElementSize>(Iter1->index());
 713         NewElement->intersectWithComplement(*Iter1, *Iter2, BecameZero);
 714         if (!BecameZero) {
 715           Elements.push_back(NewElement);
 716         }
 717         else
 718           delete NewElement;
 719         ++Iter1;
 720         ++Iter2;
 721       } else {
 722         SparseBitVectorElement<ElementSize> *NewElement =
 723           new SparseBitVectorElement<ElementSize>(*Iter1);
 724         Elements.push_back(NewElement);
 725         ++Iter1;
 726       }
 727     }
 728
 729     // copy the remaining elements
 730     while (Iter1 != RHS1.Elements.end()) {
 731         SparseBitVectorElement<ElementSize> *NewElement =
 732           new SparseBitVectorElement<ElementSize>(*Iter1);
 733         Elements.push_back(NewElement);
 734         ++Iter1;
 735       }
 736
 737     return;
 738   }
 739
 740   void intersectWithComplement(const SparseBitVector<ElementSize> *RHS1,
 741                                const SparseBitVector<ElementSize> *RHS2) {
 742     intersectWithComplement(*RHS1, *RHS2);
 743   }
 744
 745   bool intersects(const SparseBitVector<ElementSize> *RHS) const {
 746     return intersects(*RHS);
 747   }
 748
 749   // Return true if we share any bits in common with RHS
 750   bool intersects(const SparseBitVector<ElementSize> &RHS) const {
 751     ElementListConstIter Iter1 = Elements.begin();
 752     ElementListConstIter Iter2 = RHS.Elements.begin();
 753
 754     // Check if both bitmaps are empty.
 755     if (Elements.empty() && RHS.Elements.empty())
 756       return false;
 757
 758     // Loop through, intersecting stopping when we hit bits in common.
 759     while (Iter2 != RHS.Elements.end()) {
 760       if (Iter1 == Elements.end())
 761         return false;
 762
 763       if (Iter1->index() > Iter2->index()) {
 764         ++Iter2;
 765       } else if (Iter1->index() == Iter2->index()) {
 766         if (Iter1->intersects(*Iter2))
 767           return true;
 768         ++Iter1;
 769         ++Iter2;
 770       } else {
 771         ++Iter1;
 772       }
 773     }
 774     return false;
 775   }
 776
 777   // Return the first set bit in the bitmap.  Return -1 if no bits are set.
 778   int find_first() const {
 779     if (Elements.empty())
 780       return -1;
 781     const SparseBitVectorElement<ElementSize> &First = *(Elements.begin());
 782     return (First.index() * ElementSize) + First.find_first();
 783   }
 784
 785   // Return true if the SparseBitVector is empty
 786   bool empty() const {
 787     return Elements.empty();
 788   }
 789
 790   unsigned count() const {
 791     unsigned BitCount = 0;
 792     for (ElementListConstIter Iter = Elements.begin();
 793          Iter != Elements.end();
 794          ++Iter)
 795       BitCount += Iter->count();
 796
 797     return BitCount;
 798   }
 799   iterator begin() const {
 800     return iterator(this);
 801   }
 802
 803   iterator end() const {
 804     return iterator(this, true);
 805   }
 806
 807   // Get a hash value for this bitmap.
 808   uint64_t getHashValue() const {
 809     uint64_t HashVal = 0;
 810     for (ElementListConstIter Iter = Elements.begin();
 811          Iter != Elements.end();
 812          ++Iter) {
 813       HashVal ^= Iter->index();
 814       HashVal ^= Iter->getHashValue();
 815     }
 816     return HashVal;
 817   }
 818 };
 819
 820 // Convenience functions to allow Or and And without dereferencing in the user
 821 // code.
 822
 823 template <unsigned ElementSize>
 824 inline bool operator |=(SparseBitVector<ElementSize> &LHS,
 825                         const SparseBitVector<ElementSize> *RHS) {
 826   return LHS |= *RHS;
 827 }
 828
 829 template <unsigned ElementSize>
 830 inline bool operator |=(SparseBitVector<ElementSize> *LHS,
 831                         const SparseBitVector<ElementSize> &RHS) {
 832   return LHS->operator|=(RHS);
 833 }
 834
 835 template <unsigned ElementSize>
 836 inline bool operator &=(SparseBitVector<ElementSize> *LHS,
 837                         const SparseBitVector<ElementSize> &RHS) {
 838   return LHS->operator&=(RHS);
 839 }
 840
 841 template <unsigned ElementSize>
 842 inline bool operator &=(SparseBitVector<ElementSize> &LHS,
 843                         const SparseBitVector<ElementSize> *RHS) {
 844   return LHS &= *RHS;
 845 }
 846
 847 // Convenience functions for infix union, intersection, difference operators.
 848
 849 template <unsigned ElementSize>
 850 inline SparseBitVector<ElementSize>
 851 operator|(const SparseBitVector<ElementSize> &LHS,
 852           const SparseBitVector<ElementSize> &RHS) {
 853   SparseBitVector<ElementSize> Result(LHS);
 854   Result |= RHS;
 855   return Result;
 856 }
 857
 858 template <unsigned ElementSize>
 859 inline SparseBitVector<ElementSize>
 860 operator&(const SparseBitVector<ElementSize> &LHS,
 861           const SparseBitVector<ElementSize> &RHS) {
 862   SparseBitVector<ElementSize> Result(LHS);
 863   Result &= RHS;
 864   return Result;
 865 }
 866
 867 template <unsigned ElementSize>
 868 inline SparseBitVector<ElementSize>
 869 operator-(const SparseBitVector<ElementSize> &LHS,
 870           const SparseBitVector<ElementSize> &RHS) {
 871   SparseBitVector<ElementSize> Result;
 872   Result.intersectWithComplement(LHS, RHS);
 873   return Result;
 874 }
 875
 876
 877 // Dump a SparseBitVector to a stream
 878 template <unsigned ElementSize>
 879 void dump(const SparseBitVector<ElementSize> &LHS, llvm::OStream &out) {
 880   out << "[ ";
 881
 882   typename SparseBitVector<ElementSize>::iterator bi;
 883   for (bi = LHS.begin(); bi != LHS.end(); ++bi) {
 884     out << *bi << " ";
 885   }
 886   out << " ]\n";
 887 }
 888 } // end namespace llvm
 889
 890 #endif