include/llvm/ADT/ImmutableSet.h

   1 //===--- ImmutableSet.h - Immutable (functional) set interface --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Ted Kremenek and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the ImutAVLTree and ImmutableSet classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_IMSET_H
  15 #define LLVM_ADT_IMSET_H
  16
  17 #include "llvm/Support/Allocator.h"
  18 #include "llvm/ADT/FoldingSet.h"
  19 #include <cassert>
  20
  21 namespace llvm {
  22
  23 //===----------------------------------------------------------------------===//
  24 // Immutable AVL-Tree Definition.
  25 //===----------------------------------------------------------------------===//
  26
  27 template <typename ImutInfo> class ImutAVLFactory;
  28
  29 template <typename ImutInfo> class ImutAVLTreeInOrderIterator;
  30
  31 template <typename ImutInfo >
  32 class ImutAVLTree : public FoldingSetNode {
  33 public:
  34   typedef typename ImutInfo::key_type_ref   key_type_ref;
  35   typedef typename ImutInfo::value_type     value_type;
  36   typedef typename ImutInfo::value_type_ref value_type_ref;
  37
  38   typedef ImutAVLFactory<ImutInfo>          Factory;
  39   friend class ImutAVLFactory<ImutInfo>;
  40
  41   typedef ImutAVLTreeInOrderIterator<ImutInfo>  iterator;
  42
  43   //===----------------------------------------------------===//
  44   // Public Interface.
  45   //===----------------------------------------------------===//
  46
  47   /// getLeft - Returns a pointer to the left subtree.  This value
  48   ///  is NULL if there is no left subtree.
  49   ImutAVLTree* getLeft() const {
  50     assert (!isMutable() && "Node is incorrectly marked mutable.");
  51
  52     return reinterpret_cast<ImutAVLTree*>(Left);
  53   }
  54
  55   /// getRight - Returns a pointer to the right subtree.  This value is
  56   ///  NULL if there is no right subtree.
  57   ImutAVLTree* getRight() const { return Right; }
  58
  59
  60   /// getHeight - Returns the height of the tree.  A tree with no subtrees
  61   ///  has a height of 1.
  62   unsigned getHeight() const { return Height; }
  63
  64   /// getValue - Returns the data value associated with the tree node.
  65   const value_type& getValue() const { return Value; }
  66
  67   /// find - Finds the subtree associated with the specified key value.
  68   ///  This method returns NULL if no matching subtree is found.
  69   ImutAVLTree* find(key_type_ref K) {
  70     ImutAVLTree *T = this;
  71
  72     while (T) {
  73       key_type_ref CurrentKey = ImutInfo::KeyOfValue(T->getValue());
  74
  75       if (ImutInfo::isEqual(K,CurrentKey))
  76         return T;
  77       else if (ImutInfo::isLess(K,CurrentKey))
  78         T = T->getLeft();
  79       else
  80         T = T->getRight();
  81     }
  82
  83     return NULL;
  84   }
  85
  86   /// size - Returns the number of nodes in the tree, which includes
  87   ///  both leaves and non-leaf nodes.
  88   unsigned size() const {
  89     unsigned n = 1;
  90
  91     if (const ImutAVLTree* L = getLeft())  n += L->size();
  92     if (const ImutAVLTree* R = getRight()) n += R->size();
  93
  94     return n;
  95   }
  96
  97   /// begin - Returns an iterator that iterates over the nodes of the tree
  98   ///  in an inorder traversal.  The returned iterator thus refers to the
  99   ///  the tree node with the minimum data element.
 100   iterator begin() const { return iterator(this); }
 101
 102   /// end - Returns an iterator for the tree that denotes the end of an
 103   ///  inorder traversal.
 104   iterator end() const { return iterator(); }
 105
 106   /// isEqual - Compares two trees for structural equality and returns true
 107   ///   if they are equal.  This worst case performance of this operation is
 108   //    linear in the sizes of the trees.
 109   bool isEqual(const ImutAVLTree& RHS) const {
 110     if (&RHS == this)
 111       return true;
 112
 113     iterator LItr = begin(), LEnd = end();
 114     iterator RItr = RHS.begin(), REnd = RHS.end();
 115
 116     while (LItr != LEnd && RItr != REnd) {
 117       if (*LItr == *RItr) {
 118         LItr.SkipSubTree();
 119         RItr.SkipSubTree();
 120         continue;
 121       }
 122
 123       // FIXME: need to compare data values, not key values, but our
 124       // traits don't support this yet.
 125       if (!ImutInfo::isEqual(ImutInfo::KeyOfValue(LItr->getValue()),
 126                              ImutInfo::KeyOfValue(RItr->getValue())))
 127         return false;
 128
 129       ++LItr;
 130       ++RItr;
 131     }
 132
 133     return LItr == LEnd && RItr == REnd;
 134   }
 135
 136   /// isNotEqual - Compares two trees for structural inequality.  Performance
 137   ///  is the same is isEqual.
 138   bool isNotEqual(const ImutAVLTree& RHS) const { return !isEqual(RHS); }
 139
 140   /// contains - Returns true if this tree contains a subtree (node) that
 141   ///  has an data element that matches the specified key.  Complexity
 142   ///  is logarithmic in the size of the tree.
 143   bool contains(const key_type_ref K) { return (bool) find(K); }
 144
 145   /// foreach - A member template the accepts invokes operator() on a functor
 146   ///  object (specifed by Callback) for every node/subtree in the tree.
 147   ///  Nodes are visited using an inorder traversal.
 148   template <typename Callback>
 149   void foreach(Callback& C) {
 150     if (ImutAVLTree* L = getLeft()) L->foreach(C);
 151
 152     C(Value);
 153
 154     if (ImutAVLTree* R = getRight()) R->foreach(C);
 155   }
 156
 157   /// verify - A utility method that checks that the balancing and
 158   ///  ordering invariants of the tree are satisifed.  It is a recursive
 159   ///  method that returns the height of the tree, which is then consumed
 160   ///  by the enclosing verify call.  External callers should ignore the
 161   ///  return value.  An invalid tree will cause an assertion to fire in
 162   ///  a debug build.
 163   unsigned verify() const {
 164     unsigned HL = getLeft() ? getLeft()->verify() : 0;
 165     unsigned HR = getRight() ? getRight()->verify() : 0;
 166
 167     assert (getHeight() == ( HL > HR ? HL : HR ) + 1
 168             && "Height calculation wrong.");
 169
 170     assert ((HL > HR ? HL-HR : HR-HL) <= 2
 171             && "Balancing invariant violated.");
 172
 173
 174     assert (!getLeft()
 175             || ImutInfo::isLess(ImutInfo::KeyOfValue(getLeft()->getValue()),
 176                                 ImutInfo::KeyOfValue(getValue()))
 177             && "Value in left child is not less that current value.");
 178
 179
 180     assert (!getRight()
 181             || ImutInfo::isLess(ImutInfo::KeyOfValue(getValue()),
 182                                 ImutInfo::KeyOfValue(getRight()->getValue()))
 183             && "Current value is not less that value of right child.");
 184
 185     return getHeight();
 186   }
 187
 188   //===----------------------------------------------------===//
 189   // Internal Values.
 190   //===----------------------------------------------------===//
 191
 192 private:
 193   uintptr_t        Left;
 194   ImutAVLTree*     Right;
 195   unsigned         Height;
 196   value_type       Value;
 197
 198   //===----------------------------------------------------===//
 199   // Profiling or FoldingSet.
 200   //===----------------------------------------------------===//
 201
 202   static inline
 203   void Profile(FoldingSetNodeID& ID, ImutAVLTree* L, ImutAVLTree* R,
 204                value_type_ref V) {
 205     ID.AddPointer(L);
 206     ID.AddPointer(R);
 207     ImutInfo::Profile(ID,V);
 208   }
 209
 210 public:
 211
 212   void Profile(FoldingSetNodeID& ID) {
 213     Profile(ID,getSafeLeft(),getRight(),getValue());
 214   }
 215
 216   //===----------------------------------------------------===//
 217   // Internal methods (node manipulation; used by Factory).
 218   //===----------------------------------------------------===//
 219
 220 private:
 221
 222   ImutAVLTree(ImutAVLTree* l, ImutAVLTree* r, value_type_ref v, unsigned height)
 223   : Left(reinterpret_cast<uintptr_t>(l) | 0x1),
 224   Right(r), Height(height), Value(v) {}
 225
 226   bool isMutable() const { return Left & 0x1; }
 227
 228   ImutAVLTree* getSafeLeft() const {
 229     return reinterpret_cast<ImutAVLTree*>(Left & ~0x1);
 230   }
 231
 232   // Mutating operations.  A tree root can be manipulated as long as
 233   // its reference has not "escaped" from internal methods of a
 234   // factory object (see below).  When a tree pointer is externally
 235   // viewable by client code, the internal "mutable bit" is cleared
 236   // to mark the tree immutable.  Note that a tree that still has
 237   // its mutable bit set may have children (subtrees) that are themselves
 238   // immutable.
 239
 240   void RemoveMutableFlag() {
 241     assert (Left & 0x1 && "Mutable flag already removed.");
 242     Left &= ~0x1;
 243   }
 244
 245   void setLeft(ImutAVLTree* NewLeft) {
 246     assert (isMutable());
 247     Left = reinterpret_cast<uintptr_t>(NewLeft) | 0x1;
 248   }
 249
 250   void setRight(ImutAVLTree* NewRight) {
 251     assert (isMutable());
 252     Right = NewRight;
 253   }
 254
 255   void setHeight(unsigned h) {
 256     assert (isMutable());
 257     Height = h;
 258   }
 259 };
 260
 261 //===----------------------------------------------------------------------===//
 262 // Immutable AVL-Tree Factory class.
 263 //===----------------------------------------------------------------------===//
 264
 265 template <typename ImutInfo >
 266 class ImutAVLFactory {
 267   typedef ImutAVLTree<ImutInfo> TreeTy;
 268   typedef typename TreeTy::value_type_ref value_type_ref;
 269   typedef typename TreeTy::key_type_ref   key_type_ref;
 270
 271   typedef FoldingSet<TreeTy> CacheTy;
 272
 273   CacheTy Cache;
 274   BumpPtrAllocator Allocator;
 275
 276   //===--------------------------------------------------===//
 277   // Public interface.
 278   //===--------------------------------------------------===//
 279
 280 public:
 281   ImutAVLFactory() {}
 282
 283   TreeTy* Add(TreeTy* T, value_type_ref V) {
 284     T = Add_internal(V,T);
 285     MarkImmutable(T);
 286     return T;
 287   }
 288
 289   TreeTy* Remove(TreeTy* T, key_type_ref V) {
 290     T = Remove_internal(V,T);
 291     MarkImmutable(T);
 292     return T;
 293   }
 294
 295   TreeTy* GetEmptyTree() const { return NULL; }
 296
 297   BumpPtrAllocator& getAllocator() { return Allocator; }
 298
 299   //===--------------------------------------------------===//
 300   // A bunch of quick helper functions used for reasoning
 301   // about the properties of trees and their children.
 302   // These have succinct names so that the balancing code
 303   // is as terse (and readable) as possible.
 304   //===--------------------------------------------------===//
 305 private:
 306
 307   bool           isEmpty(TreeTy* T) const { return !T; }
 308   unsigned        Height(TreeTy* T) const { return T ? T->getHeight() : 0; }
 309   TreeTy*           Left(TreeTy* T) const { return T->getSafeLeft(); }
 310   TreeTy*          Right(TreeTy* T) const { return T->getRight(); }
 311   value_type_ref   Value(TreeTy* T) const { return T->Value; }
 312
 313   unsigned IncrementHeight(TreeTy* L, TreeTy* R) const {
 314     unsigned hl = Height(L);
 315     unsigned hr = Height(R);
 316     return ( hl > hr ? hl : hr ) + 1;
 317   }
 318
 319   //===--------------------------------------------------===//
 320   // "CreateNode" is used to generate new tree roots that link
 321   // to other trees.  The functon may also simply move links
 322   // in an existing root if that root is still marked mutable.
 323   // This is necessary because otherwise our balancing code
 324   // would leak memory as it would create nodes that are
 325   // then discarded later before the finished tree is
 326   // returned to the caller.
 327   //===--------------------------------------------------===//
 328
 329   TreeTy* CreateNode(TreeTy* L, value_type_ref V, TreeTy* R) {
 330     FoldingSetNodeID ID;
 331     TreeTy::Profile(ID,L,R,V);
 332     void* InsertPos;
 333
 334     if (TreeTy* T = Cache.FindNodeOrInsertPos(ID,InsertPos))
 335       return T;
 336
 337     assert (InsertPos != NULL);
 338
 339     // FIXME: more intelligent calculation of alignment.
 340     TreeTy* T = (TreeTy*) Allocator.Allocate(sizeof(*T),16);
 341
 342     new (T) TreeTy(L,R,V,IncrementHeight(L,R));
 343
 344     Cache.InsertNode(T,InsertPos);
 345     return T;
 346   }
 347
 348   TreeTy* CreateNode(TreeTy* L, TreeTy* OldTree, TreeTy* R) {
 349     assert (!isEmpty(OldTree));
 350
 351     if (OldTree->isMutable()) {
 352       OldTree->setLeft(L);
 353       OldTree->setRight(R);
 354       OldTree->setHeight(IncrementHeight(L,R));
 355       return OldTree;
 356     }
 357     else return CreateNode(L, Value(OldTree), R);
 358   }
 359
 360   /// Balance - Used by Add_internal and Remove_internal to
 361   ///  balance a newly created tree.
 362   TreeTy* Balance(TreeTy* L, value_type_ref V, TreeTy* R) {
 363
 364     unsigned hl = Height(L);
 365     unsigned hr = Height(R);
 366
 367     if (hl > hr + 2) {
 368       assert (!isEmpty(L) &&
 369               "Left tree cannot be empty to have a height >= 2.");
 370
 371       TreeTy* LL = Left(L);
 372       TreeTy* LR = Right(L);
 373
 374       if (Height(LL) >= Height(LR))
 375         return CreateNode(LL, L, CreateNode(LR,V,R));
 376
 377       assert (!isEmpty(LR) &&
 378               "LR cannot be empty because it has a height >= 1.");
 379
 380       TreeTy* LRL = Left(LR);
 381       TreeTy* LRR = Right(LR);
 382
 383       return CreateNode(CreateNode(LL,L,LRL), LR, CreateNode(LRR,V,R));
 384     }
 385     else if (hr > hl + 2) {
 386       assert (!isEmpty(R) &&
 387               "Right tree cannot be empty to have a height >= 2.");
 388
 389       TreeTy* RL = Left(R);
 390       TreeTy* RR = Right(R);
 391
 392       if (Height(RR) >= Height(RL))
 393         return CreateNode(CreateNode(L,V,RL), R, RR);
 394
 395       assert (!isEmpty(RL) &&
 396               "RL cannot be empty because it has a height >= 1.");
 397
 398       TreeTy* RLL = Left(RL);
 399       TreeTy* RLR = Right(RL);
 400
 401       return CreateNode(CreateNode(L,V,RLL), RL, CreateNode(RLR,R,RR));
 402     }
 403     else
 404       return CreateNode(L,V,R);
 405   }
 406
 407   /// Add_internal - Creates a new tree that includes the specified
 408   ///  data and the data from the original tree.  If the original tree
 409   ///  already contained the data item, the original tree is returned.
 410   TreeTy* Add_internal(value_type_ref V, TreeTy* T) {
 411     if (isEmpty(T))
 412       return CreateNode(T, V, T);
 413
 414     assert (!T->isMutable());
 415
 416     key_type_ref K = ImutInfo::KeyOfValue(V);
 417     key_type_ref KCurrent = ImutInfo::KeyOfValue(Value(T));
 418
 419     if (ImutInfo::isEqual(K,KCurrent))
 420       return CreateNode(Left(T), V, Right(T));
 421     else if (ImutInfo::isLess(K,KCurrent))
 422       return Balance(Add_internal(V,Left(T)), Value(T), Right(T));
 423     else
 424       return Balance(Left(T), Value(T), Add_internal(V,Right(T)));
 425   }
 426
 427   /// Remove_interal - Creates a new tree that includes all the data
 428   ///  from the original tree except the specified data.  If the
 429   ///  specified data did not exist in the original tree, the original
 430   ///  tree is returned.
 431   TreeTy* Remove_internal(key_type_ref K, TreeTy* T) {
 432     if (isEmpty(T))
 433       return T;
 434
 435     assert (!T->isMutable());
 436
 437     key_type_ref KCurrent = ImutInfo::KeyOfValue(Value(T));
 438
 439     if (ImutInfo::isEqual(K,KCurrent))
 440       return CombineLeftRightTrees(Left(T),Right(T));
 441     else if (ImutInfo::isLess(K,KCurrent))
 442       return Balance(Remove_internal(K,Left(T)), Value(T), Right(T));
 443     else
 444       return Balance(Left(T), Value(T), Remove_internal(K,Right(T)));
 445   }
 446
 447   TreeTy* CombineLeftRightTrees(TreeTy* L, TreeTy* R) {
 448     if (isEmpty(L)) return R;
 449     if (isEmpty(R)) return L;
 450
 451     TreeTy* OldNode;
 452     TreeTy* NewRight = RemoveMinBinding(R,OldNode);
 453     return Balance(L,Value(OldNode),NewRight);
 454   }
 455
 456   TreeTy* RemoveMinBinding(TreeTy* T, TreeTy*& NodeRemoved) {
 457     assert (!isEmpty(T));
 458
 459     if (isEmpty(Left(T))) {
 460       NodeRemoved = T;
 461       return Right(T);
 462     }
 463
 464     return Balance(RemoveMinBinding(Left(T),NodeRemoved),Value(T),Right(T));
 465   }
 466
 467   /// MarkImmutable - Clears the mutable bits of a root and all of its
 468   ///  descendants.
 469   void MarkImmutable(TreeTy* T) {
 470     if (!T || !T->isMutable())
 471       return;
 472
 473     T->RemoveMutableFlag();
 474     MarkImmutable(Left(T));
 475     MarkImmutable(Right(T));
 476   }
 477 };
 478
 479
 480 //===----------------------------------------------------------------------===//
 481 // Immutable AVL-Tree Iterators.
 482 //===----------------------------------------------------------------------===//
 483
 484 template <typename ImutInfo>
 485 class ImutAVLTreeGenericIterator {
 486   SmallVector<uintptr_t,20> stack;
 487 public:
 488   enum VisitFlag { VisitedNone=0x0, VisitedLeft=0x1, VisitedRight=0x3,
 489                    Flags=0x3 };
 490
 491   typedef ImutAVLTree<ImutInfo> TreeTy;
 492   typedef ImutAVLTreeGenericIterator<ImutInfo> _Self;
 493
 494   inline ImutAVLTreeGenericIterator() {}
 495   inline ImutAVLTreeGenericIterator(const TreeTy* Root) {
 496     if (Root) stack.push_back(reinterpret_cast<uintptr_t>(Root));
 497   }
 498
 499   TreeTy* operator*() const {
 500     assert (!stack.empty());
 501     return reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 502   }
 503
 504   uintptr_t getVisitState() {
 505     assert (!stack.empty());
 506     return stack.back() & Flags;
 507   }
 508
 509
 510   bool AtEnd() const { return stack.empty(); }
 511
 512   bool AtBeginning() const {
 513     return stack.size() == 1 && getVisitState() == VisitedNone;
 514   }
 515
 516   void SkipToParent() {
 517     assert (!stack.empty());
 518     stack.pop_back();
 519
 520     if (stack.empty())
 521       return;
 522
 523     switch (getVisitState()) {
 524       case VisitedNone:
 525         stack.back() |= VisitedLeft;
 526         break;
 527       case VisitedLeft:
 528         stack.back() |= VisitedRight;
 529         break;
 530       default:
 531         assert (false && "Unreachable.");
 532     }
 533   }
 534
 535   inline bool operator==(const _Self& x) const {
 536     if (stack.size() != x.stack.size())
 537       return false;
 538
 539     for (unsigned i = 0 ; i < stack.size(); i++)
 540       if (stack[i] != x.stack[i])
 541         return false;
 542
 543     return true;
 544   }
 545
 546   inline bool operator!=(const _Self& x) const { return !operator==(x); }
 547
 548   _Self& operator++() {
 549     assert (!stack.empty());
 550
 551     TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 552     assert (Current);
 553
 554     switch (getVisitState()) {
 555       case VisitedNone:
 556         if (TreeTy* L = Current->getLeft())
 557           stack.push_back(reinterpret_cast<uintptr_t>(L));
 558         else
 559           stack.back() |= VisitedLeft;
 560
 561         break;
 562
 563       case VisitedLeft:
 564         if (TreeTy* R = Current->getRight())
 565           stack.push_back(reinterpret_cast<uintptr_t>(R));
 566         else
 567           stack.back() |= VisitedRight;
 568
 569         break;
 570
 571       case VisitedRight:
 572         SkipToParent();
 573         break;
 574
 575       default:
 576         assert (false && "Unreachable.");
 577     }
 578
 579     return *this;
 580   }
 581
 582   _Self& operator--() {
 583     assert (!stack.empty());
 584
 585     TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 586     assert (Current);
 587
 588     switch (getVisitState()) {
 589       case VisitedNone:
 590         stack.pop_back();
 591         break;
 592
 593       case VisitedLeft:
 594         stack.back() &= ~Flags; // Set state to "VisitedNone."
 595
 596         if (TreeTy* L = Current->getLeft())
 597           stack.push_back(reinterpret_cast<uintptr_t>(L) | VisitedRight);
 598
 599         break;
 600
 601       case VisitedRight:
 602         stack.back() &= ~Flags;
 603         stack.back() |= VisitedLeft;
 604
 605         if (TreeTy* R = Current->getRight())
 606           stack.push_back(reinterpret_cast<uintptr_t>(R) | VisitedRight);
 607
 608         break;
 609
 610       default:
 611         assert (false && "Unreachable.");
 612     }
 613
 614     return *this;
 615   }
 616 };
 617
 618 template <typename ImutInfo>
 619 class ImutAVLTreeInOrderIterator {
 620   typedef ImutAVLTreeGenericIterator<ImutInfo> InternalIteratorTy;
 621   InternalIteratorTy InternalItr;
 622
 623 public:
 624   typedef ImutAVLTree<ImutInfo> TreeTy;
 625   typedef ImutAVLTreeInOrderIterator<ImutInfo> _Self;
 626
 627   ImutAVLTreeInOrderIterator(const TreeTy* Root) : InternalItr(Root) {
 628     if (Root) operator++(); // Advance to first element.
 629   }
 630
 631   ImutAVLTreeInOrderIterator() : InternalItr() {}
 632
 633   inline bool operator==(const _Self& x) const {
 634     return InternalItr == x.InternalItr;
 635   }
 636
 637   inline bool operator!=(const _Self& x) const { return !operator==(x); }
 638
 639   inline TreeTy* operator*() const { return *InternalItr; }
 640   inline TreeTy* operator->() const { return *InternalItr; }
 641
 642   inline _Self& operator++() {
 643     do ++InternalItr;
 644     while (!InternalItr.AtEnd() &&
 645            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
 646
 647     return *this;
 648   }
 649
 650   inline _Self& operator--() {
 651     do --InternalItr;
 652     while (!InternalItr.AtBeginning() &&
 653            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
 654
 655     return *this;
 656   }
 657
 658   inline void SkipSubTree() {
 659     InternalItr.SkipToParent();
 660
 661     while (!InternalItr.AtEnd() &&
 662            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft)
 663       ++InternalItr;
 664   }
 665 };
 666
 667 //===----------------------------------------------------------------------===//
 668 // Trait classes for Profile information.
 669 //===----------------------------------------------------------------------===//
 670
 671 /// Generic profile template.  The default behavior is to invoke the
 672 /// profile method of an object.  Specializations for primitive integers
 673 /// and generic handling of pointers is done below.
 674 template <typename T>
 675 struct ImutProfileInfo {
 676   typedef const T  value_type;
 677   typedef const T& value_type_ref;
 678
 679   static inline void Profile(FoldingSetNodeID& ID, value_type_ref X) {
 680     X.Profile(ID);
 681   }
 682 };
 683
 684 /// Profile traits for integers.
 685 template <typename T>
 686 struct ImutProfileInteger {
 687   typedef const T  value_type;
 688   typedef const T& value_type_ref;
 689
 690   static inline void Profile(FoldingSetNodeID& ID, value_type_ref X) {
 691     ID.AddInteger(X);
 692   }
 693 };
 694
 695 #define PROFILE_INTEGER_INFO(X)\
 696 template<> struct ImutProfileInfo<X> : ImutProfileInteger<X> {};
 697
 698 PROFILE_INTEGER_INFO(char)
 699 PROFILE_INTEGER_INFO(unsigned char)
 700 PROFILE_INTEGER_INFO(short)
 701 PROFILE_INTEGER_INFO(unsigned short)
 702 PROFILE_INTEGER_INFO(unsigned)
 703 PROFILE_INTEGER_INFO(signed)
 704 PROFILE_INTEGER_INFO(long)
 705 PROFILE_INTEGER_INFO(unsigned long)
 706 PROFILE_INTEGER_INFO(long long)
 707 PROFILE_INTEGER_INFO(unsigned long long)
 708
 709 #undef PROFILE_INTEGER_INFO
 710
 711 /// Generic profile trait for pointer types.  We treat pointers as
 712 /// references to unique objects.
 713 template <typename T>
 714 struct ImutProfileInfo<T*> {
 715   typedef const T*   value_type;
 716   typedef value_type value_type_ref;
 717
 718   static inline void Profile(FoldingSetNodeID &ID, value_type_ref X) {
 719     ID.AddPointer(X);
 720   }
 721 };
 722
 723 //===----------------------------------------------------------------------===//
 724 // Trait classes that contain element comparison operators and type
 725 //  definitions used by ImutAVLTree, ImmutableSet, and ImmutableMap.  These
 726 //  inherit from the profile traits (ImutProfileInfo) to include operations
 727 //  for element profiling.
 728 //===----------------------------------------------------------------------===//
 729
 730
 731 /// ImutContainerInfo - Generic definition of comparison operations for
 732 ///   elements of immutable containers that defaults to using
 733 ///   std::equal_to<> and std::less<> to perform comparison of elements.
 734 template <typename T>
 735 struct ImutContainerInfo : public ImutProfileInfo<T> {
 736   typedef typename ImutProfileInfo<T>::value_type      value_type;
 737   typedef typename ImutProfileInfo<T>::value_type_ref  value_type_ref;
 738   typedef value_type      key_type;
 739   typedef value_type_ref  key_type_ref;
 740
 741   static inline key_type_ref KeyOfValue(value_type_ref D) { return D; }
 742
 743   static inline bool isEqual(key_type_ref LHS, key_type_ref RHS) {
 744     return std::equal_to<key_type>()(LHS,RHS);
 745   }
 746
 747   static inline bool isLess(key_type_ref LHS, key_type_ref RHS) {
 748     return std::less<key_type>()(LHS,RHS);
 749   }
 750 };
 751
 752 /// ImutContainerInfo - Specialization for pointer values to treat pointers
 753 ///  as references to unique objects.  Pointers are thus compared by
 754 ///  their addresses.
 755 template <typename T>
 756 struct ImutContainerInfo<T*> : public ImutProfileInfo<T*> {
 757   typedef typename ImutProfileInfo<T*>::value_type      value_type;
 758   typedef typename ImutProfileInfo<T*>::value_type_ref  value_type_ref;
 759   typedef value_type      key_type;
 760   typedef value_type_ref  key_type_ref;
 761
 762   static inline key_type_ref KeyOfValue(value_type_ref D) { return D; }
 763
 764   static inline bool isEqual(key_type_ref LHS, key_type_ref RHS) {
 765     return LHS == RHS;
 766   }
 767
 768   static inline bool isLess(key_type_ref LHS, key_type_ref RHS) {
 769     return LHS < RHS;
 770   }
 771 };
 772
 773 //===----------------------------------------------------------------------===//
 774 // Immutable Set
 775 //===----------------------------------------------------------------------===//
 776
 777 template <typename ValT, typename ValInfo = ImutContainerInfo<ValT> >
 778 class ImmutableSet {
 779 public:
 780   typedef typename ValInfo::value_type      value_type;
 781   typedef typename ValInfo::value_type_ref  value_type_ref;
 782
 783 private:
 784   typedef ImutAVLTree<ValInfo> TreeTy;
 785   TreeTy* Root;
 786
 787   ImmutableSet(TreeTy* R) : Root(R) {}
 788
 789 public:
 790
 791   class Factory {
 792     typename TreeTy::Factory F;
 793
 794   public:
 795     Factory() {}
 796
 797     /// GetEmptySet - Returns an immutable set that contains no elements.
 798     ImmutableSet GetEmptySet() { return ImmutableSet(F.GetEmptyTree()); }
 799
 800     /// Add - Creates a new immutable set that contains all of the values
 801     ///  of the original set with the addition of the specified value.  If
 802     ///  the original set already included the value, then the original set is
 803     ///  returned and no memory is allocated.  The time and space complexity
 804     ///  of this operation is logarithmic in the size of the original set.
 805     ///  The memory allocated to represent the set is released when the
 806     ///  factory object that created the set is destroyed.
 807     ImmutableSet Add(ImmutableSet Old, value_type_ref V) {
 808       return ImmutableSet(F.Add(Old.Root,V));
 809     }
 810
 811     /// Remove - Creates a new immutable set that contains all of the values
 812     ///  of the original set with the exception of the specified value.  If
 813     ///  the original set did not contain the value, the original set is
 814     ///  returned and no memory is allocated.  The time and space complexity
 815     ///  of this operation is logarithmic in the size of the original set.
 816     ///  The memory allocated to represent the set is released when the
 817     ///  factory object that created the set is destroyed.
 818     ImmutableSet Remove(ImmutableSet Old, value_type_ref V) {
 819       return ImmutableSet(F.Remove(Old.Root,V));
 820     }
 821
 822     BumpPtrAllocator& getAllocator() { return F.getAllocator(); }
 823
 824   private:
 825     Factory(const Factory& RHS) {};
 826     void operator=(const Factory& RHS) {};
 827   };
 828
 829   friend class Factory;
 830
 831   /// contains - Returns true if the set contains the specified value.
 832   bool contains(const value_type_ref V) const {
 833     return Root ? Root->contains(V) : false;
 834   }
 835
 836   bool operator==(ImmutableSet RHS) const {
 837     return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
 838   }
 839
 840   bool operator!=(ImmutableSet RHS) const {
 841     return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
 842   }
 843
 844   /// isEmpty - Return true if the set contains no elements.
 845   bool isEmpty() const { return !Root; }
 846
 847   template <typename Callback>
 848   void foreach(Callback& C) { if (Root) Root->foreach(C); }
 849
 850   template <typename Callback>
 851   void foreach() { if (Root) { Callback C; Root->foreach(C); } }
 852
 853   //===--------------------------------------------------===//
 854   // Iterators.
 855   //===--------------------------------------------------===//
 856
 857   class iterator {
 858     typename TreeTy::iterator itr;
 859
 860     iterator() {}
 861     iterator(TreeTy* t) : itr(t) {}
 862     friend class ImmutableSet<ValT,ValInfo>;
 863   public:
 864     inline value_type_ref operator*() const { return itr->getValue(); }
 865     inline iterator& operator++() { ++itr; return *this; }
 866     inline iterator  operator++(int) { iterator tmp(*this); ++itr; return tmp; }
 867     inline iterator& operator--() { --itr; return *this; }
 868     inline iterator  operator--(int) { iterator tmp(*this); --itr; return tmp; }
 869     inline bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
 870     inline bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
 871   };
 872
 873   iterator begin() const { return iterator(Root); }
 874   iterator end() const { return iterator(); }
 875
 876   //===--------------------------------------------------===//
 877   // For testing.
 878   //===--------------------------------------------------===//
 879
 880   void verify() const { if (Root) Root->verify(); }
 881   unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
 882 };
 883
 884 } // end namespace llvm
 885
 886 #endif