include/llvm/ADT/SetVector.h

   1 //===- llvm/ADT/SetVector.h - Set with insert order iteration ---*- 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 set that has insertion order iteration
  11 // characteristics. This is useful for keeping a set of things that need to be
  12 // visited later but in a deterministic order (insertion order). The interface
  13 // is purposefully minimal.
  14 //
  15 // This file defines SetVector and SmallSetVector, which performs no allocations
  16 // if the SetVector has less than a certain number of elements.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_ADT_SETVECTOR_H
  21 #define LLVM_ADT_SETVECTOR_H
  22
  23 #include "llvm/ADT/SmallSet.h"
  24 #include <algorithm>
  25 #include <cassert>
  26 #include <vector>
  27
  28 namespace llvm {
  29
  30 /// \brief A vector that has set insertion semantics.
  31 ///
  32 /// This adapter class provides a way to keep a set of things that also has the
  33 /// property of a deterministic iteration order. The order of iteration is the
  34 /// order of insertion.
  35 template <typename T, typename Vector = std::vector<T>,
  36                       typename Set = SmallSet<T, 16> >
  37 class SetVector {
  38 public:
  39   typedef T value_type;
  40   typedef T key_type;
  41   typedef T& reference;
  42   typedef const T& const_reference;
  43   typedef Set set_type;
  44   typedef Vector vector_type;
  45   typedef typename vector_type::const_iterator iterator;
  46   typedef typename vector_type::const_iterator const_iterator;
  47   typedef typename vector_type::const_reverse_iterator reverse_iterator;
  48   typedef typename vector_type::const_reverse_iterator const_reverse_iterator;
  49   typedef typename vector_type::size_type size_type;
  50
  51   /// \brief Construct an empty SetVector
  52   SetVector() {}
  53
  54   /// \brief Initialize a SetVector with a range of elements
  55   template<typename It>
  56   SetVector(It Start, It End) {
  57     insert(Start, End);
  58   }
  59
  60   /// \brief Determine if the SetVector is empty or not.
  61   bool empty() const {
  62     return vector_.empty();
  63   }
  64
  65   /// \brief Determine the number of elements in the SetVector.
  66   size_type size() const {
  67     return vector_.size();
  68   }
  69
  70   /// \brief Get an iterator to the beginning of the SetVector.
  71   iterator begin() {
  72     return vector_.begin();
  73   }
  74
  75   /// \brief Get a const_iterator to the beginning of the SetVector.
  76   const_iterator begin() const {
  77     return vector_.begin();
  78   }
  79
  80   /// \brief Get an iterator to the end of the SetVector.
  81   iterator end() {
  82     return vector_.end();
  83   }
  84
  85   /// \brief Get a const_iterator to the end of the SetVector.
  86   const_iterator end() const {
  87     return vector_.end();
  88   }
  89
  90   /// \brief Get an reverse_iterator to the end of the SetVector.
  91   reverse_iterator rbegin() {
  92     return vector_.rbegin();
  93   }
  94
  95   /// \brief Get a const_reverse_iterator to the end of the SetVector.
  96   const_reverse_iterator rbegin() const {
  97     return vector_.rbegin();
  98   }
  99
 100   /// \brief Get a reverse_iterator to the beginning of the SetVector.
 101   reverse_iterator rend() {
 102     return vector_.rend();
 103   }
 104
 105   /// \brief Get a const_reverse_iterator to the beginning of the SetVector.
 106   const_reverse_iterator rend() const {
 107     return vector_.rend();
 108   }
 109
 110   /// \brief Return the last element of the SetVector.
 111   const T &back() const {
 112     assert(!empty() && "Cannot call back() on empty SetVector!");
 113     return vector_.back();
 114   }
 115
 116   /// \brief Index into the SetVector.
 117   const_reference operator[](size_type n) const {
 118     assert(n < vector_.size() && "SetVector access out of range!");
 119     return vector_[n];
 120   }
 121
 122   /// \brief Insert a new element into the SetVector.
 123   /// \returns true iff the element was inserted into the SetVector.
 124   bool insert(const value_type &X) {
 125     bool result = set_.insert(X).second;
 126     if (result)
 127       vector_.push_back(X);
 128     return result;
 129   }
 130
 131   /// \brief Insert a range of elements into the SetVector.
 132   template<typename It>
 133   void insert(It Start, It End) {
 134     for (; Start != End; ++Start)
 135       if (set_.insert(*Start).second)
 136         vector_.push_back(*Start);
 137   }
 138
 139   /// \brief Remove an item from the set vector.
 140   bool remove(const value_type& X) {
 141     if (set_.erase(X)) {
 142       typename vector_type::iterator I =
 143         std::find(vector_.begin(), vector_.end(), X);
 144       assert(I != vector_.end() && "Corrupted SetVector instances!");
 145       vector_.erase(I);
 146       return true;
 147     }
 148     return false;
 149   }
 150
 151   /// \brief Remove items from the set vector based on a predicate function.
 152   ///
 153   /// This is intended to be equivalent to the following code, if we could
 154   /// write it:
 155   ///
 156   /// \code
 157   ///   V.erase(std::remove_if(V.begin(), V.end(), P), V.end());
 158   /// \endcode
 159   ///
 160   /// However, SetVector doesn't expose non-const iterators, making any
 161   /// algorithm like remove_if impossible to use.
 162   ///
 163   /// \returns true if any element is removed.
 164   template <typename UnaryPredicate>
 165   bool remove_if(UnaryPredicate P) {
 166     typename vector_type::iterator I
 167       = std::remove_if(vector_.begin(), vector_.end(),
 168                        TestAndEraseFromSet<UnaryPredicate>(P, set_));
 169     if (I == vector_.end())
 170       return false;
 171     vector_.erase(I, vector_.end());
 172     return true;
 173   }
 174
 175
 176   /// \brief Count the number of elements of a given key in the SetVector.
 177   /// \returns 0 if the element is not in the SetVector, 1 if it is.
 178   size_type count(const key_type &key) const {
 179     return set_.count(key);
 180   }
 181
 182   /// \brief Completely clear the SetVector
 183   void clear() {
 184     set_.clear();
 185     vector_.clear();
 186   }
 187
 188   /// \brief Remove the last element of the SetVector.
 189   void pop_back() {
 190     assert(!empty() && "Cannot remove an element from an empty SetVector!");
 191     set_.erase(back());
 192     vector_.pop_back();
 193   }
 194
 195   T LLVM_ATTRIBUTE_UNUSED_RESULT pop_back_val() {
 196     T Ret = back();
 197     pop_back();
 198     return Ret;
 199   }
 200
 201   bool operator==(const SetVector &that) const {
 202     return vector_ == that.vector_;
 203   }
 204
 205   bool operator!=(const SetVector &that) const {
 206     return vector_ != that.vector_;
 207   }
 208
 209 private:
 210   /// \brief A wrapper predicate designed for use with std::remove_if.
 211   ///
 212   /// This predicate wraps a predicate suitable for use with std::remove_if to
 213   /// call set_.erase(x) on each element which is slated for removal.
 214   template <typename UnaryPredicate>
 215   class TestAndEraseFromSet {
 216     UnaryPredicate P;
 217     set_type &set_;
 218
 219   public:
 220     TestAndEraseFromSet(UnaryPredicate P, set_type &set_) : P(P), set_(set_) {}
 221
 222     template <typename ArgumentT>
 223     bool operator()(const ArgumentT &Arg) {
 224       if (P(Arg)) {
 225         set_.erase(Arg);
 226         return true;
 227       }
 228       return false;
 229     }
 230   };
 231
 232   set_type set_;         ///< The set.
 233   vector_type vector_;   ///< The vector.
 234 };
 235
 236 /// \brief A SetVector that performs no allocations if smaller than
 237 /// a certain size.
 238 template <typename T, unsigned N>
 239 class SmallSetVector : public SetVector<T, SmallVector<T, N>, SmallSet<T, N> > {
 240 public:
 241   SmallSetVector() {}
 242
 243   /// \brief Initialize a SmallSetVector with a range of elements
 244   template<typename It>
 245   SmallSetVector(It Start, It End) {
 246     this->insert(Start, End);
 247   }
 248 };
 249
 250 } // End llvm namespace
 251
 252 // vim: sw=2 ai
 253 #endif