include/llvm/ADT/MapVector.h

   1 //===- llvm/ADT/MapVector.h - Map w/ deterministic value order --*- 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 implements a map that provides insertion order iteration. The
  11 // interface is purposefully minimal. The key is assumed to be cheap to copy
  12 // and 2 copies are kept, one for indexing in a DenseMap, one for iteration in
  13 // a std::vector.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_ADT_MAPVECTOR_H
  18 #define LLVM_ADT_MAPVECTOR_H
  19
  20 #include "llvm/ADT/DenseMap.h"
  21 #include <vector>
  22
  23 namespace llvm {
  24
  25 /// This class implements a map that also provides access to all stored values
  26 /// in a deterministic order. The values are kept in a std::vector and the
  27 /// mapping is done with DenseMap from Keys to indexes in that vector.
  28 template<typename KeyT, typename ValueT,
  29          typename MapType = llvm::DenseMap<KeyT, unsigned>,
  30          typename VectorType = std::vector<std::pair<KeyT, ValueT> > >
  31 class MapVector {
  32   typedef typename VectorType::size_type size_type;
  33
  34   MapType Map;
  35   VectorType Vector;
  36
  37 public:
  38   typedef typename VectorType::iterator iterator;
  39   typedef typename VectorType::const_iterator const_iterator;
  40   typedef typename VectorType::reverse_iterator reverse_iterator;
  41   typedef typename VectorType::const_reverse_iterator const_reverse_iterator;
  42
  43   size_type size() const { return Vector.size(); }
  44
  45   iterator begin() { return Vector.begin(); }
  46   const_iterator begin() const { return Vector.begin(); }
  47   iterator end() { return Vector.end(); }
  48   const_iterator end() const { return Vector.end(); }
  49
  50   reverse_iterator rbegin() { return Vector.rbegin(); }
  51   const_reverse_iterator rbegin() const { return Vector.rbegin(); }
  52   reverse_iterator rend() { return Vector.rend(); }
  53   const_reverse_iterator rend() const { return Vector.rend(); }
  54
  55   bool empty() const {
  56     return Vector.empty();
  57   }
  58
  59   std::pair<KeyT, ValueT>       &front()       { return Vector.front(); }
  60   const std::pair<KeyT, ValueT> &front() const { return Vector.front(); }
  61   std::pair<KeyT, ValueT>       &back()        { return Vector.back(); }
  62   const std::pair<KeyT, ValueT> &back()  const { return Vector.back(); }
  63
  64   void clear() {
  65     Map.clear();
  66     Vector.clear();
  67   }
  68
  69   ValueT &operator[](const KeyT &Key) {
  70     std::pair<KeyT, unsigned> Pair = std::make_pair(Key, 0);
  71     std::pair<typename MapType::iterator, bool> Result = Map.insert(Pair);
  72     unsigned &I = Result.first->second;
  73     if (Result.second) {
  74       Vector.push_back(std::make_pair(Key, ValueT()));
  75       I = Vector.size() - 1;
  76     }
  77     return Vector[I].second;
  78   }
  79
  80   ValueT lookup(const KeyT &Key) const {
  81     typename MapType::const_iterator Pos = Map.find(Key);
  82     return Pos == Map.end()? ValueT() : Vector[Pos->second].second;
  83   }
  84
  85   std::pair<iterator, bool> insert(const std::pair<KeyT, ValueT> &KV) {
  86     std::pair<KeyT, unsigned> Pair = std::make_pair(KV.first, 0);
  87     std::pair<typename MapType::iterator, bool> Result = Map.insert(Pair);
  88     unsigned &I = Result.first->second;
  89     if (Result.second) {
  90       Vector.push_back(std::make_pair(KV.first, KV.second));
  91       I = Vector.size() - 1;
  92       return std::make_pair(std::prev(end()), true);
  93     }
  94     return std::make_pair(begin() + I, false);
  95   }
  96
  97   size_type count(const KeyT &Key) const {
  98     typename MapType::const_iterator Pos = Map.find(Key);
  99     return Pos == Map.end()? 0 : 1;
 100   }
 101
 102   iterator find(const KeyT &Key) {
 103     typename MapType::const_iterator Pos = Map.find(Key);
 104     return Pos == Map.end()? Vector.end() :
 105                             (Vector.begin() + Pos->second);
 106   }
 107
 108   const_iterator find(const KeyT &Key) const {
 109     typename MapType::const_iterator Pos = Map.find(Key);
 110     return Pos == Map.end()? Vector.end() :
 111                             (Vector.begin() + Pos->second);
 112   }
 113
 114   /// \brief Remove the last element from the vector.
 115   void pop_back() {
 116     typename MapType::iterator Pos = Map.find(Vector.back().first);
 117     Map.erase(Pos);
 118     Vector.pop_back();
 119   }
 120
 121   /// \brief Remove the element given by Iterator.
 122   ///
 123   /// Returns an iterator to the element following the one which was removed,
 124   /// which may be end().
 125   ///
 126   /// \note This is a deceivingly expensive operation (linear time).  It's
 127   /// usually better to use \a remove_if() if possible.
 128   typename VectorType::iterator erase(typename VectorType::iterator Iterator) {
 129     Map.erase(Iterator->first);
 130     auto Next = Vector.erase(Iterator);
 131     if (Next == Vector.end())
 132       return Next;
 133
 134     // Update indices in the map.
 135     size_t Index = Next - Vector.begin();
 136     for (auto &I : Map) {
 137       assert(I.second != Index && "Index was already erased!");
 138       if (I.second > Index)
 139         --I.second;
 140     }
 141     return Next;
 142   }
 143
 144   /// \brief Remove all elements with the key value Key.
 145   ///
 146   /// Returns the number of elements removed.
 147   size_type erase(const KeyT &Key) {
 148     auto Iterator = find(Key);
 149     if (Iterator == end())
 150       return 0;
 151     erase(Iterator);
 152     return 1;
 153   }
 154
 155   /// \brief Remove the elements that match the predicate.
 156   ///
 157   /// Erase all elements that match \c Pred in a single pass.  Takes linear
 158   /// time.
 159   template <class Predicate> void remove_if(Predicate Pred);
 160 };
 161
 162 template <typename KeyT, typename ValueT, typename MapType, typename VectorType>
 163 template <class Function>
 164 void MapVector<KeyT, ValueT, MapType, VectorType>::remove_if(Function Pred) {
 165   auto O = Vector.begin();
 166   for (auto I = O, E = Vector.end(); I != E; ++I) {
 167     if (Pred(*I)) {
 168       // Erase from the map.
 169       Map.erase(I->first);
 170       continue;
 171     }
 172
 173     if (I != O) {
 174       // Move the value and update the index in the map.
 175       *O = std::move(*I);
 176       Map[O->first] = O - Vector.begin();
 177     }
 178     ++O;
 179   }
 180   // Erase trailing entries in the vector.
 181   Vector.erase(O, Vector.end());
 182 }
 183
 184 } // end namespace llvm
 185
 186 #endif