1 //===--- ImmutableSet.h - Immutable (functional) set interface --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the ImutAVLTree and ImmutableSet classes.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ADT_IMMUTABLESET_H
15 #define LLVM_ADT_IMMUTABLESET_H
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/FoldingSet.h"
19 #include "llvm/Support/Allocator.h"
20 #include "llvm/Support/DataTypes.h"
21 #include "llvm/Support/ErrorHandling.h"
28 //===----------------------------------------------------------------------===//
29 // Immutable AVL-Tree Definition.
30 //===----------------------------------------------------------------------===//
32 template <typename ImutInfo> class ImutAVLFactory;
33 template <typename ImutInfo> class ImutIntervalAVLFactory;
34 template <typename ImutInfo> class ImutAVLTreeInOrderIterator;
35 template <typename ImutInfo> class ImutAVLTreeGenericIterator;
37 template <typename ImutInfo >
40 typedef typename ImutInfo::key_type_ref key_type_ref;
41 typedef typename ImutInfo::value_type value_type;
42 typedef typename ImutInfo::value_type_ref value_type_ref;
44 typedef ImutAVLFactory<ImutInfo> Factory;
45 friend class ImutAVLFactory<ImutInfo>;
46 friend class ImutIntervalAVLFactory<ImutInfo>;
48 friend class ImutAVLTreeGenericIterator<ImutInfo>;
50 typedef ImutAVLTreeInOrderIterator<ImutInfo> iterator;
52 //===----------------------------------------------------===//
54 //===----------------------------------------------------===//
56 /// Return a pointer to the left subtree. This value
57 /// is NULL if there is no left subtree.
58 ImutAVLTree *getLeft() const { return left; }
60 /// Return a pointer to the right subtree. This value is
61 /// NULL if there is no right subtree.
62 ImutAVLTree *getRight() const { return right; }
64 /// getHeight - Returns the height of the tree. A tree with no subtrees
65 /// has a height of 1.
66 unsigned getHeight() const { return height; }
68 /// getValue - Returns the data value associated with the tree node.
69 const value_type& getValue() const { return value; }
71 /// find - Finds the subtree associated with the specified key value.
72 /// This method returns NULL if no matching subtree is found.
73 ImutAVLTree* find(key_type_ref K) {
74 ImutAVLTree *T = this;
76 key_type_ref CurrentKey = ImutInfo::KeyOfValue(T->getValue());
77 if (ImutInfo::isEqual(K,CurrentKey))
79 else if (ImutInfo::isLess(K,CurrentKey))
87 /// getMaxElement - Find the subtree associated with the highest ranged
89 ImutAVLTree* getMaxElement() {
90 ImutAVLTree *T = this;
91 ImutAVLTree *Right = T->getRight();
92 while (Right) { T = Right; Right = T->getRight(); }
96 /// size - Returns the number of nodes in the tree, which includes
97 /// both leaves and non-leaf nodes.
98 unsigned size() const {
100 if (const ImutAVLTree* L = getLeft())
102 if (const ImutAVLTree* R = getRight())
107 /// begin - Returns an iterator that iterates over the nodes of the tree
108 /// in an inorder traversal. The returned iterator thus refers to the
109 /// the tree node with the minimum data element.
110 iterator begin() const { return iterator(this); }
112 /// end - Returns an iterator for the tree that denotes the end of an
113 /// inorder traversal.
114 iterator end() const { return iterator(); }
116 bool isElementEqual(value_type_ref V) const {
118 if (!ImutInfo::isEqual(ImutInfo::KeyOfValue(getValue()),
119 ImutInfo::KeyOfValue(V)))
122 // Also compare the data values.
123 if (!ImutInfo::isDataEqual(ImutInfo::DataOfValue(getValue()),
124 ImutInfo::DataOfValue(V)))
130 bool isElementEqual(const ImutAVLTree* RHS) const {
131 return isElementEqual(RHS->getValue());
134 /// isEqual - Compares two trees for structural equality and returns true
135 /// if they are equal. This worst case performance of this operation is
136 // linear in the sizes of the trees.
137 bool isEqual(const ImutAVLTree& RHS) const {
141 iterator LItr = begin(), LEnd = end();
142 iterator RItr = RHS.begin(), REnd = RHS.end();
144 while (LItr != LEnd && RItr != REnd) {
145 if (*LItr == *RItr) {
151 if (!LItr->isElementEqual(*RItr))
158 return LItr == LEnd && RItr == REnd;
161 /// isNotEqual - Compares two trees for structural inequality. Performance
162 /// is the same is isEqual.
163 bool isNotEqual(const ImutAVLTree& RHS) const { return !isEqual(RHS); }
165 /// contains - Returns true if this tree contains a subtree (node) that
166 /// has an data element that matches the specified key. Complexity
167 /// is logarithmic in the size of the tree.
168 bool contains(key_type_ref K) { return (bool) find(K); }
170 /// foreach - A member template the accepts invokes operator() on a functor
171 /// object (specifed by Callback) for every node/subtree in the tree.
172 /// Nodes are visited using an inorder traversal.
173 template <typename Callback>
174 void foreach(Callback& C) {
175 if (ImutAVLTree* L = getLeft())
180 if (ImutAVLTree* R = getRight())
184 /// validateTree - A utility method that checks that the balancing and
185 /// ordering invariants of the tree are satisifed. It is a recursive
186 /// method that returns the height of the tree, which is then consumed
187 /// by the enclosing validateTree call. External callers should ignore the
188 /// return value. An invalid tree will cause an assertion to fire in
190 unsigned validateTree() const {
191 unsigned HL = getLeft() ? getLeft()->validateTree() : 0;
192 unsigned HR = getRight() ? getRight()->validateTree() : 0;
196 assert(getHeight() == ( HL > HR ? HL : HR ) + 1
197 && "Height calculation wrong");
199 assert((HL > HR ? HL-HR : HR-HL) <= 2
200 && "Balancing invariant violated");
202 assert((!getLeft() ||
203 ImutInfo::isLess(ImutInfo::KeyOfValue(getLeft()->getValue()),
204 ImutInfo::KeyOfValue(getValue()))) &&
205 "Value in left child is not less that current value");
208 assert(!(getRight() ||
209 ImutInfo::isLess(ImutInfo::KeyOfValue(getValue()),
210 ImutInfo::KeyOfValue(getRight()->getValue()))) &&
211 "Current value is not less that value of right child");
216 //===----------------------------------------------------===//
218 //===----------------------------------------------------===//
227 unsigned height : 28;
228 unsigned IsMutable : 1;
229 unsigned IsDigestCached : 1;
230 unsigned IsCanonicalized : 1;
236 //===----------------------------------------------------===//
237 // Internal methods (node manipulation; used by Factory).
238 //===----------------------------------------------------===//
241 /// ImutAVLTree - Internal constructor that is only called by
243 ImutAVLTree(Factory *f, ImutAVLTree* l, ImutAVLTree* r, value_type_ref v,
245 : factory(f), left(l), right(r), prev(nullptr), next(nullptr),
246 height(height), IsMutable(true), IsDigestCached(false),
247 IsCanonicalized(0), value(v), digest(0), refCount(0)
249 if (left) left->retain();
250 if (right) right->retain();
253 /// isMutable - Returns true if the left and right subtree references
254 /// (as well as height) can be changed. If this method returns false,
255 /// the tree is truly immutable. Trees returned from an ImutAVLFactory
256 /// object should always have this method return true. Further, if this
257 /// method returns false for an instance of ImutAVLTree, all subtrees
258 /// will also have this method return false. The converse is not true.
259 bool isMutable() const { return IsMutable; }
261 /// hasCachedDigest - Returns true if the digest for this tree is cached.
262 /// This can only be true if the tree is immutable.
263 bool hasCachedDigest() const { return IsDigestCached; }
265 //===----------------------------------------------------===//
266 // Mutating operations. A tree root can be manipulated as
267 // long as its reference has not "escaped" from internal
268 // methods of a factory object (see below). When a tree
269 // pointer is externally viewable by client code, the
270 // internal "mutable bit" is cleared to mark the tree
271 // immutable. Note that a tree that still has its mutable
272 // bit set may have children (subtrees) that are themselves
274 //===----------------------------------------------------===//
276 /// markImmutable - Clears the mutable flag for a tree. After this happens,
277 /// it is an error to call setLeft(), setRight(), and setHeight().
278 void markImmutable() {
279 assert(isMutable() && "Mutable flag already removed.");
283 /// markedCachedDigest - Clears the NoCachedDigest flag for a tree.
284 void markedCachedDigest() {
285 assert(!hasCachedDigest() && "NoCachedDigest flag already removed.");
286 IsDigestCached = true;
289 /// setHeight - Changes the height of the tree. Used internally by
291 void setHeight(unsigned h) {
292 assert(isMutable() && "Only a mutable tree can have its height changed.");
296 static uint32_t computeDigest(ImutAVLTree *L, ImutAVLTree *R,
301 digest += L->computeDigest();
303 // Compute digest of stored data.
305 ImutInfo::Profile(ID,V);
306 digest += ID.ComputeHash();
309 digest += R->computeDigest();
314 uint32_t computeDigest() {
315 // Check the lowest bit to determine if digest has actually been
317 if (hasCachedDigest())
320 uint32_t X = computeDigest(getLeft(), getRight(), getValue());
322 markedCachedDigest();
326 //===----------------------------------------------------===//
327 // Reference count operations.
328 //===----------------------------------------------------===//
331 void retain() { ++refCount; }
333 assert(refCount > 0);
342 if (IsCanonicalized) {
349 factory->Cache[factory->maskCacheIndex(computeDigest())] = next;
352 // We need to clear the mutability bit in case we are
353 // destroying the node as part of a sweep in ImutAVLFactory::recoverNodes().
355 factory->freeNodes.push_back(this);
359 //===----------------------------------------------------------------------===//
360 // Immutable AVL-Tree Factory class.
361 //===----------------------------------------------------------------------===//
363 template <typename ImutInfo >
364 class ImutAVLFactory {
365 friend class ImutAVLTree<ImutInfo>;
366 typedef ImutAVLTree<ImutInfo> TreeTy;
367 typedef typename TreeTy::value_type_ref value_type_ref;
368 typedef typename TreeTy::key_type_ref key_type_ref;
370 typedef DenseMap<unsigned, TreeTy*> CacheTy;
374 std::vector<TreeTy*> createdNodes;
375 std::vector<TreeTy*> freeNodes;
377 bool ownsAllocator() const {
378 return Allocator & 0x1 ? false : true;
381 BumpPtrAllocator& getAllocator() const {
382 return *reinterpret_cast<BumpPtrAllocator*>(Allocator & ~0x1);
385 //===--------------------------------------------------===//
387 //===--------------------------------------------------===//
391 : Allocator(reinterpret_cast<uintptr_t>(new BumpPtrAllocator())) {}
393 ImutAVLFactory(BumpPtrAllocator& Alloc)
394 : Allocator(reinterpret_cast<uintptr_t>(&Alloc) | 0x1) {}
397 if (ownsAllocator()) delete &getAllocator();
400 TreeTy* add(TreeTy* T, value_type_ref V) {
401 T = add_internal(V,T);
407 TreeTy* remove(TreeTy* T, key_type_ref V) {
408 T = remove_internal(V,T);
414 TreeTy* getEmptyTree() const { return nullptr; }
418 //===--------------------------------------------------===//
419 // A bunch of quick helper functions used for reasoning
420 // about the properties of trees and their children.
421 // These have succinct names so that the balancing code
422 // is as terse (and readable) as possible.
423 //===--------------------------------------------------===//
425 bool isEmpty(TreeTy* T) const { return !T; }
426 unsigned getHeight(TreeTy* T) const { return T ? T->getHeight() : 0; }
427 TreeTy* getLeft(TreeTy* T) const { return T->getLeft(); }
428 TreeTy* getRight(TreeTy* T) const { return T->getRight(); }
429 value_type_ref getValue(TreeTy* T) const { return T->value; }
431 // Make sure the index is not the Tombstone or Entry key of the DenseMap.
432 static unsigned maskCacheIndex(unsigned I) { return (I & ~0x02); }
434 unsigned incrementHeight(TreeTy* L, TreeTy* R) const {
435 unsigned hl = getHeight(L);
436 unsigned hr = getHeight(R);
437 return (hl > hr ? hl : hr) + 1;
440 static bool compareTreeWithSection(TreeTy* T,
441 typename TreeTy::iterator& TI,
442 typename TreeTy::iterator& TE) {
443 typename TreeTy::iterator I = T->begin(), E = T->end();
444 for ( ; I!=E ; ++I, ++TI) {
445 if (TI == TE || !I->isElementEqual(*TI))
451 //===--------------------------------------------------===//
452 // "createNode" is used to generate new tree roots that link
453 // to other trees. The functon may also simply move links
454 // in an existing root if that root is still marked mutable.
455 // This is necessary because otherwise our balancing code
456 // would leak memory as it would create nodes that are
457 // then discarded later before the finished tree is
458 // returned to the caller.
459 //===--------------------------------------------------===//
461 TreeTy* createNode(TreeTy* L, value_type_ref V, TreeTy* R) {
462 BumpPtrAllocator& A = getAllocator();
464 if (!freeNodes.empty()) {
465 T = freeNodes.back();
466 freeNodes.pop_back();
470 T = (TreeTy*) A.Allocate<TreeTy>();
472 new (T) TreeTy(this, L, R, V, incrementHeight(L,R));
473 createdNodes.push_back(T);
477 TreeTy* createNode(TreeTy* newLeft, TreeTy* oldTree, TreeTy* newRight) {
478 return createNode(newLeft, getValue(oldTree), newRight);
481 void recoverNodes() {
482 for (unsigned i = 0, n = createdNodes.size(); i < n; ++i) {
483 TreeTy *N = createdNodes[i];
484 if (N->isMutable() && N->refCount == 0)
487 createdNodes.clear();
490 /// balanceTree - Used by add_internal and remove_internal to
491 /// balance a newly created tree.
492 TreeTy* balanceTree(TreeTy* L, value_type_ref V, TreeTy* R) {
493 unsigned hl = getHeight(L);
494 unsigned hr = getHeight(R);
497 assert(!isEmpty(L) && "Left tree cannot be empty to have a height >= 2");
499 TreeTy *LL = getLeft(L);
500 TreeTy *LR = getRight(L);
502 if (getHeight(LL) >= getHeight(LR))
503 return createNode(LL, L, createNode(LR,V,R));
505 assert(!isEmpty(LR) && "LR cannot be empty because it has a height >= 1");
507 TreeTy *LRL = getLeft(LR);
508 TreeTy *LRR = getRight(LR);
510 return createNode(createNode(LL,L,LRL), LR, createNode(LRR,V,R));
514 assert(!isEmpty(R) && "Right tree cannot be empty to have a height >= 2");
516 TreeTy *RL = getLeft(R);
517 TreeTy *RR = getRight(R);
519 if (getHeight(RR) >= getHeight(RL))
520 return createNode(createNode(L,V,RL), R, RR);
522 assert(!isEmpty(RL) && "RL cannot be empty because it has a height >= 1");
524 TreeTy *RLL = getLeft(RL);
525 TreeTy *RLR = getRight(RL);
527 return createNode(createNode(L,V,RLL), RL, createNode(RLR,R,RR));
530 return createNode(L,V,R);
533 /// add_internal - Creates a new tree that includes the specified
534 /// data and the data from the original tree. If the original tree
535 /// already contained the data item, the original tree is returned.
536 TreeTy* add_internal(value_type_ref V, TreeTy* T) {
538 return createNode(T, V, T);
539 assert(!T->isMutable());
541 key_type_ref K = ImutInfo::KeyOfValue(V);
542 key_type_ref KCurrent = ImutInfo::KeyOfValue(getValue(T));
544 if (ImutInfo::isEqual(K,KCurrent))
545 return createNode(getLeft(T), V, getRight(T));
546 else if (ImutInfo::isLess(K,KCurrent))
547 return balanceTree(add_internal(V, getLeft(T)), getValue(T), getRight(T));
549 return balanceTree(getLeft(T), getValue(T), add_internal(V, getRight(T)));
552 /// remove_internal - Creates a new tree that includes all the data
553 /// from the original tree except the specified data. If the
554 /// specified data did not exist in the original tree, the original
555 /// tree is returned.
556 TreeTy* remove_internal(key_type_ref K, TreeTy* T) {
560 assert(!T->isMutable());
562 key_type_ref KCurrent = ImutInfo::KeyOfValue(getValue(T));
564 if (ImutInfo::isEqual(K,KCurrent)) {
565 return combineTrees(getLeft(T), getRight(T));
566 } else if (ImutInfo::isLess(K,KCurrent)) {
567 return balanceTree(remove_internal(K, getLeft(T)),
568 getValue(T), getRight(T));
570 return balanceTree(getLeft(T), getValue(T),
571 remove_internal(K, getRight(T)));
575 TreeTy* combineTrees(TreeTy* L, TreeTy* R) {
581 TreeTy* newRight = removeMinBinding(R,OldNode);
582 return balanceTree(L, getValue(OldNode), newRight);
585 TreeTy* removeMinBinding(TreeTy* T, TreeTy*& Noderemoved) {
587 if (isEmpty(getLeft(T))) {
591 return balanceTree(removeMinBinding(getLeft(T), Noderemoved),
592 getValue(T), getRight(T));
595 /// markImmutable - Clears the mutable bits of a root and all of its
597 void markImmutable(TreeTy* T) {
598 if (!T || !T->isMutable())
601 markImmutable(getLeft(T));
602 markImmutable(getRight(T));
606 TreeTy *getCanonicalTree(TreeTy *TNew) {
610 if (TNew->IsCanonicalized)
613 // Search the hashtable for another tree with the same digest, and
614 // if find a collision compare those trees by their contents.
615 unsigned digest = TNew->computeDigest();
616 TreeTy *&entry = Cache[maskCacheIndex(digest)];
620 for (TreeTy *T = entry ; T != nullptr; T = T->next) {
621 // Compare the Contents('T') with Contents('TNew')
622 typename TreeTy::iterator TI = T->begin(), TE = T->end();
623 if (!compareTreeWithSection(TNew, TI, TE))
626 continue; // T has more contents than TNew.
627 // Trees did match! Return 'T'.
628 if (TNew->refCount == 0)
638 TNew->IsCanonicalized = true;
643 //===----------------------------------------------------------------------===//
644 // Immutable AVL-Tree Iterators.
645 //===----------------------------------------------------------------------===//
647 template <typename ImutInfo>
648 class ImutAVLTreeGenericIterator {
649 SmallVector<uintptr_t,20> stack;
651 enum VisitFlag { VisitedNone=0x0, VisitedLeft=0x1, VisitedRight=0x3,
654 typedef ImutAVLTree<ImutInfo> TreeTy;
655 typedef ImutAVLTreeGenericIterator<ImutInfo> Self;
657 ImutAVLTreeGenericIterator() {}
658 ImutAVLTreeGenericIterator(const TreeTy *Root) {
659 if (Root) stack.push_back(reinterpret_cast<uintptr_t>(Root));
662 TreeTy* operator*() const {
663 assert(!stack.empty());
664 return reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
667 uintptr_t getVisitState() const {
668 assert(!stack.empty());
669 return stack.back() & Flags;
673 bool atEnd() const { return stack.empty(); }
675 bool atBeginning() const {
676 return stack.size() == 1 && getVisitState() == VisitedNone;
679 void skipToParent() {
680 assert(!stack.empty());
684 switch (getVisitState()) {
686 stack.back() |= VisitedLeft;
689 stack.back() |= VisitedRight;
692 llvm_unreachable("Unreachable.");
696 bool operator==(const Self &x) const { return stack == x.stack; }
698 bool operator!=(const Self &x) const { return !operator==(x); }
701 assert(!stack.empty());
702 TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
704 switch (getVisitState()) {
706 if (TreeTy* L = Current->getLeft())
707 stack.push_back(reinterpret_cast<uintptr_t>(L));
709 stack.back() |= VisitedLeft;
712 if (TreeTy* R = Current->getRight())
713 stack.push_back(reinterpret_cast<uintptr_t>(R));
715 stack.back() |= VisitedRight;
721 llvm_unreachable("Unreachable.");
727 assert(!stack.empty());
728 TreeTy* Current = reinterpret_cast<TreeTy*>(stack.back() & ~Flags);
730 switch (getVisitState()) {
735 stack.back() &= ~Flags; // Set state to "VisitedNone."
736 if (TreeTy* L = Current->getLeft())
737 stack.push_back(reinterpret_cast<uintptr_t>(L) | VisitedRight);
740 stack.back() &= ~Flags;
741 stack.back() |= VisitedLeft;
742 if (TreeTy* R = Current->getRight())
743 stack.push_back(reinterpret_cast<uintptr_t>(R) | VisitedRight);
746 llvm_unreachable("Unreachable.");
752 template <typename ImutInfo>
753 class ImutAVLTreeInOrderIterator {
754 typedef ImutAVLTreeGenericIterator<ImutInfo> InternalIteratorTy;
755 InternalIteratorTy InternalItr;
758 typedef ImutAVLTree<ImutInfo> TreeTy;
759 typedef ImutAVLTreeInOrderIterator<ImutInfo> Self;
761 ImutAVLTreeInOrderIterator(const TreeTy* Root) : InternalItr(Root) {
763 ++*this; // Advance to first element.
766 ImutAVLTreeInOrderIterator() : InternalItr() {}
768 bool operator==(const Self &x) const { return InternalItr == x.InternalItr; }
770 bool operator!=(const Self &x) const { return !(*this == x); }
772 TreeTy *operator*() const { return *InternalItr; }
773 TreeTy *operator->() const { return *InternalItr; }
777 while (!InternalItr.atEnd() &&
778 InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
785 while (!InternalItr.atBeginning() &&
786 InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft);
792 InternalItr.skipToParent();
794 while (!InternalItr.atEnd() &&
795 InternalItr.getVisitState() != InternalIteratorTy::VisitedLeft)
800 //===----------------------------------------------------------------------===//
801 // Trait classes for Profile information.
802 //===----------------------------------------------------------------------===//
804 /// Generic profile template. The default behavior is to invoke the
805 /// profile method of an object. Specializations for primitive integers
806 /// and generic handling of pointers is done below.
807 template <typename T>
808 struct ImutProfileInfo {
809 typedef const T value_type;
810 typedef const T& value_type_ref;
812 static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
813 FoldingSetTrait<T>::Profile(X,ID);
817 /// Profile traits for integers.
818 template <typename T>
819 struct ImutProfileInteger {
820 typedef const T value_type;
821 typedef const T& value_type_ref;
823 static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
828 #define PROFILE_INTEGER_INFO(X)\
829 template<> struct ImutProfileInfo<X> : ImutProfileInteger<X> {};
831 PROFILE_INTEGER_INFO(char)
832 PROFILE_INTEGER_INFO(unsigned char)
833 PROFILE_INTEGER_INFO(short)
834 PROFILE_INTEGER_INFO(unsigned short)
835 PROFILE_INTEGER_INFO(unsigned)
836 PROFILE_INTEGER_INFO(signed)
837 PROFILE_INTEGER_INFO(long)
838 PROFILE_INTEGER_INFO(unsigned long)
839 PROFILE_INTEGER_INFO(long long)
840 PROFILE_INTEGER_INFO(unsigned long long)
842 #undef PROFILE_INTEGER_INFO
844 /// Profile traits for booleans.
846 struct ImutProfileInfo<bool> {
847 typedef const bool value_type;
848 typedef const bool& value_type_ref;
850 static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
856 /// Generic profile trait for pointer types. We treat pointers as
857 /// references to unique objects.
858 template <typename T>
859 struct ImutProfileInfo<T*> {
860 typedef const T* value_type;
861 typedef value_type value_type_ref;
863 static void Profile(FoldingSetNodeID &ID, value_type_ref X) {
868 //===----------------------------------------------------------------------===//
869 // Trait classes that contain element comparison operators and type
870 // definitions used by ImutAVLTree, ImmutableSet, and ImmutableMap. These
871 // inherit from the profile traits (ImutProfileInfo) to include operations
872 // for element profiling.
873 //===----------------------------------------------------------------------===//
876 /// ImutContainerInfo - Generic definition of comparison operations for
877 /// elements of immutable containers that defaults to using
878 /// std::equal_to<> and std::less<> to perform comparison of elements.
879 template <typename T>
880 struct ImutContainerInfo : public ImutProfileInfo<T> {
881 typedef typename ImutProfileInfo<T>::value_type value_type;
882 typedef typename ImutProfileInfo<T>::value_type_ref value_type_ref;
883 typedef value_type key_type;
884 typedef value_type_ref key_type_ref;
885 typedef bool data_type;
886 typedef bool data_type_ref;
888 static key_type_ref KeyOfValue(value_type_ref D) { return D; }
889 static data_type_ref DataOfValue(value_type_ref) { return true; }
891 static bool isEqual(key_type_ref LHS, key_type_ref RHS) {
892 return std::equal_to<key_type>()(LHS,RHS);
895 static bool isLess(key_type_ref LHS, key_type_ref RHS) {
896 return std::less<key_type>()(LHS,RHS);
899 static bool isDataEqual(data_type_ref, data_type_ref) { return true; }
902 /// ImutContainerInfo - Specialization for pointer values to treat pointers
903 /// as references to unique objects. Pointers are thus compared by
905 template <typename T>
906 struct ImutContainerInfo<T*> : public ImutProfileInfo<T*> {
907 typedef typename ImutProfileInfo<T*>::value_type value_type;
908 typedef typename ImutProfileInfo<T*>::value_type_ref value_type_ref;
909 typedef value_type key_type;
910 typedef value_type_ref key_type_ref;
911 typedef bool data_type;
912 typedef bool data_type_ref;
914 static key_type_ref KeyOfValue(value_type_ref D) { return D; }
915 static data_type_ref DataOfValue(value_type_ref) { return true; }
917 static bool isEqual(key_type_ref LHS, key_type_ref RHS) { return LHS == RHS; }
919 static bool isLess(key_type_ref LHS, key_type_ref RHS) { return LHS < RHS; }
921 static bool isDataEqual(data_type_ref, data_type_ref) { return true; }
924 //===----------------------------------------------------------------------===//
926 //===----------------------------------------------------------------------===//
928 template <typename ValT, typename ValInfo = ImutContainerInfo<ValT> >
931 typedef typename ValInfo::value_type value_type;
932 typedef typename ValInfo::value_type_ref value_type_ref;
933 typedef ImutAVLTree<ValInfo> TreeTy;
939 /// Constructs a set from a pointer to a tree root. In general one
940 /// should use a Factory object to create sets instead of directly
941 /// invoking the constructor, but there are cases where make this
942 /// constructor public is useful.
943 explicit ImmutableSet(TreeTy* R) : Root(R) {
944 if (Root) { Root->retain(); }
946 ImmutableSet(const ImmutableSet &X) : Root(X.Root) {
947 if (Root) { Root->retain(); }
949 ImmutableSet &operator=(const ImmutableSet &X) {
950 if (Root != X.Root) {
951 if (X.Root) { X.Root->retain(); }
952 if (Root) { Root->release(); }
958 if (Root) { Root->release(); }
962 typename TreeTy::Factory F;
963 const bool Canonicalize;
966 Factory(bool canonicalize = true)
967 : Canonicalize(canonicalize) {}
969 Factory(BumpPtrAllocator& Alloc, bool canonicalize = true)
970 : F(Alloc), Canonicalize(canonicalize) {}
972 /// getEmptySet - Returns an immutable set that contains no elements.
973 ImmutableSet getEmptySet() {
974 return ImmutableSet(F.getEmptyTree());
977 /// add - Creates a new immutable set that contains all of the values
978 /// of the original set with the addition of the specified value. If
979 /// the original set already included the value, then the original set is
980 /// returned and no memory is allocated. The time and space complexity
981 /// of this operation is logarithmic in the size of the original set.
982 /// The memory allocated to represent the set is released when the
983 /// factory object that created the set is destroyed.
984 ImmutableSet add(ImmutableSet Old, value_type_ref V) {
985 TreeTy *NewT = F.add(Old.Root, V);
986 return ImmutableSet(Canonicalize ? F.getCanonicalTree(NewT) : NewT);
989 /// remove - Creates a new immutable set that contains all of the values
990 /// of the original set with the exception of the specified value. If
991 /// the original set did not contain the value, the original set is
992 /// returned and no memory is allocated. The time and space complexity
993 /// of this operation is logarithmic in the size of the original set.
994 /// The memory allocated to represent the set is released when the
995 /// factory object that created the set is destroyed.
996 ImmutableSet remove(ImmutableSet Old, value_type_ref V) {
997 TreeTy *NewT = F.remove(Old.Root, V);
998 return ImmutableSet(Canonicalize ? F.getCanonicalTree(NewT) : NewT);
1001 BumpPtrAllocator& getAllocator() { return F.getAllocator(); }
1003 typename TreeTy::Factory *getTreeFactory() const {
1004 return const_cast<typename TreeTy::Factory *>(&F);
1008 Factory(const Factory& RHS) = delete;
1009 void operator=(const Factory& RHS) = delete;
1012 friend class Factory;
1014 /// Returns true if the set contains the specified value.
1015 bool contains(value_type_ref V) const {
1016 return Root ? Root->contains(V) : false;
1019 bool operator==(const ImmutableSet &RHS) const {
1020 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
1023 bool operator!=(const ImmutableSet &RHS) const {
1024 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
1028 if (Root) { Root->retain(); }
1032 TreeTy *getRootWithoutRetain() const {
1036 /// isEmpty - Return true if the set contains no elements.
1037 bool isEmpty() const { return !Root; }
1039 /// isSingleton - Return true if the set contains exactly one element.
1040 /// This method runs in constant time.
1041 bool isSingleton() const { return getHeight() == 1; }
1043 template <typename Callback>
1044 void foreach(Callback& C) { if (Root) Root->foreach(C); }
1046 template <typename Callback>
1047 void foreach() { if (Root) { Callback C; Root->foreach(C); } }
1049 //===--------------------------------------------------===//
1051 //===--------------------------------------------------===//
1054 typename TreeTy::iterator itr;
1057 iterator(TreeTy* t) : itr(t) {}
1058 friend class ImmutableSet<ValT,ValInfo>;
1061 typedef ptrdiff_t difference_type;
1062 typedef typename ImmutableSet<ValT,ValInfo>::value_type value_type;
1063 typedef typename ImmutableSet<ValT,ValInfo>::value_type_ref reference;
1064 typedef typename iterator::value_type *pointer;
1065 typedef std::bidirectional_iterator_tag iterator_category;
1067 typename iterator::reference operator*() const { return itr->getValue(); }
1068 typename iterator::pointer operator->() const { return &**this; }
1070 iterator& operator++() { ++itr; return *this; }
1071 iterator operator++(int) { iterator tmp(*this); ++itr; return tmp; }
1072 iterator& operator--() { --itr; return *this; }
1073 iterator operator--(int) { iterator tmp(*this); --itr; return tmp; }
1075 bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
1076 bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
1079 iterator begin() const { return iterator(Root); }
1080 iterator end() const { return iterator(); }
1082 //===--------------------------------------------------===//
1084 //===--------------------------------------------------===//
1086 unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
1088 static void Profile(FoldingSetNodeID &ID, const ImmutableSet &S) {
1089 ID.AddPointer(S.Root);
1092 void Profile(FoldingSetNodeID &ID) const { return Profile(ID, *this); }
1094 //===--------------------------------------------------===//
1096 //===--------------------------------------------------===//
1098 void validateTree() const { if (Root) Root->validateTree(); }
1101 // NOTE: This may some day replace the current ImmutableSet.
1102 template <typename ValT, typename ValInfo = ImutContainerInfo<ValT> >
1103 class ImmutableSetRef {
1105 typedef typename ValInfo::value_type value_type;
1106 typedef typename ValInfo::value_type_ref value_type_ref;
1107 typedef ImutAVLTree<ValInfo> TreeTy;
1108 typedef typename TreeTy::Factory FactoryTy;
1115 /// Constructs a set from a pointer to a tree root. In general one
1116 /// should use a Factory object to create sets instead of directly
1117 /// invoking the constructor, but there are cases where make this
1118 /// constructor public is useful.
1119 explicit ImmutableSetRef(TreeTy* R, FactoryTy *F)
1122 if (Root) { Root->retain(); }
1124 ImmutableSetRef(const ImmutableSetRef &X)
1126 Factory(X.Factory) {
1127 if (Root) { Root->retain(); }
1129 ImmutableSetRef &operator=(const ImmutableSetRef &X) {
1130 if (Root != X.Root) {
1131 if (X.Root) { X.Root->retain(); }
1132 if (Root) { Root->release(); }
1134 Factory = X.Factory;
1138 ~ImmutableSetRef() {
1139 if (Root) { Root->release(); }
1142 static ImmutableSetRef getEmptySet(FactoryTy *F) {
1143 return ImmutableSetRef(0, F);
1146 ImmutableSetRef add(value_type_ref V) {
1147 return ImmutableSetRef(Factory->add(Root, V), Factory);
1150 ImmutableSetRef remove(value_type_ref V) {
1151 return ImmutableSetRef(Factory->remove(Root, V), Factory);
1154 /// Returns true if the set contains the specified value.
1155 bool contains(value_type_ref V) const {
1156 return Root ? Root->contains(V) : false;
1159 ImmutableSet<ValT> asImmutableSet(bool canonicalize = true) const {
1160 return ImmutableSet<ValT>(canonicalize ?
1161 Factory->getCanonicalTree(Root) : Root);
1164 TreeTy *getRootWithoutRetain() const {
1168 bool operator==(const ImmutableSetRef &RHS) const {
1169 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
1172 bool operator!=(const ImmutableSetRef &RHS) const {
1173 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
1176 /// isEmpty - Return true if the set contains no elements.
1177 bool isEmpty() const { return !Root; }
1179 /// isSingleton - Return true if the set contains exactly one element.
1180 /// This method runs in constant time.
1181 bool isSingleton() const { return getHeight() == 1; }
1183 //===--------------------------------------------------===//
1185 //===--------------------------------------------------===//
1188 typename TreeTy::iterator itr;
1189 iterator(TreeTy* t) : itr(t) {}
1190 friend class ImmutableSetRef<ValT,ValInfo>;
1193 value_type_ref operator*() const { return itr->getValue(); }
1194 iterator &operator++() {
1198 iterator operator++(int) {
1199 iterator tmp(*this);
1203 iterator &operator--() {
1207 iterator operator--(int) {
1208 iterator tmp(*this);
1212 bool operator==(const iterator &RHS) const { return RHS.itr == itr; }
1213 bool operator!=(const iterator &RHS) const { return RHS.itr != itr; }
1214 value_type *operator->() const { return &**this; }
1217 iterator begin() const { return iterator(Root); }
1218 iterator end() const { return iterator(); }
1220 //===--------------------------------------------------===//
1222 //===--------------------------------------------------===//
1224 unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
1226 static void Profile(FoldingSetNodeID &ID, const ImmutableSetRef &S) {
1227 ID.AddPointer(S.Root);
1230 void Profile(FoldingSetNodeID &ID) const { return Profile(ID, *this); }
1232 //===--------------------------------------------------===//
1234 //===--------------------------------------------------===//
1236 void validateTree() const { if (Root) Root->validateTree(); }
1239 } // end namespace llvm