1 //===- llvm/ADT/IntervalMap.h - A sorted interval map -----------*- 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 implements a coalescing interval map for small objects.
12 // KeyT objects are mapped to ValT objects. Intervals of keys that map to the
13 // same value are represented in a compressed form.
15 // Iterators provide ordered access to the compressed intervals rather than the
16 // individual keys, and insert and erase operations use key intervals as well.
18 // Like SmallVector, IntervalMap will store the first N intervals in the map
19 // object itself without any allocations. When space is exhausted it switches to
20 // a B+-tree representation with very small overhead for small key and value
23 // A Traits class specifies how keys are compared. It also allows IntervalMap to
24 // work with both closed and half-open intervals.
26 // Keys and values are not stored next to each other in a std::pair, so we don't
27 // provide such a value_type. Dereferencing iterators only returns the mapped
28 // value. The interval bounds are accessible through the start() and stop()
31 // IntervalMap is optimized for small key and value objects, 4 or 8 bytes each
32 // is the optimal size. For large objects use std::map instead.
34 //===----------------------------------------------------------------------===//
38 // template <typename KeyT, typename ValT, unsigned N, typename Traits>
39 // class IntervalMap {
41 // typedef KeyT key_type;
42 // typedef ValT mapped_type;
43 // typedef RecyclingAllocator<...> Allocator;
45 // class const_iterator;
47 // explicit IntervalMap(Allocator&);
50 // bool empty() const;
51 // KeyT start() const;
53 // ValT lookup(KeyT x, Value NotFound = Value()) const;
55 // const_iterator begin() const;
56 // const_iterator end() const;
59 // const_iterator find(KeyT x) const;
60 // iterator find(KeyT x);
62 // void insert(KeyT a, KeyT b, ValT y);
66 // template <typename KeyT, typename ValT, unsigned N, typename Traits>
67 // class IntervalMap::const_iterator :
68 // public std::iterator<std::bidirectional_iterator_tag, ValT> {
70 // bool operator==(const const_iterator &) const;
71 // bool operator!=(const const_iterator &) const;
72 // bool valid() const;
74 // const KeyT &start() const;
75 // const KeyT &stop() const;
76 // const ValT &value() const;
77 // const ValT &operator*() const;
78 // const ValT *operator->() const;
80 // const_iterator &operator++();
81 // const_iterator &operator++(int);
82 // const_iterator &operator--();
83 // const_iterator &operator--(int);
87 // void advanceTo(KeyT x);
90 // template <typename KeyT, typename ValT, unsigned N, typename Traits>
91 // class IntervalMap::iterator : public const_iterator {
93 // void insert(KeyT a, KeyT b, Value y);
97 //===----------------------------------------------------------------------===//
99 #ifndef LLVM_ADT_INTERVALMAP_H
100 #define LLVM_ADT_INTERVALMAP_H
102 #include "llvm/ADT/SmallVector.h"
103 #include "llvm/ADT/PointerIntPair.h"
104 #include "llvm/Support/Allocator.h"
105 #include "llvm/Support/RecyclingAllocator.h"
109 // FIXME: Remove debugging code.
110 #include "llvm/Support/raw_ostream.h"
115 //===----------------------------------------------------------------------===//
116 //--- Key traits ---//
117 //===----------------------------------------------------------------------===//
119 // The IntervalMap works with closed or half-open intervals.
120 // Adjacent intervals that map to the same value are coalesced.
122 // The IntervalMapInfo traits class is used to determine if a key is contained
123 // in an interval, and if two intervals are adjacent so they can be coalesced.
124 // The provided implementation works for closed integer intervals, other keys
125 // probably need a specialized version.
127 // The point x is contained in [a;b] when !startLess(x, a) && !stopLess(b, x).
129 // It is assumed that (a;b] half-open intervals are not used, only [a;b) is
130 // allowed. This is so that stopLess(a, b) can be used to determine if two
131 // intervals overlap.
133 //===----------------------------------------------------------------------===//
135 template <typename T>
136 struct IntervalMapInfo {
138 /// startLess - Return true if x is not in [a;b].
139 /// This is x < a both for closed intervals and for [a;b) half-open intervals.
140 static inline bool startLess(const T &x, const T &a) {
144 /// stopLess - Return true if x is not in [a;b].
145 /// This is b < x for a closed interval, b <= x for [a;b) half-open intervals.
146 static inline bool stopLess(const T &b, const T &x) {
150 /// adjacent - Return true when the intervals [x;a] and [b;y] can coalesce.
151 /// This is a+1 == b for closed intervals, a == b for half-open intervals.
152 static inline bool adjacent(const T &a, const T &b) {
158 /// IntervalMapImpl - Namespace used for IntervalMap implementation details.
159 /// It should be considered private to the implementation.
160 namespace IntervalMapImpl {
162 // Forward declarations.
163 template <typename, typename, unsigned, typename> class LeafNode;
164 template <typename, typename, unsigned, typename> class BranchNode;
166 typedef std::pair<unsigned,unsigned> IdxPair;
169 //===----------------------------------------------------------------------===//
170 //--- Node Storage ---//
171 //===----------------------------------------------------------------------===//
173 // Both leaf and branch nodes store vectors of pairs.
174 // Leaves store ((KeyT, KeyT), ValT) pairs, branches use (NodeRef, KeyT).
176 // Keys and values are stored in separate arrays to avoid padding caused by
177 // different object alignments. This also helps improve locality of reference
178 // when searching the keys.
180 // The nodes don't know how many elements they contain - that information is
181 // stored elsewhere. Omitting the size field prevents padding and allows a node
182 // to fill the allocated cache lines completely.
184 // These are typical key and value sizes, the node branching factor (N), and
185 // wasted space when nodes are sized to fit in three cache lines (192 bytes):
187 // T1 T2 N Waste Used by
188 // 4 4 24 0 Branch<4> (32-bit pointers)
189 // 8 4 16 0 Leaf<4,4>, Branch<4>
190 // 8 8 12 0 Leaf<4,8>, Branch<8>
191 // 16 4 9 12 Leaf<8,4>
192 // 16 8 8 0 Leaf<8,8>
194 //===----------------------------------------------------------------------===//
196 template <typename T1, typename T2, unsigned N>
199 enum { Capacity = N };
204 /// copy - Copy elements from another node.
205 /// @param Other Node elements are copied from.
206 /// @param i Beginning of the source range in other.
207 /// @param j Beginning of the destination range in this.
208 /// @param Count Number of elements to copy.
209 template <unsigned M>
210 void copy(const NodeBase<T1, T2, M> &Other, unsigned i,
211 unsigned j, unsigned Count) {
212 assert(i + Count <= M && "Invalid source range");
213 assert(j + Count <= N && "Invalid dest range");
214 std::copy(Other.first + i, Other.first + i + Count, first + j);
215 std::copy(Other.second + i, Other.second + i + Count, second + j);
218 /// moveLeft - Move elements to the left.
219 /// @param i Beginning of the source range.
220 /// @param j Beginning of the destination range.
221 /// @param Count Number of elements to copy.
222 void moveLeft(unsigned i, unsigned j, unsigned Count) {
223 assert(j <= i && "Use moveRight shift elements right");
224 copy(*this, i, j, Count);
227 /// moveRight - Move elements to the right.
228 /// @param i Beginning of the source range.
229 /// @param j Beginning of the destination range.
230 /// @param Count Number of elements to copy.
231 void moveRight(unsigned i, unsigned j, unsigned Count) {
232 assert(i <= j && "Use moveLeft shift elements left");
233 assert(j + Count <= N && "Invalid range");
234 std::copy_backward(first + i, first + i + Count, first + j + Count);
235 std::copy_backward(second + i, second + i + Count, second + j + Count);
238 /// erase - Erase elements [i;j).
239 /// @param i Beginning of the range to erase.
240 /// @param j End of the range. (Exclusive).
241 /// @param Size Number of elements in node.
242 void erase(unsigned i, unsigned j, unsigned Size) {
243 moveLeft(j, i, Size - j);
246 /// erase - Erase element at i.
247 /// @param i Index of element to erase.
248 /// @param Size Number of elements in node.
249 void erase(unsigned i, unsigned Size) {
253 /// shift - Shift elements [i;size) 1 position to the right.
254 /// @param i Beginning of the range to move.
255 /// @param Size Number of elements in node.
256 void shift(unsigned i, unsigned Size) {
257 moveRight(i, i + 1, Size - i);
260 /// transferToLeftSib - Transfer elements to a left sibling node.
261 /// @param Size Number of elements in this.
262 /// @param Sib Left sibling node.
263 /// @param SSize Number of elements in sib.
264 /// @param Count Number of elements to transfer.
265 void transferToLeftSib(unsigned Size, NodeBase &Sib, unsigned SSize,
267 Sib.copy(*this, 0, SSize, Count);
268 erase(0, Count, Size);
271 /// transferToRightSib - Transfer elements to a right sibling node.
272 /// @param Size Number of elements in this.
273 /// @param Sib Right sibling node.
274 /// @param SSize Number of elements in sib.
275 /// @param Count Number of elements to transfer.
276 void transferToRightSib(unsigned Size, NodeBase &Sib, unsigned SSize,
278 Sib.moveRight(0, Count, SSize);
279 Sib.copy(*this, Size-Count, 0, Count);
282 /// adjustFromLeftSib - Adjust the number if elements in this node by moving
283 /// elements to or from a left sibling node.
284 /// @param Size Number of elements in this.
285 /// @param Sib Right sibling node.
286 /// @param SSize Number of elements in sib.
287 /// @param Add The number of elements to add to this node, possibly < 0.
288 /// @return Number of elements added to this node, possibly negative.
289 int adjustFromLeftSib(unsigned Size, NodeBase &Sib, unsigned SSize, int Add) {
291 // We want to grow, copy from sib.
292 unsigned Count = std::min(std::min(unsigned(Add), SSize), N - Size);
293 Sib.transferToRightSib(SSize, *this, Size, Count);
296 // We want to shrink, copy to sib.
297 unsigned Count = std::min(std::min(unsigned(-Add), Size), N - SSize);
298 transferToLeftSib(Size, Sib, SSize, Count);
304 /// adjustSiblingSizes - Move elements between sibling nodes.
305 /// @param Node Array of pointers to sibling nodes.
306 /// @param Nodes Number of nodes.
307 /// @param CurSize Array of current node sizes, will be overwritten.
308 /// @param NewSize Array of desired node sizes.
309 template <typename NodeT>
310 void adjustSiblingSizes(NodeT *Node[], unsigned Nodes,
311 unsigned CurSize[], const unsigned NewSize[]) {
312 // Move elements right.
313 for (int n = Nodes - 1; n; --n) {
314 if (CurSize[n] == NewSize[n])
316 for (int m = n - 1; m != -1; --m) {
317 int d = Node[n]->adjustFromLeftSib(CurSize[n], *Node[m], CurSize[m],
318 NewSize[n] - CurSize[n]);
321 // Keep going if the current node was exhausted.
322 if (CurSize[n] >= NewSize[n])
330 // Move elements left.
331 for (unsigned n = 0; n != Nodes - 1; ++n) {
332 if (CurSize[n] == NewSize[n])
334 for (unsigned m = n + 1; m != Nodes; ++m) {
335 int d = Node[m]->adjustFromLeftSib(CurSize[m], *Node[n], CurSize[n],
336 CurSize[n] - NewSize[n]);
339 // Keep going if the current node was exhausted.
340 if (CurSize[n] >= NewSize[n])
346 for (unsigned n = 0; n != Nodes; n++)
347 assert(CurSize[n] == NewSize[n] && "Insufficient element shuffle");
351 /// distribute - Compute a new distribution of node elements after an overflow
352 /// or underflow. Reserve space for a new element at Position, and compute the
353 /// node that will hold Position after redistributing node elements.
355 /// It is required that
357 /// Elements == sum(CurSize), and
358 /// Elements + Grow <= Nodes * Capacity.
360 /// NewSize[] will be filled in such that:
362 /// sum(NewSize) == Elements, and
363 /// NewSize[i] <= Capacity.
365 /// The returned index is the node where Position will go, so:
367 /// sum(NewSize[0..idx-1]) <= Position
368 /// sum(NewSize[0..idx]) >= Position
370 /// The last equality, sum(NewSize[0..idx]) == Position, can only happen when
371 /// Grow is set and NewSize[idx] == Capacity-1. The index points to the node
372 /// before the one holding the Position'th element where there is room for an
375 /// @param Nodes The number of nodes.
376 /// @param Elements Total elements in all nodes.
377 /// @param Capacity The capacity of each node.
378 /// @param CurSize Array[Nodes] of current node sizes, or NULL.
379 /// @param NewSize Array[Nodes] to receive the new node sizes.
380 /// @param Position Insert position.
381 /// @param Grow Reserve space for a new element at Position.
382 /// @return (node, offset) for Position.
383 IdxPair distribute(unsigned Nodes, unsigned Elements, unsigned Capacity,
384 const unsigned *CurSize, unsigned NewSize[],
385 unsigned Position, bool Grow);
388 //===----------------------------------------------------------------------===//
389 //--- NodeSizer ---//
390 //===----------------------------------------------------------------------===//
392 // Compute node sizes from key and value types.
394 // The branching factors are chosen to make nodes fit in three cache lines.
395 // This may not be possible if keys or values are very large. Such large objects
396 // are handled correctly, but a std::map would probably give better performance.
398 //===----------------------------------------------------------------------===//
401 // Cache line size. Most architectures have 32 or 64 byte cache lines.
402 // We use 64 bytes here because it provides good branching factors.
404 CacheLineBytes = 1 << Log2CacheLine,
405 DesiredNodeBytes = 3 * CacheLineBytes
408 template <typename KeyT, typename ValT>
411 // Compute the leaf node branching factor that makes a node fit in three
412 // cache lines. The branching factor must be at least 3, or some B+-tree
413 // balancing algorithms won't work.
414 // LeafSize can't be larger than CacheLineBytes. This is required by the
415 // PointerIntPair used by NodeRef.
416 DesiredLeafSize = DesiredNodeBytes /
417 static_cast<unsigned>(2*sizeof(KeyT)+sizeof(ValT)),
419 LeafSize = DesiredLeafSize > MinLeafSize ? DesiredLeafSize : MinLeafSize
422 typedef NodeBase<std::pair<KeyT, KeyT>, ValT, LeafSize> LeafBase;
425 // Now that we have the leaf branching factor, compute the actual allocation
426 // unit size by rounding up to a whole number of cache lines.
427 AllocBytes = (sizeof(LeafBase) + CacheLineBytes-1) & ~(CacheLineBytes-1),
429 // Determine the branching factor for branch nodes.
430 BranchSize = AllocBytes /
431 static_cast<unsigned>(sizeof(KeyT) + sizeof(void*))
434 /// Allocator - The recycling allocator used for both branch and leaf nodes.
435 /// This typedef is very likely to be identical for all IntervalMaps with
436 /// reasonably sized entries, so the same allocator can be shared among
437 /// different kinds of maps.
438 typedef RecyclingAllocator<BumpPtrAllocator, char,
439 AllocBytes, CacheLineBytes> Allocator;
444 //===----------------------------------------------------------------------===//
446 //===----------------------------------------------------------------------===//
448 // B+-tree nodes can be leaves or branches, so we need a polymorphic node
449 // pointer that can point to both kinds.
451 // All nodes are cache line aligned and the low 6 bits of a node pointer are
452 // always 0. These bits are used to store the number of elements in the
453 // referenced node. Besides saving space, placing node sizes in the parents
454 // allow tree balancing algorithms to run without faulting cache lines for nodes
455 // that may not need to be modified.
457 // A NodeRef doesn't know whether it references a leaf node or a branch node.
458 // It is the responsibility of the caller to use the correct types.
460 // Nodes are never supposed to be empty, and it is invalid to store a node size
461 // of 0 in a NodeRef. The valid range of sizes is 1-64.
463 //===----------------------------------------------------------------------===//
465 struct CacheAlignedPointerTraits {
466 static inline void *getAsVoidPointer(void *P) { return P; }
467 static inline void *getFromVoidPointer(void *P) { return P; }
468 enum { NumLowBitsAvailable = Log2CacheLine };
472 PointerIntPair<void*, Log2CacheLine, unsigned, CacheAlignedPointerTraits> pip;
475 /// NodeRef - Create a null ref.
478 /// operator bool - Detect a null ref.
479 operator bool() const { return pip.getOpaqueValue(); }
481 /// NodeRef - Create a reference to the node p with n elements.
482 template <typename NodeT>
483 NodeRef(NodeT *p, unsigned n) : pip(p, n - 1) {
484 assert(n <= NodeT::Capacity && "Size too big for node");
487 /// size - Return the number of elements in the referenced node.
488 unsigned size() const { return pip.getInt() + 1; }
490 /// setSize - Update the node size.
491 void setSize(unsigned n) { pip.setInt(n - 1); }
493 /// subtree - Access the i'th subtree reference in a branch node.
494 /// This depends on branch nodes storing the NodeRef array as their first
496 NodeRef &subtree(unsigned i) const {
497 return reinterpret_cast<NodeRef*>(pip.getPointer())[i];
500 /// get - Dereference as a NodeT reference.
501 template <typename NodeT>
503 return *reinterpret_cast<NodeT*>(pip.getPointer());
506 bool operator==(const NodeRef &RHS) const {
509 assert(pip.getPointer() != RHS.pip.getPointer() && "Inconsistent NodeRefs");
513 bool operator!=(const NodeRef &RHS) const {
514 return !operator==(RHS);
518 //===----------------------------------------------------------------------===//
519 //--- Leaf nodes ---//
520 //===----------------------------------------------------------------------===//
522 // Leaf nodes store up to N disjoint intervals with corresponding values.
524 // The intervals are kept sorted and fully coalesced so there are no adjacent
525 // intervals mapping to the same value.
527 // These constraints are always satisfied:
529 // - Traits::stopLess(start(i), stop(i)) - Non-empty, sane intervals.
531 // - Traits::stopLess(stop(i), start(i + 1) - Sorted.
533 // - value(i) != value(i + 1) || !Traits::adjacent(stop(i), start(i + 1))
534 // - Fully coalesced.
536 //===----------------------------------------------------------------------===//
538 template <typename KeyT, typename ValT, unsigned N, typename Traits>
539 class LeafNode : public NodeBase<std::pair<KeyT, KeyT>, ValT, N> {
541 const KeyT &start(unsigned i) const { return this->first[i].first; }
542 const KeyT &stop(unsigned i) const { return this->first[i].second; }
543 const ValT &value(unsigned i) const { return this->second[i]; }
545 KeyT &start(unsigned i) { return this->first[i].first; }
546 KeyT &stop(unsigned i) { return this->first[i].second; }
547 ValT &value(unsigned i) { return this->second[i]; }
549 /// findFrom - Find the first interval after i that may contain x.
550 /// @param i Starting index for the search.
551 /// @param Size Number of elements in node.
552 /// @param x Key to search for.
553 /// @return First index with !stopLess(key[i].stop, x), or size.
554 /// This is the first interval that can possibly contain x.
555 unsigned findFrom(unsigned i, unsigned Size, KeyT x) const {
556 assert(i <= Size && Size <= N && "Bad indices");
557 assert((i == 0 || Traits::stopLess(stop(i - 1), x)) &&
558 "Index is past the needed point");
559 while (i != Size && Traits::stopLess(stop(i), x)) ++i;
563 /// safeFind - Find an interval that is known to exist. This is the same as
564 /// findFrom except is it assumed that x is at least within range of the last
566 /// @param i Starting index for the search.
567 /// @param x Key to search for.
568 /// @return First index with !stopLess(key[i].stop, x), never size.
569 /// This is the first interval that can possibly contain x.
570 unsigned safeFind(unsigned i, KeyT x) const {
571 assert(i < N && "Bad index");
572 assert((i == 0 || Traits::stopLess(stop(i - 1), x)) &&
573 "Index is past the needed point");
574 while (Traits::stopLess(stop(i), x)) ++i;
575 assert(i < N && "Unsafe intervals");
579 /// safeLookup - Lookup mapped value for a safe key.
580 /// It is assumed that x is within range of the last entry.
581 /// @param x Key to search for.
582 /// @param NotFound Value to return if x is not in any interval.
583 /// @return The mapped value at x or NotFound.
584 ValT safeLookup(KeyT x, ValT NotFound) const {
585 unsigned i = safeFind(0, x);
586 return Traits::startLess(x, start(i)) ? NotFound : value(i);
589 IdxPair insertFrom(unsigned i, unsigned Size, KeyT a, KeyT b, ValT y);
590 unsigned extendStop(unsigned i, unsigned Size, KeyT b);
593 void dump(raw_ostream &OS, unsigned Size) {
594 OS << " N" << this << " [shape=record label=\"{ " << Size << '/' << N;
595 for (unsigned i = 0; i != Size; ++i)
596 OS << " | {" << start(i) << '-' << stop(i) << "|" << value(i) << '}';
603 /// insertFrom - Add mapping of [a;b] to y if possible, coalescing as much as
604 /// possible. This may cause the node to grow by 1, or it may cause the node
605 /// to shrink because of coalescing.
606 /// @param i Starting index = insertFrom(0, size, a)
607 /// @param Size Number of elements in node.
608 /// @param a Interval start.
609 /// @param b Interval stop.
610 /// @param y Value be mapped.
611 /// @return (insert position, new size), or (i, Capacity+1) on overflow.
612 template <typename KeyT, typename ValT, unsigned N, typename Traits>
613 IdxPair LeafNode<KeyT, ValT, N, Traits>::
614 insertFrom(unsigned i, unsigned Size, KeyT a, KeyT b, ValT y) {
615 assert(i <= Size && Size <= N && "Invalid index");
616 assert(!Traits::stopLess(b, a) && "Invalid interval");
618 // Verify the findFrom invariant.
619 assert((i == 0 || Traits::stopLess(stop(i - 1), a)));
620 assert((i == Size || !Traits::stopLess(stop(i), a)));
622 // Coalesce with previous interval.
623 if (i && value(i - 1) == y && Traits::adjacent(stop(i - 1), a))
624 return IdxPair(i - 1, extendStop(i - 1, Size, b));
628 return IdxPair(i, N + 1);
630 // Add new interval at end.
635 return IdxPair(i, Size + 1);
638 // Overlapping intervals?
639 if (!Traits::stopLess(b, start(i))) {
640 assert(value(i) == y && "Inconsistent values in overlapping intervals");
641 if (Traits::startLess(a, start(i)))
643 return IdxPair(i, extendStop(i, Size, b));
646 // Try to coalesce with following interval.
647 if (value(i) == y && Traits::adjacent(b, start(i))) {
649 return IdxPair(i, Size);
652 // We must insert before i. Detect overflow.
654 return IdxPair(i, N + 1);
657 this->shift(i, Size);
661 return IdxPair(i, Size + 1);
664 /// extendStop - Extend stop(i) to b, coalescing with following intervals.
665 /// @param i Interval to extend.
666 /// @param Size Number of elements in node.
667 /// @param b New interval end point.
668 /// @return New node size after coalescing.
669 template <typename KeyT, typename ValT, unsigned N, typename Traits>
670 unsigned LeafNode<KeyT, ValT, N, Traits>::
671 extendStop(unsigned i, unsigned Size, KeyT b) {
672 assert(i < Size && Size <= N && "Bad indices");
674 // Are we even extending the interval?
675 if (Traits::startLess(b, stop(i)))
678 // Find the first interval that may be preserved.
679 unsigned j = findFrom(i + 1, Size, b);
681 // Would key[i] overlap key[j] after the extension?
682 if (Traits::stopLess(b, start(j))) {
683 // Not overlapping. Perhaps adjacent and coalescable?
684 if (value(i) == value(j) && Traits::adjacent(b, start(j)))
687 // Overlap. Include key[j] in the new interval.
688 assert(value(i) == value(j) && "Overlapping values");
694 // Entries [i+1;j) were coalesced.
695 if (i + 1 < j && j < Size)
696 this->erase(i + 1, j, Size);
697 return Size - (j - (i + 1));
701 //===----------------------------------------------------------------------===//
702 //--- Branch nodes ---//
703 //===----------------------------------------------------------------------===//
705 // A branch node stores references to 1--N subtrees all of the same height.
707 // The key array in a branch node holds the rightmost stop key of each subtree.
708 // It is redundant to store the last stop key since it can be found in the
709 // parent node, but doing so makes tree balancing a lot simpler.
711 // It is unusual for a branch node to only have one subtree, but it can happen
712 // in the root node if it is smaller than the normal nodes.
714 // When all of the leaf nodes from all the subtrees are concatenated, they must
715 // satisfy the same constraints as a single leaf node. They must be sorted,
716 // sane, and fully coalesced.
718 //===----------------------------------------------------------------------===//
720 template <typename KeyT, typename ValT, unsigned N, typename Traits>
721 class BranchNode : public NodeBase<NodeRef, KeyT, N> {
723 const KeyT &stop(unsigned i) const { return this->second[i]; }
724 const NodeRef &subtree(unsigned i) const { return this->first[i]; }
726 KeyT &stop(unsigned i) { return this->second[i]; }
727 NodeRef &subtree(unsigned i) { return this->first[i]; }
729 /// findFrom - Find the first subtree after i that may contain x.
730 /// @param i Starting index for the search.
731 /// @param Size Number of elements in node.
732 /// @param x Key to search for.
733 /// @return First index with !stopLess(key[i], x), or size.
734 /// This is the first subtree that can possibly contain x.
735 unsigned findFrom(unsigned i, unsigned Size, KeyT x) const {
736 assert(i <= Size && Size <= N && "Bad indices");
737 assert((i == 0 || Traits::stopLess(stop(i - 1), x)) &&
738 "Index to findFrom is past the needed point");
739 while (i != Size && Traits::stopLess(stop(i), x)) ++i;
743 /// safeFind - Find a subtree that is known to exist. This is the same as
744 /// findFrom except is it assumed that x is in range.
745 /// @param i Starting index for the search.
746 /// @param x Key to search for.
747 /// @return First index with !stopLess(key[i], x), never size.
748 /// This is the first subtree that can possibly contain x.
749 unsigned safeFind(unsigned i, KeyT x) const {
750 assert(i < N && "Bad index");
751 assert((i == 0 || Traits::stopLess(stop(i - 1), x)) &&
752 "Index is past the needed point");
753 while (Traits::stopLess(stop(i), x)) ++i;
754 assert(i < N && "Unsafe intervals");
758 /// safeLookup - Get the subtree containing x, Assuming that x is in range.
759 /// @param x Key to search for.
760 /// @return Subtree containing x
761 NodeRef safeLookup(KeyT x) const {
762 return subtree(safeFind(0, x));
765 /// insert - Insert a new (subtree, stop) pair.
766 /// @param i Insert position, following entries will be shifted.
767 /// @param Size Number of elements in node.
768 /// @param Node Subtree to insert.
769 /// @param Stop Last key in subtree.
770 void insert(unsigned i, unsigned Size, NodeRef Node, KeyT Stop) {
771 assert(Size < N && "branch node overflow");
772 assert(i <= Size && "Bad insert position");
773 this->shift(i, Size);
779 void dump(raw_ostream &OS, unsigned Size) {
780 OS << " N" << this << " [shape=record label=\"" << Size << '/' << N;
781 for (unsigned i = 0; i != Size; ++i)
782 OS << " | <s" << i << "> " << stop(i);
784 for (unsigned i = 0; i != Size; ++i)
785 OS << " N" << this << ":s" << i << " -> N"
786 << &subtree(i).template get<BranchNode>() << ";\n";
792 //===----------------------------------------------------------------------===//
794 //===----------------------------------------------------------------------===//
796 // A Path is used by iterators to represent a position in a B+-tree, and the
797 // path to get there from the root.
799 // The Path class also constains the tree navigation code that doesn't have to
802 //===----------------------------------------------------------------------===//
805 /// Entry - Each step in the path is a node pointer and an offset into that
812 Entry(void *Node, unsigned Size, unsigned Offset)
813 : node(Node), size(Size), offset(Offset) {}
815 Entry(NodeRef Node, unsigned Offset)
816 : node(&Node.subtree(0)), size(Node.size()), offset(Offset) {}
818 NodeRef &subtree(unsigned i) const {
819 return reinterpret_cast<NodeRef*>(node)[i];
823 /// path - The path entries, path[0] is the root node, path.back() is a leaf.
824 SmallVector<Entry, 4> path;
828 template <typename NodeT> NodeT &node(unsigned Level) const {
829 return *reinterpret_cast<NodeT*>(path[Level].node);
831 unsigned size(unsigned Level) const { return path[Level].size; }
832 unsigned offset(unsigned Level) const { return path[Level].offset; }
833 unsigned &offset(unsigned Level) { return path[Level].offset; }
836 template <typename NodeT> NodeT &leaf() const {
837 return *reinterpret_cast<NodeT*>(path.back().node);
839 unsigned leafSize() const { return path.back().size; }
840 unsigned leafOffset() const { return path.back().offset; }
841 unsigned &leafOffset() { return path.back().offset; }
843 /// valid - Return true if path is at a valid node, not at end().
845 return !path.empty() && path.front().offset < path.front().size;
848 /// height - Return the height of the tree corresponding to this path.
849 /// This matches map->height in a full path.
850 unsigned height() const { return path.size() - 1; }
852 /// subtree - Get the subtree referenced from Level. When the path is
853 /// consistent, node(Level + 1) == subtree(Level).
854 /// @param Level 0..height-1. The leaves have no subtrees.
855 NodeRef &subtree(unsigned Level) const {
856 return path[Level].subtree(path[Level].offset);
859 /// reset - Reset cached information about node(Level) from subtree(Level -1).
860 /// @param Level 1..height. THe node to update after parent node changed.
861 void reset(unsigned Level) {
862 path[Level] = Entry(subtree(Level - 1), offset(Level));
865 /// push - Add entry to path.
866 /// @param Node Node to add, should be subtree(path.size()-1).
867 /// @param Offset Offset into Node.
868 void push(NodeRef Node, unsigned Offset) {
869 path.push_back(Entry(Node, Offset));
872 /// setSize - Set the size of a node both in the path and in the tree.
873 /// @param Level 0..height. Note that setting the root size won't change
875 /// @param Size New node size.
876 void setSize(unsigned Level, unsigned Size) {
877 path[Level].size = Size;
879 subtree(Level - 1).setSize(Size);
882 /// setRoot - Clear the path and set a new root node.
883 /// @param Node New root node.
884 /// @param Size New root size.
885 /// @param Offset Offset into root node.
886 void setRoot(void *Node, unsigned Size, unsigned Offset) {
888 path.push_back(Entry(Node, Size, Offset));
891 /// replaceRoot - Replace the current root node with two new entries after the
892 /// tree height has increased.
893 /// @param Root The new root node.
894 /// @param Size Number of entries in the new root.
895 /// @param Offsets Offsets into the root and first branch nodes.
896 void replaceRoot(void *Root, unsigned Size, IdxPair Offsets);
898 /// getLeftSibling - Get the left sibling node at Level, or a null NodeRef.
899 /// @param Level Get the sibling to node(Level).
900 /// @return Left sibling, or NodeRef().
901 NodeRef getLeftSibling(unsigned Level) const;
903 /// moveLeft - Move path to the left sibling at Level. Leave nodes below Level
905 /// @param Level Move node(Level).
906 void moveLeft(unsigned Level);
908 /// fillLeft - Grow path to Height by taking leftmost branches.
909 /// @param Height The target height.
910 void fillLeft(unsigned Height) {
911 while (height() < Height)
912 push(subtree(height()), 0);
915 /// getLeftSibling - Get the left sibling node at Level, or a null NodeRef.
916 /// @param Level Get the sinbling to node(Level).
917 /// @return Left sibling, or NodeRef().
918 NodeRef getRightSibling(unsigned Level) const;
920 /// moveRight - Move path to the left sibling at Level. Leave nodes below
922 /// @param Level Move node(Level).
923 void moveRight(unsigned Level);
925 /// atBegin - Return true if path is at begin().
926 bool atBegin() const {
927 for (unsigned i = 0, e = path.size(); i != e; ++i)
928 if (path[i].offset != 0)
933 /// atLastBranch - Return true if the path is at the last branch of the node
935 /// @param Level Node to examine.
936 bool atLastBranch(unsigned Level) const {
937 return path[Level].offset == path[Level].size - 1;
940 /// legalizeForInsert - Prepare the path for an insertion at Level. When the
941 /// path is at end(), node(Level) may not be a legal node. legalizeForInsert
942 /// ensures that node(Level) is real by moving back to the last node at Level,
943 /// and setting offset(Level) to size(Level) if required.
944 /// @param Level The level where an insertion is about to take place.
945 void legalizeForInsert(unsigned Level) {
949 ++path[Level].offset;
954 for (unsigned l = 0, e = path.size(); l != e; ++l)
955 errs() << l << ": " << path[l].node << ' ' << path[l].size << ' '
956 << path[l].offset << '\n';
961 } // namespace IntervalMapImpl
964 //===----------------------------------------------------------------------===//
965 //--- IntervalMap ----//
966 //===----------------------------------------------------------------------===//
968 template <typename KeyT, typename ValT,
969 unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize,
970 typename Traits = IntervalMapInfo<KeyT> >
972 typedef IntervalMapImpl::NodeSizer<KeyT, ValT> Sizer;
973 typedef IntervalMapImpl::LeafNode<KeyT, ValT, Sizer::LeafSize, Traits> Leaf;
974 typedef IntervalMapImpl::BranchNode<KeyT, ValT, Sizer::BranchSize, Traits>
976 typedef IntervalMapImpl::LeafNode<KeyT, ValT, N, Traits> RootLeaf;
977 typedef IntervalMapImpl::IdxPair IdxPair;
979 // The RootLeaf capacity is given as a template parameter. We must compute the
980 // corresponding RootBranch capacity.
982 DesiredRootBranchCap = (sizeof(RootLeaf) - sizeof(KeyT)) /
983 (sizeof(KeyT) + sizeof(IntervalMapImpl::NodeRef)),
984 RootBranchCap = DesiredRootBranchCap ? DesiredRootBranchCap : 1
987 typedef IntervalMapImpl::BranchNode<KeyT, ValT, RootBranchCap, Traits>
990 // When branched, we store a global start key as well as the branch node.
991 struct RootBranchData {
997 RootDataSize = sizeof(RootBranchData) > sizeof(RootLeaf) ?
998 sizeof(RootBranchData) : sizeof(RootLeaf)
1002 typedef typename Sizer::Allocator Allocator;
1005 // The root data is either a RootLeaf or a RootBranchData instance.
1006 // We can't put them in a union since C++03 doesn't allow non-trivial
1007 // constructors in unions.
1008 // Instead, we use a char array with pointer alignment. The alignment is
1009 // ensured by the allocator member in the class, but still verified in the
1010 // constructor. We don't support keys or values that are more aligned than a
1012 char data[RootDataSize];
1015 // 0: Leaves in root.
1016 // 1: Root points to leaf.
1017 // 2: root->branch->leaf ...
1020 // Number of entries in the root node.
1023 // Allocator used for creating external nodes.
1024 Allocator &allocator;
1026 /// dataAs - Represent data as a node type without breaking aliasing rules.
1027 template <typename T>
1037 const RootLeaf &rootLeaf() const {
1038 assert(!branched() && "Cannot acces leaf data in branched root");
1039 return dataAs<RootLeaf>();
1041 RootLeaf &rootLeaf() {
1042 assert(!branched() && "Cannot acces leaf data in branched root");
1043 return dataAs<RootLeaf>();
1045 RootBranchData &rootBranchData() const {
1046 assert(branched() && "Cannot access branch data in non-branched root");
1047 return dataAs<RootBranchData>();
1049 RootBranchData &rootBranchData() {
1050 assert(branched() && "Cannot access branch data in non-branched root");
1051 return dataAs<RootBranchData>();
1053 const RootBranch &rootBranch() const { return rootBranchData().node; }
1054 RootBranch &rootBranch() { return rootBranchData().node; }
1055 KeyT rootBranchStart() const { return rootBranchData().start; }
1056 KeyT &rootBranchStart() { return rootBranchData().start; }
1058 template <typename NodeT> NodeT *newNode() {
1059 return new(allocator.template Allocate<NodeT>()) NodeT();
1062 template <typename NodeT> void deleteNode(NodeT *P) {
1064 allocator.Deallocate(P);
1067 IdxPair branchRoot(unsigned Position);
1068 IdxPair splitRoot(unsigned Position);
1070 void switchRootToBranch() {
1071 rootLeaf().~RootLeaf();
1073 new (&rootBranchData()) RootBranchData();
1076 void switchRootToLeaf() {
1077 rootBranchData().~RootBranchData();
1079 new(&rootLeaf()) RootLeaf();
1082 bool branched() const { return height > 0; }
1084 ValT treeSafeLookup(KeyT x, ValT NotFound) const;
1085 void visitNodes(void (IntervalMap::*f)(IntervalMapImpl::NodeRef,
1087 void deleteNode(IntervalMapImpl::NodeRef Node, unsigned Level);
1090 explicit IntervalMap(Allocator &a) : height(0), rootSize(0), allocator(a) {
1091 assert((uintptr_t(data) & (alignOf<RootLeaf>() - 1)) == 0 &&
1092 "Insufficient alignment");
1093 new(&rootLeaf()) RootLeaf();
1098 rootLeaf().~RootLeaf();
1101 /// empty - Return true when no intervals are mapped.
1102 bool empty() const {
1103 return rootSize == 0;
1106 /// start - Return the smallest mapped key in a non-empty map.
1107 KeyT start() const {
1108 assert(!empty() && "Empty IntervalMap has no start");
1109 return !branched() ? rootLeaf().start(0) : rootBranchStart();
1112 /// stop - Return the largest mapped key in a non-empty map.
1114 assert(!empty() && "Empty IntervalMap has no stop");
1115 return !branched() ? rootLeaf().stop(rootSize - 1) :
1116 rootBranch().stop(rootSize - 1);
1119 /// lookup - Return the mapped value at x or NotFound.
1120 ValT lookup(KeyT x, ValT NotFound = ValT()) const {
1121 if (empty() || Traits::startLess(x, start()) || Traits::stopLess(stop(), x))
1123 return branched() ? treeSafeLookup(x, NotFound) :
1124 rootLeaf().safeLookup(x, NotFound);
1127 /// insert - Add a mapping of [a;b] to y, coalesce with adjacent intervals.
1128 /// It is assumed that no key in the interval is mapped to another value, but
1129 /// overlapping intervals already mapped to y will be coalesced.
1130 void insert(KeyT a, KeyT b, ValT y) {
1131 find(a).insert(a, b, y);
1134 /// clear - Remove all entries.
1137 class const_iterator;
1139 friend class const_iterator;
1140 friend class iterator;
1142 const_iterator begin() const {
1154 const_iterator end() const {
1166 /// find - Return an iterator pointing to the first interval ending at or
1167 /// after x, or end().
1168 const_iterator find(KeyT x) const {
1174 iterator find(KeyT x) {
1183 void dumpNode(IntervalMapImpl::NodeRef Node, unsigned Height);
1187 /// treeSafeLookup - Return the mapped value at x or NotFound, assuming a
1189 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1190 ValT IntervalMap<KeyT, ValT, N, Traits>::
1191 treeSafeLookup(KeyT x, ValT NotFound) const {
1192 assert(branched() && "treeLookup assumes a branched root");
1194 IntervalMapImpl::NodeRef NR = rootBranch().safeLookup(x);
1195 for (unsigned h = height-1; h; --h)
1196 NR = NR.get<Branch>().safeLookup(x);
1197 return NR.get<Leaf>().safeLookup(x, NotFound);
1201 // branchRoot - Switch from a leaf root to a branched root.
1202 // Return the new (root offset, node offset) corresponding to Position.
1203 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1204 IntervalMapImpl::IdxPair IntervalMap<KeyT, ValT, N, Traits>::
1205 branchRoot(unsigned Position) {
1206 using namespace IntervalMapImpl;
1207 // How many external leaf nodes to hold RootLeaf+1?
1208 const unsigned Nodes = RootLeaf::Capacity / Leaf::Capacity + 1;
1210 // Compute element distribution among new nodes.
1211 unsigned size[Nodes];
1212 IdxPair NewOffset(0, Position);
1214 // Is is very common for the root node to be smaller than external nodes.
1218 NewOffset = distribute(Nodes, rootSize, Leaf::Capacity, NULL, size,
1221 // Allocate new nodes.
1223 NodeRef node[Nodes];
1224 for (unsigned n = 0; n != Nodes; ++n) {
1225 Leaf *L = newNode<Leaf>();
1226 L->copy(rootLeaf(), pos, 0, size[n]);
1227 node[n] = NodeRef(L, size[n]);
1231 // Destroy the old leaf node, construct branch node instead.
1232 switchRootToBranch();
1233 for (unsigned n = 0; n != Nodes; ++n) {
1234 rootBranch().stop(n) = node[n].template get<Leaf>().stop(size[n]-1);
1235 rootBranch().subtree(n) = node[n];
1237 rootBranchStart() = node[0].template get<Leaf>().start(0);
1242 // splitRoot - Split the current BranchRoot into multiple Branch nodes.
1243 // Return the new (root offset, node offset) corresponding to Position.
1244 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1245 IntervalMapImpl::IdxPair IntervalMap<KeyT, ValT, N, Traits>::
1246 splitRoot(unsigned Position) {
1247 using namespace IntervalMapImpl;
1248 // How many external leaf nodes to hold RootBranch+1?
1249 const unsigned Nodes = RootBranch::Capacity / Branch::Capacity + 1;
1251 // Compute element distribution among new nodes.
1252 unsigned Size[Nodes];
1253 IdxPair NewOffset(0, Position);
1255 // Is is very common for the root node to be smaller than external nodes.
1259 NewOffset = distribute(Nodes, rootSize, Leaf::Capacity, NULL, Size,
1262 // Allocate new nodes.
1264 NodeRef Node[Nodes];
1265 for (unsigned n = 0; n != Nodes; ++n) {
1266 Branch *B = newNode<Branch>();
1267 B->copy(rootBranch(), Pos, 0, Size[n]);
1268 Node[n] = NodeRef(B, Size[n]);
1272 for (unsigned n = 0; n != Nodes; ++n) {
1273 rootBranch().stop(n) = Node[n].template get<Branch>().stop(Size[n]-1);
1274 rootBranch().subtree(n) = Node[n];
1281 /// visitNodes - Visit each external node.
1282 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1283 void IntervalMap<KeyT, ValT, N, Traits>::
1284 visitNodes(void (IntervalMap::*f)(IntervalMapImpl::NodeRef, unsigned Height)) {
1287 SmallVector<IntervalMapImpl::NodeRef, 4> Refs, NextRefs;
1289 // Collect level 0 nodes from the root.
1290 for (unsigned i = 0; i != rootSize; ++i)
1291 Refs.push_back(rootBranch().subtree(i));
1293 // Visit all branch nodes.
1294 for (unsigned h = height - 1; h; --h) {
1295 for (unsigned i = 0, e = Refs.size(); i != e; ++i) {
1296 for (unsigned j = 0, s = Refs[i].size(); j != s; ++j)
1297 NextRefs.push_back(Refs[i].subtree(j));
1298 (this->*f)(Refs[i], h);
1301 Refs.swap(NextRefs);
1304 // Visit all leaf nodes.
1305 for (unsigned i = 0, e = Refs.size(); i != e; ++i)
1306 (this->*f)(Refs[i], 0);
1309 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1310 void IntervalMap<KeyT, ValT, N, Traits>::
1311 deleteNode(IntervalMapImpl::NodeRef Node, unsigned Level) {
1313 deleteNode(&Node.get<Branch>());
1315 deleteNode(&Node.get<Leaf>());
1318 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1319 void IntervalMap<KeyT, ValT, N, Traits>::
1322 visitNodes(&IntervalMap::deleteNode);
1329 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1330 void IntervalMap<KeyT, ValT, N, Traits>::
1331 dumpNode(IntervalMapImpl::NodeRef Node, unsigned Height) {
1333 Node.get<Branch>().dump(*OS, Node.size());
1335 Node.get<Leaf>().dump(*OS, Node.size());
1338 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1339 void IntervalMap<KeyT, ValT, N, Traits>::
1342 raw_fd_ostream ofs("tree.dot", errors);
1344 ofs << "digraph {\n";
1346 rootBranch().dump(ofs, rootSize);
1348 rootLeaf().dump(ofs, rootSize);
1349 visitNodes(&IntervalMap::dumpNode);
1354 //===----------------------------------------------------------------------===//
1355 //--- const_iterator ----//
1356 //===----------------------------------------------------------------------===//
1358 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1359 class IntervalMap<KeyT, ValT, N, Traits>::const_iterator :
1360 public std::iterator<std::bidirectional_iterator_tag, ValT> {
1362 friend class IntervalMap;
1364 // The map referred to.
1367 // We store a full path from the root to the current position.
1368 // The path may be partially filled, but never between iterator calls.
1369 IntervalMapImpl::Path path;
1371 explicit const_iterator(IntervalMap &map) : map(&map) {}
1373 bool branched() const {
1374 assert(map && "Invalid iterator");
1375 return map->branched();
1378 void setRoot(unsigned Offset) {
1380 path.setRoot(&map->rootBranch(), map->rootSize, Offset);
1382 path.setRoot(&map->rootLeaf(), map->rootSize, Offset);
1385 void pathFillFind(KeyT x);
1386 void treeFind(KeyT x);
1389 /// valid - Return true if the current position is valid, false for end().
1390 bool valid() const { return path.valid(); }
1392 /// start - Return the beginning of the current interval.
1393 const KeyT &start() const {
1394 assert(valid() && "Cannot access invalid iterator");
1395 return branched() ? path.leaf<Leaf>().start(path.leafOffset()) :
1396 path.leaf<RootLeaf>().start(path.leafOffset());
1399 /// stop - Return the end of the current interval.
1400 const KeyT &stop() const {
1401 assert(valid() && "Cannot access invalid iterator");
1402 return branched() ? path.leaf<Leaf>().stop(path.leafOffset()) :
1403 path.leaf<RootLeaf>().stop(path.leafOffset());
1406 /// value - Return the mapped value at the current interval.
1407 const ValT &value() const {
1408 assert(valid() && "Cannot access invalid iterator");
1409 return branched() ? path.leaf<Leaf>().value(path.leafOffset()) :
1410 path.leaf<RootLeaf>().value(path.leafOffset());
1413 const ValT &operator*() const {
1417 bool operator==(const const_iterator &RHS) const {
1418 assert(map == RHS.map && "Cannot compare iterators from different maps");
1420 return !RHS.valid();
1421 if (path.leafOffset() != RHS.path.leafOffset())
1423 return &path.template leaf<Leaf>() == &RHS.path.template leaf<Leaf>();
1426 bool operator!=(const const_iterator &RHS) const {
1427 return !operator==(RHS);
1430 /// goToBegin - Move to the first interval in map.
1434 path.fillLeft(map->height);
1437 /// goToEnd - Move beyond the last interval in map.
1439 setRoot(map->rootSize);
1442 /// preincrement - move to the next interval.
1443 const_iterator &operator++() {
1444 assert(valid() && "Cannot increment end()");
1445 if (++path.leafOffset() == path.leafSize() && branched())
1446 path.moveRight(map->height);
1450 /// postincrement - Dont do that!
1451 const_iterator operator++(int) {
1452 const_iterator tmp = *this;
1457 /// predecrement - move to the previous interval.
1458 const_iterator &operator--() {
1459 if (path.leafOffset() && (valid() || !branched()))
1460 --path.leafOffset();
1462 path.moveLeft(map->height);
1466 /// postdecrement - Dont do that!
1467 const_iterator operator--(int) {
1468 const_iterator tmp = *this;
1473 /// find - Move to the first interval with stop >= x, or end().
1474 /// This is a full search from the root, the current position is ignored.
1479 setRoot(map->rootLeaf().findFrom(0, map->rootSize, x));
1482 /// advanceTo - Move to the first interval with stop >= x, or end().
1483 /// The search is started from the current position, and no earlier positions
1484 /// can be found. This is much faster than find() for small moves.
1485 void advanceTo(KeyT x) {
1490 map->rootLeaf().findFrom(path.leafOffset(), map->rootSize, x);
1495 // pathFillFind - Complete path by searching for x.
1496 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1497 void IntervalMap<KeyT, ValT, N, Traits>::
1498 const_iterator::pathFillFind(KeyT x) {
1499 IntervalMapImpl::NodeRef NR = path.subtree(path.height());
1500 for (unsigned i = map->height - path.height() - 1; i; --i) {
1501 unsigned p = NR.get<Branch>().safeFind(0, x);
1505 path.push(NR, NR.get<Leaf>().safeFind(0, x));
1508 // treeFind - Find in a branched tree.
1509 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1510 void IntervalMap<KeyT, ValT, N, Traits>::
1511 const_iterator::treeFind(KeyT x) {
1512 setRoot(map->rootBranch().findFrom(0, map->rootSize, x));
1518 //===----------------------------------------------------------------------===//
1519 //--- iterator ----//
1520 //===----------------------------------------------------------------------===//
1522 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1523 class IntervalMap<KeyT, ValT, N, Traits>::iterator : public const_iterator {
1524 friend class IntervalMap;
1525 typedef IntervalMapImpl::IdxPair IdxPair;
1527 explicit iterator(IntervalMap &map) : const_iterator(map) {}
1529 void setNodeStop(unsigned Level, KeyT Stop);
1530 bool insertNode(unsigned Level, IntervalMapImpl::NodeRef Node, KeyT Stop);
1531 template <typename NodeT> bool overflow(unsigned Level);
1532 void treeInsert(KeyT a, KeyT b, ValT y);
1533 void eraseNode(unsigned Level);
1534 void treeErase(bool UpdateRoot = true);
1536 /// insert - Insert mapping [a;b] -> y before the current position.
1537 void insert(KeyT a, KeyT b, ValT y);
1539 /// erase - Erase the current interval.
1542 iterator &operator++() {
1543 const_iterator::operator++();
1547 iterator operator++(int) {
1548 iterator tmp = *this;
1553 iterator &operator--() {
1554 const_iterator::operator--();
1558 iterator operator--(int) {
1559 iterator tmp = *this;
1566 /// setNodeStop - Update the stop key of the current node at level and above.
1567 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1568 void IntervalMap<KeyT, ValT, N, Traits>::
1569 iterator::setNodeStop(unsigned Level, KeyT Stop) {
1570 // There are no references to the root node, so nothing to update.
1573 IntervalMapImpl::Path &P = this->path;
1574 // Update nodes pointing to the current node.
1576 P.node<Branch>(Level).stop(P.offset(Level)) = Stop;
1577 if (!P.atLastBranch(Level))
1580 // Update root separately since it has a different layout.
1581 P.node<RootBranch>(Level).stop(P.offset(Level)) = Stop;
1584 /// insertNode - insert a node before the current path at level.
1585 /// Leave the current path pointing at the new node.
1586 /// @param Level path index of the node to be inserted.
1587 /// @param Node The node to be inserted.
1588 /// @param Stop The last index in the new node.
1589 /// @return True if the tree height was increased.
1590 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1591 bool IntervalMap<KeyT, ValT, N, Traits>::
1592 iterator::insertNode(unsigned Level, IntervalMapImpl::NodeRef Node, KeyT Stop) {
1593 assert(Level && "Cannot insert next to the root");
1594 bool SplitRoot = false;
1595 IntervalMap &IM = *this->map;
1596 IntervalMapImpl::Path &P = this->path;
1599 // Insert into the root branch node.
1600 if (IM.rootSize < RootBranch::Capacity) {
1601 IM.rootBranch().insert(P.offset(0), IM.rootSize, Node, Stop);
1602 P.setSize(0, ++IM.rootSize);
1607 // We need to split the root while keeping our position.
1609 IdxPair Offset = IM.splitRoot(P.offset(0));
1610 P.replaceRoot(&IM.rootBranch(), IM.rootSize, Offset);
1612 // Fall through to insert at the new higher level.
1616 // When inserting before end(), make sure we have a valid path.
1617 P.legalizeForInsert(--Level);
1619 // Insert into the branch node at Level-1.
1620 if (P.size(Level) == Branch::Capacity) {
1621 // Branch node is full, handle handle the overflow.
1622 assert(!SplitRoot && "Cannot overflow after splitting the root");
1623 SplitRoot = overflow<Branch>(Level);
1626 P.node<Branch>(Level).insert(P.offset(Level), P.size(Level), Node, Stop);
1627 P.setSize(Level, P.size(Level) + 1);
1628 if (P.atLastBranch(Level))
1629 setNodeStop(Level, Stop);
1635 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1636 void IntervalMap<KeyT, ValT, N, Traits>::
1637 iterator::insert(KeyT a, KeyT b, ValT y) {
1638 if (this->branched())
1639 return treeInsert(a, b, y);
1640 IntervalMap &IM = *this->map;
1641 IntervalMapImpl::Path &P = this->path;
1643 // Try simple root leaf insert.
1644 IdxPair IP = IM.rootLeaf().insertFrom(P.leafOffset(), IM.rootSize, a, b, y);
1646 // Was the root node insert successful?
1647 if (IP.second <= RootLeaf::Capacity) {
1648 P.leafOffset() = IP.first;
1649 P.setSize(0, IM.rootSize = IP.second);
1653 // Root leaf node is full, we must branch.
1654 IdxPair Offset = IM.branchRoot(P.leafOffset());
1655 P.replaceRoot(&IM.rootBranch(), IM.rootSize, Offset);
1657 // Now it fits in the new leaf.
1658 treeInsert(a, b, y);
1662 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1663 void IntervalMap<KeyT, ValT, N, Traits>::
1664 iterator::treeInsert(KeyT a, KeyT b, ValT y) {
1665 using namespace IntervalMapImpl;
1666 IntervalMap &IM = *this->map;
1667 Path &P = this->path;
1669 // Check if this insertion will extend the node to the left.
1670 if (P.valid() && P.leafOffset() == 0 &&
1671 Traits::startLess(a, P.leaf<Leaf>().start(0))) {
1672 // Node is growing to the left, will it affect a left sibling node?
1673 if (NodeRef Sib = P.getLeftSibling(IM.height)) {
1674 Leaf &SibLeaf = Sib.get<Leaf>();
1675 unsigned SibOfs = Sib.size() - 1;
1676 if (SibLeaf.value(SibOfs) == y &&
1677 Traits::adjacent(SibLeaf.stop(SibOfs), a)) {
1678 // This insertion will coalesce with the last entry in SibLeaf. We can
1679 // handle it in two ways:
1680 // 1. Extend SibLeaf.stop to b and be done, or
1681 // 2. Extend a to SibLeaf, erase the SibLeaf entry and continue.
1682 // We prefer 1., but need 2 when coalescing to the right as well.
1683 Leaf &CurLeaf = P.leaf<Leaf>();
1684 P.moveLeft(IM.height);
1685 if (Traits::stopLess(b, CurLeaf.start(0)) &&
1686 (y != CurLeaf.value(0) || !Traits::adjacent(b, CurLeaf.start(0)))) {
1687 // Easy, just extend SibLeaf and we're done.
1688 setNodeStop(IM.height, SibLeaf.stop(SibOfs) = b);
1691 // We have both left and right coalescing. Erase the old SibLeaf entry
1692 // and continue inserting the larger interval.
1693 a = SibLeaf.start(SibOfs);
1694 treeErase(/* UpdateRoot= */false);
1698 // No left sibling means we are at begin(). Update cached bound.
1699 IM.rootBranchStart() = a;
1703 P.legalizeForInsert(IM.height);
1704 IdxPair IP = P.leaf<Leaf>().insertFrom(P.leafOffset(), P.leafSize(), a, b, y);
1706 // Leaf insertion unsuccessful? Overflow and try again.
1707 if (IP.second > Leaf::Capacity) {
1708 overflow<Leaf>(IM.height);
1709 IP = P.leaf<Leaf>().insertFrom(P.leafOffset(), P.leafSize(), a, b, y);
1710 assert(IP.second <= Leaf::Capacity && "overflow() didn't make room");
1713 // Inserted, update offset and leaf size.
1714 P.leafOffset() = IP.first;
1715 P.setSize(IM.height, IP.second);
1717 // Insert was the last node entry, update stops.
1718 if (IP.first == IP.second - 1)
1719 setNodeStop(IM.height, P.leaf<Leaf>().stop(IP.first));
1722 /// erase - erase the current interval and move to the next position.
1723 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1724 void IntervalMap<KeyT, ValT, N, Traits>::
1726 IntervalMap &IM = *this->map;
1727 IntervalMapImpl::Path &P = this->path;
1728 assert(P.valid() && "Cannot erase end()");
1729 if (this->branched())
1731 IM.rootLeaf().erase(P.leafOffset(), IM.rootSize);
1732 P.setSize(0, --IM.rootSize);
1735 /// treeErase - erase() for a branched tree.
1736 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1737 void IntervalMap<KeyT, ValT, N, Traits>::
1738 iterator::treeErase(bool UpdateRoot) {
1739 IntervalMap &IM = *this->map;
1740 IntervalMapImpl::Path &P = this->path;
1741 Leaf &Node = P.leaf<Leaf>();
1743 // Nodes are not allowed to become empty.
1744 if (P.leafSize() == 1) {
1745 IM.deleteNode(&Node);
1746 eraseNode(IM.height);
1747 // Update rootBranchStart if we erased begin().
1748 if (UpdateRoot && IM.branched() && P.valid() && P.atBegin())
1749 IM.rootBranchStart() = P.leaf<Leaf>().start(0);
1753 // Erase current entry.
1754 Node.erase(P.leafOffset(), P.leafSize());
1755 unsigned NewSize = P.leafSize() - 1;
1756 P.setSize(IM.height, NewSize);
1757 // When we erase the last entry, update stop and move to a legal position.
1758 if (P.leafOffset() == NewSize) {
1759 setNodeStop(IM.height, Node.stop(NewSize - 1));
1760 P.moveRight(IM.height);
1761 } else if (UpdateRoot && P.atBegin())
1762 IM.rootBranchStart() = P.leaf<Leaf>().start(0);
1765 /// eraseNode - Erase the current node at Level from its parent and move path to
1766 /// the first entry of the next sibling node.
1767 /// The node must be deallocated by the caller.
1768 /// @param Level 1..height, the root node cannot be erased.
1769 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1770 void IntervalMap<KeyT, ValT, N, Traits>::
1771 iterator::eraseNode(unsigned Level) {
1772 assert(Level && "Cannot erase root node");
1773 IntervalMap &IM = *this->map;
1774 IntervalMapImpl::Path &P = this->path;
1777 IM.rootBranch().erase(P.offset(0), IM.rootSize);
1778 P.setSize(0, --IM.rootSize);
1779 // If this cleared the root, switch to height=0.
1781 IM.switchRootToLeaf();
1786 // Remove node ref from branch node at Level.
1787 Branch &Parent = P.node<Branch>(Level);
1788 if (P.size(Level) == 1) {
1789 // Branch node became empty, remove it recursively.
1790 IM.deleteNode(&Parent);
1793 // Branch node won't become empty.
1794 Parent.erase(P.offset(Level), P.size(Level));
1795 unsigned NewSize = P.size(Level) - 1;
1796 P.setSize(Level, NewSize);
1797 // If we removed the last branch, update stop and move to a legal pos.
1798 if (P.offset(Level) == NewSize) {
1799 setNodeStop(Level, Parent.stop(NewSize - 1));
1804 // Update path cache for the new right sibling position.
1807 P.offset(Level + 1) = 0;
1811 /// overflow - Distribute entries of the current node evenly among
1812 /// its siblings and ensure that the current node is not full.
1813 /// This may require allocating a new node.
1814 /// @param NodeT The type of node at Level (Leaf or Branch).
1815 /// @param Level path index of the overflowing node.
1816 /// @return True when the tree height was changed.
1817 template <typename KeyT, typename ValT, unsigned N, typename Traits>
1818 template <typename NodeT>
1819 bool IntervalMap<KeyT, ValT, N, Traits>::
1820 iterator::overflow(unsigned Level) {
1821 using namespace IntervalMapImpl;
1822 Path &P = this->path;
1823 unsigned CurSize[4];
1826 unsigned Elements = 0;
1827 unsigned Offset = P.offset(Level);
1829 // Do we have a left sibling?
1830 NodeRef LeftSib = P.getLeftSibling(Level);
1832 Offset += Elements = CurSize[Nodes] = LeftSib.size();
1833 Node[Nodes++] = &LeftSib.get<NodeT>();
1837 Elements += CurSize[Nodes] = P.size(Level);
1838 Node[Nodes++] = &P.node<NodeT>(Level);
1840 // Do we have a right sibling?
1841 NodeRef RightSib = P.getRightSibling(Level);
1843 Elements += CurSize[Nodes] = RightSib.size();
1844 Node[Nodes++] = &RightSib.get<NodeT>();
1847 // Do we need to allocate a new node?
1848 unsigned NewNode = 0;
1849 if (Elements + 1 > Nodes * NodeT::Capacity) {
1850 // Insert NewNode at the penultimate position, or after a single node.
1851 NewNode = Nodes == 1 ? 1 : Nodes - 1;
1852 CurSize[Nodes] = CurSize[NewNode];
1853 Node[Nodes] = Node[NewNode];
1854 CurSize[NewNode] = 0;
1855 Node[NewNode] = this->map->newNode<NodeT>();
1859 // Compute the new element distribution.
1860 unsigned NewSize[4];
1861 IdxPair NewOffset = distribute(Nodes, Elements, NodeT::Capacity,
1862 CurSize, NewSize, Offset, true);
1863 adjustSiblingSizes(Node, Nodes, CurSize, NewSize);
1865 // Move current location to the leftmost node.
1869 // Elements have been rearranged, now update node sizes and stops.
1870 bool SplitRoot = false;
1873 KeyT Stop = Node[Pos]->stop(NewSize[Pos]-1);
1874 if (NewNode && Pos == NewNode) {
1875 SplitRoot = insertNode(Level, NodeRef(Node[Pos], NewSize[Pos]), Stop);
1878 P.setSize(Level, NewSize[Pos]);
1879 setNodeStop(Level, Stop);
1881 if (Pos + 1 == Nodes)
1887 // Where was I? Find NewOffset.
1888 while(Pos != NewOffset.first) {
1892 P.offset(Level) = NewOffset.second;