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 private:
 203
 204   /// Profile - Generates a FoldingSet profile for a tree node before it is
 205   ///   created.  This is used by the ImutAVLFactory when creating
 206   ///   trees.
 207   static inline
 208   void Profile(FoldingSetNodeID& ID, ImutAVLTree* L, ImutAVLTree* R,
 209                value_type_ref V) {
 210     ID.AddPointer(L);
 211     ID.AddPointer(R);
 212     ImutInfo::Profile(ID,V);
 213   }
 214
 215 public:
 216
 217   /// Profile - Generates a FoldingSet profile for an existing tree node.
 218   void Profile(FoldingSetNodeID& ID) {
 219     Profile(ID,getSafeLeft(),getRight(),getValue());
 220   }
 221
 222   //===----------------------------------------------------===//
 223   // Internal methods (node manipulation; used by Factory).
 224   //===----------------------------------------------------===//
 225
 226 private:
 227
 228   enum { Mutable = 0x1 };
 229
 230   /// ImutAVLTree - Internal constructor that is only called by
 231   ///   ImutAVLFactory.
 232   ImutAVLTree(ImutAVLTree* l, ImutAVLTree* r, value_type_ref v, unsigned height)
 233   : Left(reinterpret_cast<uintptr_t>(l) | Mutable),
 234   Right(r), Height(height), Value(v) {}
 235
 236
 237   /// isMutable - Returns true if the left and right subtree references
 238   ///  (as well as height) can be changed.  If this method returns false,
 239   ///  the tree is truly immutable.  Trees returned from an ImutAVLFactory
 240   ///  object should always have this method return true.  Further, if this
 241   ///  method returns false for an instance of ImutAVLTree, all subtrees
 242   ///  will also have this method return false.  The converse is not true.
 243   bool isMutable() const { return Left & Mutable; }
 244
 245   /// getSafeLeft - Returns the pointer to the left tree by always masking
 246   ///  out the mutable bit.  This is used internally by ImutAVLFactory,
 247   ///  as no trees returned to the client should have the mutable flag set.
 248   ImutAVLTree* getSafeLeft() const {
 249     return reinterpret_cast<ImutAVLTree*>(Left & ~Mutable);
 250   }
 251
 252   //===----------------------------------------------------===//
 253   // Mutating operations.  A tree root can be manipulated as
 254   // long as its reference has not "escaped" from internal
 255   // methods of a factory object (see below).  When a tree
 256   // pointer is externally viewable by client code, the
 257   // internal "mutable bit" is cleared to mark the tree
 258   // immutable.  Note that a tree that still has its mutable
 259   // bit set may have children (subtrees) that are themselves
 260   // immutable.
 261   //===----------------------------------------------------===//
 262
 263
 264   /// MarkImmutable - Clears the mutable flag for a tree.  After this happens,
 265   ///   it is an error to call setLeft(), setRight(), and setHeight().  It
 266   ///   is also then safe to call getLeft() instead of getSafeLeft().
 267   void MarkMutable() {
 268     assert (isMutable() && "Mutable flag already removed.");
 269     Left &= ~Mutable;
 270   }
 271
 272   /// setLeft - Changes the reference of the left subtree.  Used internally
 273   ///   by ImutAVLFactory.
 274   void setLeft(ImutAVLTree* NewLeft) {
 275     assert (isMutable() &&
 276             "Only a mutable tree can have its left subtree changed.");
 277
 278     Left = reinterpret_cast<uintptr_t>(NewLeft) | Mutable;
 279   }
 280
 281   /// setRight - Changes the reference of the right subtree.  Used internally
 282   ///  by ImutAVLFactory.
 283   void setRight(ImutAVLTree* NewRight) {
 284     assert (isMutable() &&
 285             "Only a mutable tree can have its right subtree changed.");
 286
 287     Right = NewRight;
 288   }
 289
 290   /// setHeight - Changes the height of the tree.  Used internally by
 291   ///  ImutAVLFactory.
 292   void setHeight(unsigned h) {
 293     assert (isMutable() && "Only a mutable tree can have its height changed.");
 294     Height = h;
 295   }
 296 };
 297
 298 //===----------------------------------------------------------------------===//
 299 // Immutable AVL-Tree Factory class.
 300 //===----------------------------------------------------------------------===//
 301
 302 template <typename ImutInfo >
 303 class ImutAVLFactory {
 304   typedef ImutAVLTree<ImutInfo> TreeTy;
 305   typedef typename TreeTy::value_type_ref value_type_ref;
 306   typedef typename TreeTy::key_type_ref   key_type_ref;
 307
 308   typedef FoldingSet<TreeTy> CacheTy;
 309
 310   CacheTy Cache;
 311   BumpPtrAllocator Allocator;
 312
 313   //===--------------------------------------------------===//
 314   // Public interface.
 315   //===--------------------------------------------------===//
 316
 317 public:
 318   ImutAVLFactory() {}
 319
 320   TreeTy* Add(TreeTy* T, value_type_ref V) {
 321     T = Add_internal(V,T);
 322     MarkImmutable(T);
 323     return T;
 324   }
 325
 326   TreeTy* Remove(TreeTy* T, key_type_ref V) {
 327     T = Remove_internal(V,T);
 328     MarkImmutable(T);
 329     return T;
 330   }
 331
 332   TreeTy* GetEmptyTree() const { return NULL; }
 333
 334   BumpPtrAllocator& getAllocator() { return Allocator; }
 335
 336   //===--------------------------------------------------===//
 337   // A bunch of quick helper functions used for reasoning
 338   // about the properties of trees and their children.
 339   // These have succinct names so that the balancing code
 340   // is as terse (and readable) as possible.
 341   //===--------------------------------------------------===//
 342 private:
 343
 344   bool           isEmpty(TreeTy* T) const { return !T; }
 345   unsigned        Height(TreeTy* T) const { return T ? T->getHeight() : 0; }
 346   TreeTy*           Left(TreeTy* T) const { return T->getSafeLeft(); }
 347   TreeTy*          Right(TreeTy* T) const { return T->getRight(); }
 348   value_type_ref   Value(TreeTy* T) const { return T->Value; }
 349
 350   unsigned IncrementHeight(TreeTy* L, TreeTy* R) const {
 351     unsigned hl = Height(L);
 352     unsigned hr = Height(R);
 353     return ( hl > hr ? hl : hr ) + 1;
 354   }
 355
 356   //===--------------------------------------------------===//
 357   // "CreateNode" is used to generate new tree roots that link
 358   // to other trees.  The functon may also simply move links
 359   // in an existing root if that root is still marked mutable.
 360   // This is necessary because otherwise our balancing code
 361   // would leak memory as it would create nodes that are
 362   // then discarded later before the finished tree is
 363   // returned to the caller.
 364   //===--------------------------------------------------===//
 365
 366   TreeTy* CreateNode(TreeTy* L, value_type_ref V, TreeTy* R) {
 367     FoldingSetNodeID ID;
 368     TreeTy::Profile(ID,L,R,V);
 369     void* InsertPos;
 370
 371     if (TreeTy* T = Cache.FindNodeOrInsertPos(ID,InsertPos))
 372       return T;
 373
 374     assert (InsertPos != NULL);
 375
 376     // FIXME: more intelligent calculation of alignment.
 377     TreeTy* T = (TreeTy*) Allocator.Allocate(sizeof(*T),16);
 378
 379     new (T) TreeTy(L,R,V,IncrementHeight(L,R));
 380
 381     Cache.InsertNode(T,InsertPos);
 382     return T;
 383   }
 384
 385   TreeTy* CreateNode(TreeTy* L, TreeTy* OldTree, TreeTy* R) {
 386     assert (!isEmpty(OldTree));
 387
 388     if (OldTree->isMutable()) {
 389       OldTree->setLeft(L);
 390       OldTree->setRight(R);
 391       OldTree->setHeight(IncrementHeight(L,R));
 392       return OldTree;
 393     }
 394     else return CreateNode(L, Value(OldTree), R);
 395   }
 396
 397   /// Balance - Used by Add_internal and Remove_internal to
 398   ///  balance a newly created tree.
 399   TreeTy* Balance(TreeTy* L, value_type_ref V, TreeTy* R) {
 400
 401     unsigned hl = Height(L);
 402     unsigned hr = Height(R);
 403
 404     if (hl > hr + 2) {
 405       assert (!isEmpty(L) &&
 406               "Left tree cannot be empty to have a height >= 2.");
 407
 408       TreeTy* LL = Left(L);
 409       TreeTy* LR = Right(L);
 410
 411       if (Height(LL) >= Height(LR))
 412         return CreateNode(LL, L, CreateNode(LR,V,R));
 413
 414       assert (!isEmpty(LR) &&
 415               "LR cannot be empty because it has a height >= 1.");
 416
 417       TreeTy* LRL = Left(LR);
 418       TreeTy* LRR = Right(LR);
 419
 420       return CreateNode(CreateNode(LL,L,LRL), LR, CreateNode(LRR,V,R));
 421     }
 422     else if (hr > hl + 2) {
 423       assert (!isEmpty(R) &&
 424               "Right tree cannot be empty to have a height >= 2.");
 425
 426       TreeTy* RL = Left(R);
 427       TreeTy* RR = Right(R);
 428
 429       if (Height(RR) >= Height(RL))
 430         return CreateNode(CreateNode(L,V,RL), R, RR);
 431
 432       assert (!isEmpty(RL) &&
 433               "RL cannot be empty because it has a height >= 1.");
 434
 435       TreeTy* RLL = Left(RL);
 436       TreeTy* RLR = Right(RL);
 437
 438       return CreateNode(CreateNode(L,V,RLL), RL, CreateNode(RLR,R,RR));
 439     }
 440     else
 441       return CreateNode(L,V,R);
 442   }
 443
 444   /// Add_internal - Creates a new tree that includes the specified
 445   ///  data and the data from the original tree.  If the original tree
 446   ///  already contained the data item, the original tree is returned.
 447   TreeTy* Add_internal(value_type_ref V, TreeTy* T) {
 448     if (isEmpty(T))
 449       return CreateNode(T, V, T);
 450
 451     assert (!T->isMutable());
 452
 453     key_type_ref K = ImutInfo::KeyOfValue(V);
 454     key_type_ref KCurrent = ImutInfo::KeyOfValue(Value(T));
 455
 456     if (ImutInfo::isEqual(K,KCurrent))
 457       return CreateNode(Left(T), V, Right(T));
 458     else if (ImutInfo::isLess(K,KCurrent))
 459       return Balance(Add_internal(V,Left(T)), Value(T), Right(T));
 460     else
 461       return Balance(Left(T), Value(T), Add_internal(V,Right(T)));
 462   }
 463
 464   /// Remove_interal - Creates a new tree that includes all the data
 465   ///  from the original tree except the specified data.  If the
 466   ///  specified data did not exist in the original tree, the original
 467   ///  tree is returned.
 468   TreeTy* Remove_internal(key_type_ref K, TreeTy* T) {
 469     if (isEmpty(T))
 470       return T;
 471
 472     assert (!T->isMutable());
 473
 474     key_type_ref KCurrent = ImutInfo::KeyOfValue(Value(T));
 475
 476     if (ImutInfo::isEqual(K,KCurrent))
 477       return CombineLeftRightTrees(Left(T),Right(T));
 478     else if (ImutInfo::isLess(K,KCurrent))
 479       return Balance(Remove_internal(K,Left(T)), Value(T), Right(T));
 480     else
 481       return Balance(Left(T), Value(T), Remove_internal(K,Right(T)));
 482   }
 483
 484   TreeTy* CombineLeftRightTrees(TreeTy* L, TreeTy* R) {
 485     if (isEmpty(L)) return R;
 486     if (isEmpty(R)) return L;
 487
 488     TreeTy* OldNode;
 489     TreeTy* NewRight = RemoveMinBinding(R,OldNode);
 490     return Balance(L,Value(OldNode),NewRight);
 491   }
 492
 493   TreeTy* RemoveMinBinding(TreeTy* T, TreeTy*& NodeRemoved) {
 494     assert (!isEmpty(T));
 495
 496     if (isEmpty(Left(T))) {
 497       NodeRemoved = T;
 498       return Right(T);
 499     }
 500
 501     return Balance(RemoveMinBinding(Left(T),NodeRemoved),Value(T),Right(T));
 502   }
 503
 504   /// MarkImmutable - Clears the mutable bits of a root and all of its
 505   ///  descendants.
 506   void MarkImmutable(TreeTy* T) {
 507     if (!T || !T->isMutable())
 508       return;
 509
 510     T->MarkMutable();
 511     MarkImmutable(Left(T));
 512     MarkImmutable(Right(T));
 513   }
 514 };
 515
 516
 517 //===----------------------------------------------------------------------===//
 518 // Immutable AVL-Tree Iterators.
 519 //===----------------------------------------------------------------------===//
 520
 521 template <typename ImutInfo>
 522 class ImutAVLTreeGenericIterator {
 523   SmallVector<uintptr_t,20> stack;
 524 public:
 525   enum VisitFlag { VisitedNone=0x0, VisitedLeft=0x1, VisitedRight=0x3,
 526                    Flags=0x3 };
 527
 528   typedef ImutAVLTree<ImutInfo> TreeTy;
 529   typedef ImutAVLTreeGenericIterator<ImutInfo> _Self;
 530
 531   inline ImutAVLTreeGenericIterator() {}
 532   inline ImutAVLTreeGenericIterator(const TreeTy* Root) {
 533     if (Root) stack.push_back(reinterpret_cast<uintptr_t>(Root));
 534   }
 535
 536   TreeTy* operator*() const {
 537     assert (!stack.empty());
 538     return reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 539   }
 540
 541   uintptr_t getVisitState() {
 542     assert (!stack.empty());
 543     return stack.back() & Flags;
 544   }
 545
 546
 547   bool AtEnd() const { return stack.empty(); }
 548
 549   bool AtBeginning() const {
 550     return stack.size() == 1 && getVisitState() == VisitedNone;
 551   }
 552
 553   void SkipToParent() {
 554     assert (!stack.empty());
 555     stack.pop_back();
 556
 557     if (stack.empty())
 558       return;
 559
 560     switch (getVisitState()) {
 561       case VisitedNone:
 562         stack.back() |= VisitedLeft;
 563         break;
 564       case VisitedLeft:
 565         stack.back() |= VisitedRight;
 566         break;
 567       default:
 568         assert (false && "Unreachable.");
 569     }
 570   }
 571
 572   inline bool operator==(const _Self& x) const {
 573     if (stack.size() != x.stack.size())
 574       return false;
 575
 576     for (unsigned i = 0 ; i < stack.size(); i++)
 577       if (stack[i] != x.stack[i])
 578         return false;
 579
 580     return true;
 581   }
 582
 583   inline bool operator!=(const _Self& x) const { return !operator==(x); }
 584
 585   _Self& operator++() {
 586     assert (!stack.empty());
 587
 588     TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 589     assert (Current);
 590
 591     switch (getVisitState()) {
 592       case VisitedNone:
 593         if (TreeTy* L = Current->getLeft())
 594           stack.push_back(reinterpret_cast<uintptr_t>(L));
 595         else
 596           stack.back() |= VisitedLeft;
 597
 598         break;
 599
 600       case VisitedLeft:
 601         if (TreeTy* R = Current->getRight())
 602           stack.push_back(reinterpret_cast<uintptr_t>(R));
 603         else
 604           stack.back() |= VisitedRight;
 605
 606         break;
 607
 608       case VisitedRight:
 609         SkipToParent();
 610         break;
 611
 612       default:
 613         assert (false && "Unreachable.");
 614     }
 615
 616     return *this;
 617   }
 618
 619   _Self& operator--() {
 620     assert (!stack.empty());
 621
 622     TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
 623     assert (Current);
 624
 625     switch (getVisitState()) {
 626       case VisitedNone:
 627         stack.pop_back();
 628         break;
 629
 630       case VisitedLeft:
 631         stack.back() &= ~Flags; // Set state to "VisitedNone."
 632
 633         if (TreeTy* L = Current->getLeft())
 634           stack.push_back(reinterpret_cast<uintptr_t>(L) | VisitedRight);
 635
 636         break;
 637
 638       case VisitedRight:
 639         stack.back() &= ~Flags;
 640         stack.back() |= VisitedLeft;
 641
 642         if (TreeTy* R = Current->getRight())
 643           stack.push_back(reinterpret_cast<uintptr_t>(R) | VisitedRight);
 644
 645         break;
 646
 647       default:
 648         assert (false && "Unreachable.");
 649     }
 650
 651     return *this;
 652   }
 653 };
 654
 655 template <typename ImutInfo>
 656 class ImutAVLTreeInOrderIterator {
 657   typedef ImutAVLTreeGenericIterator<ImutInfo> InternalIteratorTy;
 658   InternalIteratorTy InternalItr;
 659
 660 public:
 661   typedef ImutAVLTree<ImutInfo> TreeTy;
 662   typedef ImutAVLTreeInOrderIterator<ImutInfo> _Self;
 663
 664   ImutAVLTreeInOrderIterator(const TreeTy* Root) : InternalItr(Root) {
 665     if (Root) operator++(); // Advance to first element.
 666   }
 667
 668   ImutAVLTreeInOrderIterator() : InternalItr() {}
 669
 670   inline bool operator==(const _Self& x) const {
 671     return InternalItr == x.InternalItr;
 672   }
 673
 674   inline bool operator!=(const _Self& x) const { return !operator==(x); }
 675
 676   inline TreeTy* operator*() const { return *InternalItr; }
 677   inline TreeTy* operator->() const { return *InternalItr; }
 678
 679   inline _Self& operator++() {
 680     do ++InternalItr;
 681     while (!InternalItr.AtEnd() &&
 682            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
 683
 684     return *this;
 685   }
 686
 687   inline _Self& operator--() {
 688     do --InternalItr;
 689     while (!InternalItr.AtBeginning() &&
 690            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
 691
 692     return *this;
 693   }
 694
 695   inline void SkipSubTree() {
 696     InternalItr.SkipToParent();
 697
 698     while (!InternalItr.AtEnd() &&
 699            InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft)
 700       ++InternalItr;
 701   }
 702 };
 703
 704 //===----------------------------------------------------------------------===//
 705 // Trait classes for Profile information.
 706 //===----------------------------------------------------------------------===//
 707
 708 /// Generic profile template.  The default behavior is to invoke the
 709 /// profile method of an object.  Specializations for primitive integers
 710 /// and generic handling of pointers is done below.
 711 template <typename T>
 712 struct ImutProfileInfo {
 713   typedef const T  value_type;
 714   typedef const T& value_type_ref;
 715
 716   static inline void Profile(FoldingSetNodeID& ID, value_type_ref X) {
 717     X.Profile(ID);
 718   }
 719 };
 720
 721 /// Profile traits for integers.
 722 template <typename T>
 723 struct ImutProfileInteger {
 724   typedef const T  value_type;
 725   typedef const T& value_type_ref;
 726
 727   static inline void Profile(FoldingSetNodeID& ID, value_type_ref X) {
 728     ID.AddInteger(X);
 729   }
 730 };
 731
 732 #define PROFILE_INTEGER_INFO(X)\
 733 template<> struct ImutProfileInfo<X> : ImutProfileInteger<X> {};
 734
 735 PROFILE_INTEGER_INFO(char)
 736 PROFILE_INTEGER_INFO(unsigned char)
 737 PROFILE_INTEGER_INFO(short)
 738 PROFILE_INTEGER_INFO(unsigned short)
 739 PROFILE_INTEGER_INFO(unsigned)
 740 PROFILE_INTEGER_INFO(signed)
 741 PROFILE_INTEGER_INFO(long)
 742 PROFILE_INTEGER_INFO(unsigned long)
 743 PROFILE_INTEGER_INFO(long long)
 744 PROFILE_INTEGER_INFO(unsigned long long)
 745
 746 #undef PROFILE_INTEGER_INFO
 747
 748 /// Generic profile trait for pointer types.  We treat pointers as
 749 /// references to unique objects.
 750 template <typename T>
 751 struct ImutProfileInfo<T*> {
 752   typedef const T*   value_type;
 753   typedef value_type value_type_ref;
 754
 755   static inline void Profile(FoldingSetNodeID &ID, value_type_ref X) {
 756     ID.AddPointer(X);
 757   }
 758 };
 759
 760 //===----------------------------------------------------------------------===//
 761 // Trait classes that contain element comparison operators and type
 762 //  definitions used by ImutAVLTree, ImmutableSet, and ImmutableMap.  These
 763 //  inherit from the profile traits (ImutProfileInfo) to include operations
 764 //  for element profiling.
 765 //===----------------------------------------------------------------------===//
 766
 767
 768 /// ImutContainerInfo - Generic definition of comparison operations for
 769 ///   elements of immutable containers that defaults to using
 770 ///   std::equal_to<> and std::less<> to perform comparison of elements.
 771 template <typename T>
 772 struct ImutContainerInfo : public ImutProfileInfo<T> {
 773   typedef typename ImutProfileInfo<T>::value_type      value_type;
 774   typedef typename ImutProfileInfo<T>::value_type_ref  value_type_ref;
 775   typedef value_type      key_type;
 776   typedef value_type_ref  key_type_ref;
 777
 778   static inline key_type_ref KeyOfValue(value_type_ref D) { return D; }
 779
 780   static inline bool isEqual(key_type_ref LHS, key_type_ref RHS) {
 781     return std::equal_to<key_type>()(LHS,RHS);
 782   }
 783
 784   static inline bool isLess(key_type_ref LHS, key_type_ref RHS) {
 785     return std::less<key_type>()(LHS,RHS);
 786   }
 787 };
 788
 789 /// ImutContainerInfo - Specialization for pointer values to treat pointers
 790 ///  as references to unique objects.  Pointers are thus compared by
 791 ///  their addresses.
 792 template <typename T>
 793 struct ImutContainerInfo<T*> : public ImutProfileInfo<T*> {
 794   typedef typename ImutProfileInfo<T*>::value_type      value_type;
 795   typedef typename ImutProfileInfo<T*>::value_type_ref  value_type_ref;
 796   typedef value_type      key_type;
 797   typedef value_type_ref  key_type_ref;
 798
 799   static inline key_type_ref KeyOfValue(value_type_ref D) { return D; }
 800
 801   static inline bool isEqual(key_type_ref LHS, key_type_ref RHS) {
 802     return LHS == RHS;
 803   }
 804
 805   static inline bool isLess(key_type_ref LHS, key_type_ref RHS) {
 806     return LHS < RHS;
 807   }
 808 };
 809
 810 //===----------------------------------------------------------------------===//
 811 // Immutable Set
 812 //===----------------------------------------------------------------------===//
 813
 814 template <typename ValT, typename ValInfo = ImutContainerInfo<ValT> >
 815 class ImmutableSet {
 816 public:
 817   typedef typename ValInfo::value_type      value_type;
 818   typedef typename ValInfo::value_type_ref  value_type_ref;
 819
 820 private:
 821   typedef ImutAVLTree<ValInfo> TreeTy;
 822   TreeTy* Root;
 823
 824   ImmutableSet(TreeTy* R) : Root(R) {}
 825
 826 public:
 827
 828   class Factory {
 829     typename TreeTy::Factory F;
 830
 831   public:
 832     Factory() {}
 833
 834     /// GetEmptySet - Returns an immutable set that contains no elements.
 835     ImmutableSet GetEmptySet() { return ImmutableSet(F.GetEmptyTree()); }
 836
 837     /// Add - Creates a new immutable set that contains all of the values
 838     ///  of the original set with the addition of the specified value.  If
 839     ///  the original set already included the value, then the original set is
 840     ///  returned and no memory is allocated.  The time and space complexity
 841     ///  of this operation is logarithmic in the size of the original set.
 842     ///  The memory allocated to represent the set is released when the
 843     ///  factory object that created the set is destroyed.
 844     ImmutableSet Add(ImmutableSet Old, value_type_ref V) {
 845       return ImmutableSet(F.Add(Old.Root,V));
 846     }
 847
 848     /// Remove - Creates a new immutable set that contains all of the values
 849     ///  of the original set with the exception of the specified value.  If
 850     ///  the original set did not contain the value, the original set is
 851     ///  returned and no memory is allocated.  The time and space complexity
 852     ///  of this operation is logarithmic in the size of the original set.
 853     ///  The memory allocated to represent the set is released when the
 854     ///  factory object that created the set is destroyed.
 855     ImmutableSet Remove(ImmutableSet Old, value_type_ref V) {
 856       return ImmutableSet(F.Remove(Old.Root,V));
 857     }
 858
 859     BumpPtrAllocator& getAllocator() { return F.getAllocator(); }
 860
 861   private:
 862     Factory(const Factory& RHS) {};
 863     void operator=(const Factory& RHS) {};
 864   };
 865
 866   friend class Factory;
 867
 868   /// contains - Returns true if the set contains the specified value.
 869   bool contains(const value_type_ref V) const {
 870     return Root ? Root->contains(V) : false;
 871   }
 872
 873   bool operator==(ImmutableSet RHS) const {
 874     return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
 875   }
 876
 877   bool operator!=(ImmutableSet RHS) const {
 878     return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
 879   }
 880
 881   /// isEmpty - Return true if the set contains no elements.
 882   bool isEmpty() const { return !Root; }
 883
 884   template <typename Callback>
 885   void foreach(Callback& C) { if (Root) Root->foreach(C); }
 886
 887   template <typename Callback>
 888   void foreach() { if (Root) { Callback C; Root->foreach(C); } }
 889
 890   //===--------------------------------------------------===//
 891   // Iterators.
 892   //===--------------------------------------------------===//
 893
 894   class iterator {
 895     typename TreeTy::iterator itr;
 896
 897     iterator() {}
 898     iterator(TreeTy* t) : itr(t) {}
 899     friend class ImmutableSet<ValT,ValInfo>;
 900   public:
 901     inline value_type_ref operator*() const { return itr->getValue(); }
 902     inline iterator& operator++() { ++itr; return *this; }
 903     inline iterator  operator++(int) { iterator tmp(*this); ++itr; return tmp; }
 904     inline iterator& operator--() { --itr; return *this; }
 905     inline iterator  operator--(int) { iterator tmp(*this); --itr; return tmp; }
 906     inline bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
 907     inline bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
 908   };
 909
 910   iterator begin() const { return iterator(Root); }
 911   iterator end() const { return iterator(); }
 912
 913   //===--------------------------------------------------===//
 914   // For testing.
 915   //===--------------------------------------------------===//
 916
 917   void verify() const { if (Root) Root->verify(); }
 918   unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
 919 };
 920
 921 } // end namespace llvm
 922
 923 #endif