include/llvm/ADT/SmallVector.h

   1 //===- llvm/ADT/SmallVector.h - 'Normally small' vectors --------*- 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 SmallVector class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_SMALLVECTOR_H
  15 #define LLVM_ADT_SMALLVECTOR_H
  16
  17 #include "llvm/ADT/iterator"
  18 #include <algorithm>
  19 #include <memory>
  20
  21 #ifdef _MSC_VER
  22 namespace std {
  23 #if _MSC_VER <= 1310
  24   // Work around flawed VC++ implementation of std::uninitialized_copy.  Define
  25   // additional overloads so that elements with pointer types are recognized as
  26   // scalars and not objects, causing bizarre type conversion errors.
  27   template<class T1, class T2>
  28   inline _Scalar_ptr_iterator_tag _Ptr_cat(T1 **, T2 **) {
  29     _Scalar_ptr_iterator_tag _Cat;
  30     return _Cat;
  31   }
  32
  33   template<class T1, class T2>
  34   inline _Scalar_ptr_iterator_tag _Ptr_cat(T1* const *, T2 **) {
  35     _Scalar_ptr_iterator_tag _Cat;
  36     return _Cat;
  37   }
  38 #else
  39 // FIXME: It is not clear if the problem is fixed in VS 2005.  What is clear
  40 // is that the above hack won't work if it wasn't fixed.
  41 #endif
  42 }
  43 #endif
  44
  45 namespace llvm {
  46
  47 /// SmallVectorImpl - This class consists of common code factored out of the
  48 /// SmallVector class to reduce code duplication based on the SmallVector 'N'
  49 /// template parameter.
  50 template <typename T>
  51 class SmallVectorImpl {
  52 protected:
  53   T *Begin, *End, *Capacity;
  54
  55   // Allocate raw space for N elements of type T.  If T has a ctor or dtor, we
  56   // don't want it to be automatically run, so we need to represent the space as
  57   // something else.  An array of char would work great, but might not be
  58   // aligned sufficiently.  Instead, we either use GCC extensions, or some
  59   // number of union instances for the space, which guarantee maximal alignment.
  60 protected:
  61 #ifdef __GNUC__
  62   typedef char U;
  63   U FirstEl __attribute__((aligned));
  64 #else
  65   union U {
  66     double D;
  67     long double LD;
  68     long long L;
  69     void *P;
  70   } FirstEl;
  71 #endif
  72   // Space after 'FirstEl' is clobbered, do not add any instance vars after it.
  73 public:
  74   // Default ctor - Initialize to empty.
  75   SmallVectorImpl(unsigned N)
  76     : Begin(reinterpret_cast<T*>(&FirstEl)),
  77       End(reinterpret_cast<T*>(&FirstEl)),
  78       Capacity(reinterpret_cast<T*>(&FirstEl)+N) {
  79   }
  80
  81   ~SmallVectorImpl() {
  82     // Destroy the constructed elements in the vector.
  83     destroy_range(Begin, End);
  84
  85     // If this wasn't grown from the inline copy, deallocate the old space.
  86     if (!isSmall())
  87       delete[] reinterpret_cast<char*>(Begin);
  88   }
  89
  90   typedef size_t size_type;
  91   typedef T* iterator;
  92   typedef const T* const_iterator;
  93
  94   typedef std::reverse_iterator<const_iterator>  const_reverse_iterator;
  95   typedef std::reverse_iterator<iterator>  reverse_iterator;
  96
  97   typedef T& reference;
  98   typedef const T& const_reference;
  99
 100   bool empty() const { return Begin == End; }
 101   size_type size() const { return End-Begin; }
 102
 103   // forward iterator creation methods.
 104   iterator begin() { return Begin; }
 105   const_iterator begin() const { return Begin; }
 106   iterator end() { return End; }
 107   const_iterator end() const { return End; }
 108
 109   // reverse iterator creation methods.
 110   reverse_iterator rbegin()            { return reverse_iterator(end()); }
 111   const_reverse_iterator rbegin() const{ return const_reverse_iterator(end()); }
 112   reverse_iterator rend()              { return reverse_iterator(begin()); }
 113   const_reverse_iterator rend() const { return const_reverse_iterator(begin());}
 114
 115
 116   reference operator[](unsigned idx) {
 117     return Begin[idx];
 118   }
 119   const_reference operator[](unsigned idx) const {
 120     return Begin[idx];
 121   }
 122
 123   reference front() {
 124     return begin()[0];
 125   }
 126   const_reference front() const {
 127     return begin()[0];
 128   }
 129
 130   reference back() {
 131     return end()[-1];
 132   }
 133   const_reference back() const {
 134     return end()[-1];
 135   }
 136
 137   void push_back(const_reference Elt) {
 138     if (End < Capacity) {
 139   Retry:
 140       new (End) T(Elt);
 141       ++End;
 142       return;
 143     }
 144     grow();
 145     goto Retry;
 146   }
 147
 148   void pop_back() {
 149     --End;
 150     End->~T();
 151   }
 152
 153   void clear() {
 154     destroy_range(Begin, End);
 155     End = Begin;
 156   }
 157
 158   void resize(unsigned N) {
 159     if (N < size()) {
 160       destroy_range(Begin+N, End);
 161       End = Begin+N;
 162     } else if (N > size()) {
 163       if (unsigned(Capacity-Begin) < N)
 164         grow(N);
 165       construct_range(End, Begin+N, T());
 166       End = Begin+N;
 167     }
 168   }
 169
 170   void resize(unsigned N, const T &NV) {
 171     if (N < size()) {
 172       destroy_range(Begin+N, End);
 173       End = Begin+N;
 174     } else if (N > size()) {
 175       if (unsigned(Capacity-Begin) < N)
 176         grow(N);
 177       construct_range(End, Begin+N, NV);
 178       End = Begin+N;
 179     }
 180   }
 181
 182   void reserve(unsigned N) {
 183     if (unsigned(Capacity-Begin) < N)
 184       grow(N);
 185   }
 186
 187   void swap(SmallVectorImpl &RHS);
 188
 189   /// append - Add the specified range to the end of the SmallVector.
 190   ///
 191   template<typename in_iter>
 192   void append(in_iter in_start, in_iter in_end) {
 193     unsigned NumInputs = std::distance(in_start, in_end);
 194     // Grow allocated space if needed.
 195     if (End+NumInputs > Capacity)
 196       grow(size()+NumInputs);
 197
 198     // Copy the new elements over.
 199     std::uninitialized_copy(in_start, in_end, End);
 200     End += NumInputs;
 201   }
 202
 203   void assign(unsigned NumElts, const T &Elt) {
 204     clear();
 205     if (unsigned(Capacity-Begin) < NumElts)
 206       grow(NumElts);
 207     End = Begin+NumElts;
 208     construct_range(Begin, End, Elt);
 209   }
 210
 211   void erase(iterator I) {
 212     // Shift all elts down one.
 213     std::copy(I+1, End, I);
 214     // Drop the last elt.
 215     pop_back();
 216   }
 217
 218   void erase(iterator S, iterator E) {
 219     // Shift all elts down.
 220     iterator I = std::copy(E, End, S);
 221     // Drop the last elts.
 222     destroy_range(I, End);
 223     End = I;
 224   }
 225
 226   iterator insert(iterator I, const T &Elt) {
 227     if (I == End) {  // Important special case for empty vector.
 228       push_back(Elt);
 229       return end()-1;
 230     }
 231
 232     if (End < Capacity) {
 233   Retry:
 234       new (End) T(back());
 235       ++End;
 236       // Push everything else over.
 237       std::copy_backward(I, End-1, End);
 238       *I = Elt;
 239       return I;
 240     }
 241     unsigned EltNo = I-Begin;
 242     grow();
 243     I = Begin+EltNo;
 244     goto Retry;
 245   }
 246
 247   template<typename ItTy>
 248   iterator insert(iterator I, ItTy From, ItTy To) {
 249     if (I == End) {  // Important special case for empty vector.
 250       append(From, To);
 251       return end()-1;
 252     }
 253
 254     unsigned NumToInsert = std::distance(From, To);
 255     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
 256     unsigned InsertElt = I-begin();
 257
 258     // Ensure there is enough space.
 259     reserve(size() + NumToInsert);
 260
 261     // Uninvalidate the iterator.
 262     I = begin()+InsertElt;
 263
 264     // If we already have this many elements in the collection, append the
 265     // dest elements at the end, then copy over the appropriate elements.  Since
 266     // we already reserved space, we know that this won't reallocate the vector.
 267     if (size() >= NumToInsert) {
 268       T *OldEnd = End;
 269       append(End-NumToInsert, End);
 270
 271       // Copy the existing elements that get replaced.
 272       std::copy(I, OldEnd-NumToInsert, I+NumToInsert);
 273
 274       std::copy(From, To, I);
 275       return I;
 276     }
 277
 278     // Otherwise, we're inserting more elements than exist already, and we're
 279     // not inserting at the end.
 280
 281     // Copy over the elements that we're about to overwrite.
 282     T *OldEnd = End;
 283     End += NumToInsert;
 284     unsigned NumOverwritten = OldEnd-I;
 285     std::uninitialized_copy(I, OldEnd, End-NumOverwritten);
 286
 287     // Replace the overwritten part.
 288     std::copy(From, From+NumOverwritten, I);
 289
 290     // Insert the non-overwritten middle part.
 291     std::uninitialized_copy(From+NumOverwritten, To, OldEnd);
 292     return I;
 293   }
 294
 295   const SmallVectorImpl &operator=(const SmallVectorImpl &RHS);
 296
 297 private:
 298   /// isSmall - Return true if this is a smallvector which has not had dynamic
 299   /// memory allocated for it.
 300   bool isSmall() const {
 301     return reinterpret_cast<const void*>(Begin) ==
 302            reinterpret_cast<const void*>(&FirstEl);
 303   }
 304
 305   /// grow - double the size of the allocated memory, guaranteeing space for at
 306   /// least one more element or MinSize if specified.
 307   void grow(unsigned MinSize = 0);
 308
 309   void construct_range(T *S, T *E, const T &Elt) {
 310     for (; S != E; ++S)
 311       new (S) T(Elt);
 312   }
 313
 314   void destroy_range(T *S, T *E) {
 315     while (S != E) {
 316       --E;
 317       E->~T();
 318     }
 319   }
 320 };
 321
 322 // Define this out-of-line to dissuade the C++ compiler from inlining it.
 323 template <typename T>
 324 void SmallVectorImpl<T>::grow(unsigned MinSize) {
 325   unsigned CurCapacity = unsigned(Capacity-Begin);
 326   unsigned CurSize = unsigned(size());
 327   unsigned NewCapacity = 2*CurCapacity;
 328   if (NewCapacity < MinSize)
 329     NewCapacity = MinSize;
 330   T *NewElts = reinterpret_cast<T*>(new char[NewCapacity*sizeof(T)]);
 331
 332   // Copy the elements over.
 333   std::uninitialized_copy(Begin, End, NewElts);
 334
 335   // Destroy the original elements.
 336   destroy_range(Begin, End);
 337
 338   // If this wasn't grown from the inline copy, deallocate the old space.
 339   if (!isSmall())
 340     delete[] reinterpret_cast<char*>(Begin);
 341
 342   Begin = NewElts;
 343   End = NewElts+CurSize;
 344   Capacity = Begin+NewCapacity;
 345 }
 346
 347 template <typename T>
 348 void SmallVectorImpl<T>::swap(SmallVectorImpl<T> &RHS) {
 349   if (this == &RHS) return;
 350
 351   // We can only avoid copying elements if neither vector is small.
 352   if (!isSmall() && !RHS.isSmall()) {
 353     std::swap(Begin, RHS.Begin);
 354     std::swap(End, RHS.End);
 355     std::swap(Capacity, RHS.Capacity);
 356     return;
 357   }
 358   if (Begin+RHS.size() > Capacity)
 359     grow(RHS.size());
 360   if (RHS.begin()+size() > RHS.Capacity)
 361     RHS.grow(size());
 362
 363   // Swap the shared elements.
 364   unsigned NumShared = size();
 365   if (NumShared > RHS.size()) NumShared = RHS.size();
 366   for (unsigned i = 0; i != NumShared; ++i)
 367     std::swap(Begin[i], RHS[i]);
 368
 369   // Copy over the extra elts.
 370   if (size() > RHS.size()) {
 371     unsigned EltDiff = size() - RHS.size();
 372     std::uninitialized_copy(Begin+NumShared, End, RHS.End);
 373     RHS.End += EltDiff;
 374     destroy_range(Begin+NumShared, End);
 375     End = Begin+NumShared;
 376   } else if (RHS.size() > size()) {
 377     unsigned EltDiff = RHS.size() - size();
 378     std::uninitialized_copy(RHS.Begin+NumShared, RHS.End, End);
 379     End += EltDiff;
 380     destroy_range(RHS.Begin+NumShared, RHS.End);
 381     RHS.End = RHS.Begin+NumShared;
 382   }
 383 }
 384
 385 template <typename T>
 386 const SmallVectorImpl<T> &
 387 SmallVectorImpl<T>::operator=(const SmallVectorImpl<T> &RHS) {
 388   // Avoid self-assignment.
 389   if (this == &RHS) return *this;
 390
 391   // If we already have sufficient space, assign the common elements, then
 392   // destroy any excess.
 393   unsigned RHSSize = unsigned(RHS.size());
 394   unsigned CurSize = unsigned(size());
 395   if (CurSize >= RHSSize) {
 396     // Assign common elements.
 397     iterator NewEnd;
 398     if (RHSSize)
 399       NewEnd = std::copy(RHS.Begin, RHS.Begin+RHSSize, Begin);
 400     else
 401       NewEnd = Begin;
 402
 403     // Destroy excess elements.
 404     destroy_range(NewEnd, End);
 405
 406     // Trim.
 407     End = NewEnd;
 408     return *this;
 409   }
 410
 411   // If we have to grow to have enough elements, destroy the current elements.
 412   // This allows us to avoid copying them during the grow.
 413   if (unsigned(Capacity-Begin) < RHSSize) {
 414     // Destroy current elements.
 415     destroy_range(Begin, End);
 416     End = Begin;
 417     CurSize = 0;
 418     grow(RHSSize);
 419   } else if (CurSize) {
 420     // Otherwise, use assignment for the already-constructed elements.
 421     std::copy(RHS.Begin, RHS.Begin+CurSize, Begin);
 422   }
 423
 424   // Copy construct the new elements in place.
 425   std::uninitialized_copy(RHS.Begin+CurSize, RHS.End, Begin+CurSize);
 426
 427   // Set end.
 428   End = Begin+RHSSize;
 429   return *this;
 430 }
 431
 432 /// SmallVector - This is a 'vector' (really, a variable-sized array), optimized
 433 /// for the case when the array is small.  It contains some number of elements
 434 /// in-place, which allows it to avoid heap allocation when the actual number of
 435 /// elements is below that threshold.  This allows normal "small" cases to be
 436 /// fast without losing generality for large inputs.
 437 ///
 438 /// Note that this does not attempt to be exception safe.
 439 ///
 440 template <typename T, unsigned N>
 441 class SmallVector : public SmallVectorImpl<T> {
 442   /// InlineElts - These are 'N-1' elements that are stored inline in the body
 443   /// of the vector.  The extra '1' element is stored in SmallVectorImpl.
 444   typedef typename SmallVectorImpl<T>::U U;
 445   enum {
 446     // MinUs - The number of U's require to cover N T's.
 447     MinUs = (sizeof(T)*N+sizeof(U)-1)/sizeof(U),
 448
 449     // NumInlineEltsElts - The number of elements actually in this array.  There
 450     // is already one in the parent class, and we have to round up to avoid
 451     // having a zero-element array.
 452     NumInlineEltsElts = (MinUs - 1) > 0 ? (MinUs - 1) : 1,
 453
 454     // NumTsAvailable - The number of T's we actually have space for, which may
 455     // be more than N due to rounding.
 456     NumTsAvailable = (NumInlineEltsElts+1)*sizeof(U) / sizeof(T)
 457   };
 458   U InlineElts[NumInlineEltsElts];
 459 public:
 460   SmallVector() : SmallVectorImpl<T>(NumTsAvailable) {
 461   }
 462
 463   explicit SmallVector(unsigned Size, const T &Value = T())
 464     : SmallVectorImpl<T>(NumTsAvailable) {
 465     this->reserve(Size);
 466     while (Size--)
 467       push_back(Value);
 468   }
 469
 470   template<typename ItTy>
 471   SmallVector(ItTy S, ItTy E) : SmallVectorImpl<T>(NumTsAvailable) {
 472     append(S, E);
 473   }
 474
 475   SmallVector(const SmallVector &RHS) : SmallVectorImpl<T>(NumTsAvailable) {
 476     if (!RHS.empty())
 477       operator=(RHS);
 478   }
 479
 480   const SmallVector &operator=(const SmallVector &RHS) {
 481     SmallVectorImpl<T>::operator=(RHS);
 482     return *this;
 483   }
 484 };
 485
 486 } // End llvm namespace
 487
 488 namespace std {
 489   /// Implement std::swap in terms of SmallVector swap.
 490   template<typename T>
 491   inline void
 492   swap(llvm::SmallVectorImpl<T> &LHS, llvm::SmallVectorImpl<T> &RHS) {
 493     LHS.swap(RHS);
 494   }
 495
 496   /// Implement std::swap in terms of SmallVector swap.
 497   template<typename T, unsigned N>
 498   inline void
 499   swap(llvm::SmallVector<T, N> &LHS, llvm::SmallVector<T, N> &RHS) {
 500     LHS.swap(RHS);
 501   }
 502 }
 503
 504 #endif