include/llvm/ADT/ImmutableIntervalMap.h

   1 //===--- ImmutableIntervalMap.h - Immutable (functional) map  ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the ImmutableIntervalMap class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13 #include "llvm/ADT/ImmutableMap.h"
  14
  15 namespace llvm {
  16
  17 class Interval {
  18 private:
  19   uint64_t Start;
  20   uint64_t End;
  21
  22 public:
  23   Interval(uint64_t S, uint64_t E) : Start(S), End(E) {}
  24
  25   uint64_t getStart() const { return Start; }
  26   uint64_t getEnd() const { return End; }
  27 };
  28
  29 template <typename T>
  30 struct ImutIntervalInfo {
  31   typedef const std::pair<Interval, T> value_type;
  32   typedef const value_type &value_type_ref;
  33   typedef const Interval key_type;
  34   typedef const Interval &key_type_ref;
  35   typedef const T data_type;
  36   typedef const T &data_type_ref;
  37
  38   static key_type_ref KeyOfValue(value_type_ref V) {
  39     return V.first;
  40   }
  41
  42   static data_type_ref DataOfValue(value_type_ref V) {
  43     return V.second;
  44   }
  45
  46   static bool isEqual(key_type_ref L, key_type_ref R) {
  47     return L.getStart() == R.getStart() && L.getEnd() == R.getEnd();
  48   }
  49
  50   static bool isDataEqual(data_type_ref L, data_type_ref R) {
  51     return ImutContainerInfo<T>::isEqual(L,R);
  52   }
  53
  54   static bool isLess(key_type_ref L, key_type_ref R) {
  55     // Assume L and R does not overlap.
  56     if (L.getStart() < R.getStart()) {
  57       assert(L.getEnd() < R.getStart());
  58       return true;
  59     } else if (L.getStart() == R.getStart()) {
  60       assert(L.getEnd() == R.getEnd());
  61       return false;
  62     } else {
  63       assert(L.getStart() > R.getEnd());
  64       return false;
  65     }
  66   }
  67
  68   static bool isContainedIn(key_type_ref K, key_type_ref L) {
  69     if (K.getStart() >= L.getStart() && K.getEnd() <= L.getEnd())
  70       return true;
  71     else
  72       return false;
  73   }
  74
  75   static void Profile(FoldingSetNodeID &ID, value_type_ref V) {
  76     ID.AddInteger(V.first.getStart());
  77     ID.AddInteger(V.first.getEnd());
  78     ImutProfileInfo<T>::Profile(ID, V.second);
  79   }
  80 };
  81
  82 template <typename ImutInfo> class ImutIntervalAVLFactory;
  83
  84 template <typename ImutInfo>
  85 class ImutIntervalAVLFactory : public ImutAVLFactory<ImutInfo> {
  86   typedef ImutAVLTree<ImutInfo> TreeTy;
  87   typedef typename ImutInfo::value_type     value_type;
  88   typedef typename ImutInfo::value_type_ref value_type_ref;
  89   typedef typename ImutInfo::key_type       key_type;
  90   typedef typename ImutInfo::key_type_ref   key_type_ref;
  91   typedef typename ImutInfo::data_type      data_type;
  92   typedef typename ImutInfo::data_type_ref  data_type_ref;
  93
  94 public:
  95   TreeTy *Add(TreeTy *T, value_type_ref V) {
  96     T = Add_internal(V,T);
  97     MarkImmutable(T);
  98     return T;
  99   }
 100
 101   TreeTy *Find(TreeTy *T, key_type_ref K) {
 102     if (!T)
 103       return NULL;
 104
 105     key_type_ref CurrentKey = ImutInfo::KeyOfValue(Value(T));
 106
 107     if (ImutInfo::isContainedIn(K, CurrentKey))
 108       return T;
 109     else if (ImutInfo::isLess(K, CurrentKey))
 110       return Find(Left(T), K);
 111     else
 112       return Find(Right(T), K);
 113   }
 114
 115 private:
 116   TreeTy *Add_internal(value_type_ref V, TreeTy *T) {
 117     key_type_ref K = ImutInfo::KeyOfValue(V);
 118     T = RemoveAllOverlaps(T, K);
 119     if (isEmpty(T))
 120       return CreateNode(NULL, V, NULL);
 121
 122     assert(!T->isMutable());
 123
 124     key_type_ref KCurrent = ImutInfo::KeyOfValue(Value(T));
 125
 126     if (ImutInfo::isLess(K, KCurrent))
 127       return Balance(Add_internal(V, Left(T)), Value(T), Right(T));
 128     else
 129       return Balance(Left(T), Value(T), Add_internal(V, Right(T)));
 130   }
 131
 132   // Remove all overlaps from T.
 133   TreeTy *RemoveAllOverlaps(TreeTy *T, key_type_ref K) {
 134     bool Changed;
 135     do {
 136       Changed = false;
 137       T = RemoveOverlap(T, K, Changed);
 138       MarkImmutable(T);
 139     } while (Changed);
 140
 141     return T;
 142   }
 143
 144   // Remove one overlap from T.
 145   TreeTy *RemoveOverlap(TreeTy *T, key_type_ref K, bool &Changed) {
 146     if (!T)
 147       return NULL;
 148     Interval CurrentK = ImutInfo::KeyOfValue(Value(T));
 149
 150     // If current key does not overlap the inserted key.
 151     if (CurrentK.getStart() > K.getEnd())
 152       return Balance(RemoveOverlap(Left(T), K, Changed), Value(T), Right(T));
 153     else if (CurrentK.getEnd() < K.getStart())
 154       return Balance(Left(T), Value(T), RemoveOverlap(Right(T), K, Changed));
 155
 156     // Current key overlaps with the inserted key.
 157     // Remove the current key.
 158     Changed = true;
 159     data_type_ref OldData = ImutInfo::DataOfValue(Value(T));
 160     T = Remove_internal(CurrentK, T);
 161     // Add back the unoverlapped part of the current key.
 162     if (CurrentK.getStart() < K.getStart()) {
 163       if (CurrentK.getEnd() <= K.getEnd()) {
 164         Interval NewK(CurrentK.getStart(), K.getStart()-1);
 165         return Add_internal(std::make_pair(NewK, OldData), T);
 166       } else {
 167         Interval NewK1(CurrentK.getStart(), K.getStart()-1);
 168         T = Add_internal(std::make_pair(NewK1, OldData), T);
 169
 170
 171         Interval NewK2(K.getEnd()+1, CurrentK.getEnd());
 172         return Add_internal(std::make_pair(NewK2, OldData), T);
 173       }
 174     } else {
 175       if (CurrentK.getEnd() > K.getEnd()) {
 176         Interval NewK(K.getEnd()+1, CurrentK.getEnd());
 177         return Add_internal(std::make_pair(NewK, OldData), T);
 178       }
 179     }
 180   }
 181 };
 182
 183 /// ImmutableIntervalMap maps an interval [start, end] to a value. The intervals
 184 /// in the map are guaranteed to be disjoint.
 185 template <typename ValT>
 186 class ImmutableIntervalMap
 187   : public ImmutableMap<Interval, ValT, ImutIntervalInfo<ValT> > {
 188
 189   typedef typename ImutIntervalInfo<ValT>::value_type      value_type;
 190   typedef typename ImutIntervalInfo<ValT>::value_type_ref  value_type_ref;
 191   typedef typename ImutIntervalInfo<ValT>::key_type        key_type;
 192   typedef typename ImutIntervalInfo<ValT>::key_type_ref    key_type_ref;
 193   typedef typename ImutIntervalInfo<ValT>::data_type       data_type;
 194   typedef typename ImutIntervalInfo<ValT>::data_type_ref   data_type_ref;
 195   typedef ImutAVLTree<ImutIntervalInfo<ValT> > TreeTy;
 196
 197 public:
 198   explicit ImmutableIntervalMap(TreeTy *R)
 199     : ImmutableMap<Interval, ValT, ImutIntervalInfo<ValT> >(R) {}
 200
 201   class Factory {
 202     ImutIntervalAVLFactory<ImutIntervalInfo<ValT> > F;
 203
 204   public:
 205     ImmutableIntervalMap GetEmptyMap() {
 206       return ImmutableIntervalMap(F.GetEmptyTree());
 207     }
 208
 209     ImmutableIntervalMap Add(ImmutableIntervalMap Old,
 210                              key_type_ref K, data_type_ref D) {
 211       TreeTy *T = F.Add(Old.Root, std::make_pair<key_type, data_type>(K, D));
 212       return ImmutableIntervalMap(F.GetCanonicalTree(T));
 213     }
 214
 215     ImmutableIntervalMap Remove(ImmutableIntervalMap Old, key_type_ref K) {
 216       TreeTy *T = F.Remove(Old.Root, K);
 217       return ImmutableIntervalMap(F.GetCanonicalTree(T));
 218     }
 219
 220     data_type *Lookup(ImmutableIntervalMap M, key_type_ref K) {
 221       TreeTy *T = F.Find(M.getRoot(), K);
 222       if (T)
 223         return &T->getValue().second;
 224       else
 225         return 0;
 226     }
 227
 228   };
 229
 230 private:
 231   // For ImmutableIntervalMap, the lookup operation has to be done by the
 232   // factory.
 233   data_type* lookup(key_type_ref K) const;
 234 };
 235
 236 } // end namespace llvm