include/llvm/ADT/SmallVector.h

   1 //===- llvm/ADT/SmallVector.h - 'Normally small' vectors --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner and is distributed under
   6 // the University of Illinois Open Source 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 <algorithm>
  18 #include <iterator>
  19 #include <memory>
  20
  21 namespace llvm {
  22
  23 /// SmallVectorImpl - This class consists of common code factored out of the
  24 /// SmallVector class to reduce code duplication based on the SmallVector 'N'
  25 /// template parameter.
  26 template <typename T>
  27 class SmallVectorImpl {
  28 protected:
  29   T *Begin, *End, *Capacity;
  30
  31   // Allocate raw space for N elements of type T.  If T has a ctor or dtor, we
  32   // don't want it to be automatically run, so we need to represent the space as
  33   // something else.  An array of char would work great, but might not be
  34   // aligned sufficiently.  Instead, we either use GCC extensions, or some
  35   // number of union instances for the space, which guarantee maximal alignment.
  36 protected:
  37 #ifdef __GNUC__
  38   typedef char U;
  39   U FirstEl __attribute__((aligned));
  40 #else
  41   union U {
  42     double D;
  43     long double LD;
  44     long long L;
  45     void *P;
  46   } FirstEl;
  47 #endif
  48   // Space after 'FirstEl' is clobbered, do not add any instance vars after it.
  49 public:
  50   // Default ctor - Initialize to empty.
  51   SmallVectorImpl(unsigned N)
  52     : Begin((T*)&FirstEl), End((T*)&FirstEl), Capacity((T*)&FirstEl+N) {
  53   }
  54
  55   ~SmallVectorImpl() {
  56     // Destroy the constructed elements in the vector.
  57     destroy_range(Begin, End);
  58
  59     // If this wasn't grown from the inline copy, deallocate the old space.
  60     if (!isSmall())
  61       delete[] (char*)Begin;
  62   }
  63
  64   typedef size_t size_type;
  65   typedef T* iterator;
  66   typedef const T* const_iterator;
  67   typedef T& reference;
  68   typedef const T& const_reference;
  69
  70   bool empty() const { return Begin == End; }
  71   size_type size() const { return End-Begin; }
  72
  73   iterator begin() { return Begin; }
  74   const_iterator begin() const { return Begin; }
  75
  76   iterator end() { return End; }
  77   const_iterator end() const { return End; }
  78
  79   reference operator[](unsigned idx) {
  80     return Begin[idx];
  81   }
  82   const_reference operator[](unsigned idx) const {
  83     return Begin[idx];
  84   }
  85
  86   reference front() {
  87     return begin()[0];
  88   }
  89   const_reference front() const {
  90     return begin()[0];
  91   }
  92
  93   reference back() {
  94     return end()[-1];
  95   }
  96   const_reference back() const {
  97     return end()[-1];
  98   }
  99
 100   void push_back(const_reference Elt) {
 101     if (End < Capacity) {
 102   Retry:
 103       new (End) T(Elt);
 104       ++End;
 105       return;
 106     }
 107     grow();
 108     goto Retry;
 109   }
 110
 111   void pop_back() {
 112     --End;
 113     End->~T();
 114   }
 115
 116   void clear() {
 117     destroy_range(Begin, End);
 118     End = Begin;
 119   }
 120
 121   void resize(unsigned N) {
 122     if (N < size()) {
 123       destroy_range(Begin+N, End);
 124       End = Begin+N;
 125     } else if (N > size()) {
 126       if (Begin+N > Capacity)
 127         grow(N);
 128       construct_range(End, Begin+N, T());
 129       End = Begin+N;
 130     }
 131   }
 132
 133   void resize(unsigned N, const T &NV) {
 134     if (N < size()) {
 135       destroy_range(Begin+N, End);
 136       End = Begin+N;
 137     } else if (N > size()) {
 138       if (Begin+N > Capacity)
 139         grow(N);
 140       construct_range(End, Begin+N, NV);
 141       End = Begin+N;
 142     }
 143   }
 144
 145   void reserve(unsigned N) {
 146     if (unsigned(Capacity-Begin) < N)
 147       grow(N);
 148   }
 149
 150   void swap(SmallVectorImpl &RHS);
 151
 152   /// append - Add the specified range to the end of the SmallVector.
 153   ///
 154   template<typename in_iter>
 155   void append(in_iter in_start, in_iter in_end) {
 156     unsigned NumInputs = std::distance(in_start, in_end);
 157     // Grow allocated space if needed.
 158     if (End+NumInputs > Capacity)
 159       grow(size()+NumInputs);
 160
 161     // Copy the new elements over.
 162     std::uninitialized_copy(in_start, in_end, End);
 163     End += NumInputs;
 164   }
 165
 166   void assign(unsigned NumElts, const T &Elt) {
 167     clear();
 168     if (Begin+NumElts > Capacity)
 169       grow(NumElts);
 170     End = Begin+NumElts;
 171     construct_range(Begin, End, Elt);
 172   }
 173
 174   void erase(iterator I) {
 175     // Shift all elts down one.
 176     std::copy(I+1, End, I);
 177     // Drop the last elt.
 178     pop_back();
 179   }
 180
 181   void erase(iterator S, iterator E) {
 182     // Shift all elts down.
 183     iterator I = std::copy(E, End, S);
 184     // Drop the last elts.
 185     destroy_range(I, End);
 186     End = I;
 187   }
 188
 189   iterator insert(iterator I, const T &Elt) {
 190     if (I == End) {  // Important special case for empty vector.
 191       push_back(Elt);
 192       return end()-1;
 193     }
 194
 195     if (End < Capacity) {
 196   Retry:
 197       new (End) T(back());
 198       ++End;
 199       // Push everything else over.
 200       std::copy_backward(I, End-1, End);
 201       *I = Elt;
 202       return I;
 203     }
 204     unsigned EltNo = I-Begin;
 205     grow();
 206     I = Begin+EltNo;
 207     goto Retry;
 208   }
 209
 210   const SmallVectorImpl &operator=(const SmallVectorImpl &RHS);
 211
 212 private:
 213   /// isSmall - Return true if this is a smallvector which has not had dynamic
 214   /// memory allocated for it.
 215   bool isSmall() const {
 216     return (void*)Begin == (void*)&FirstEl;
 217   }
 218
 219   /// grow - double the size of the allocated memory, guaranteeing space for at
 220   /// least one more element or MinSize if specified.
 221   void grow(unsigned MinSize = 0);
 222
 223   void construct_range(T *S, T *E, const T &Elt) {
 224     for (; S != E; ++S)
 225       new (S) T(Elt);
 226   }
 227
 228
 229   void destroy_range(T *S, T *E) {
 230     while (S != E) {
 231       E->~T();
 232       --E;
 233     }
 234   }
 235 };
 236
 237 // Define this out-of-line to dissuade the C++ compiler from inlining it.
 238 template <typename T>
 239 void SmallVectorImpl<T>::grow(unsigned MinSize) {
 240   unsigned CurCapacity = Capacity-Begin;
 241   unsigned CurSize = size();
 242   unsigned NewCapacity = 2*CurCapacity;
 243   if (NewCapacity < MinSize)
 244     NewCapacity = MinSize;
 245   T *NewElts = reinterpret_cast<T*>(new char[NewCapacity*sizeof(T)]);
 246
 247   // Copy the elements over.
 248   std::uninitialized_copy(Begin, End, NewElts);
 249
 250   // Destroy the original elements.
 251   destroy_range(Begin, End);
 252
 253   // If this wasn't grown from the inline copy, deallocate the old space.
 254   if (!isSmall())
 255     delete[] (char*)Begin;
 256
 257   Begin = NewElts;
 258   End = NewElts+CurSize;
 259   Capacity = Begin+NewCapacity;
 260 }
 261
 262 template <typename T>
 263 void SmallVectorImpl<T>::swap(SmallVectorImpl<T> &RHS) {
 264   if (this == &RHS) return;
 265
 266   // We can only avoid copying elements if neither vector is small.
 267   if (!isSmall() && !RHS.isSmall()) {
 268     std::swap(Begin, RHS.Begin);
 269     std::swap(End, RHS.End);
 270     std::swap(Capacity, RHS.Capacity);
 271     return;
 272   }
 273   if (Begin+RHS.size() > Capacity)
 274     grow(RHS.size());
 275   if (RHS.begin()+size() > RHS.Capacity)
 276     RHS.grow(size());
 277
 278   // Swap the shared elements.
 279   unsigned NumShared = size();
 280   if (NumShared > RHS.size()) NumShared = RHS.size();
 281   for (unsigned i = 0; i != NumShared; ++i)
 282     std::swap(Begin[i], RHS[i]);
 283
 284   // Copy over the extra elts.
 285   if (size() > RHS.size()) {
 286     unsigned EltDiff = size() - RHS.size();
 287     std::uninitialized_copy(Begin+NumShared, End, RHS.End);
 288     RHS.End += EltDiff;
 289     destroy_range(Begin+NumShared, End);
 290     End = Begin+NumShared;
 291   } else if (RHS.size() > size()) {
 292     unsigned EltDiff = RHS.size() - size();
 293     std::uninitialized_copy(RHS.Begin+NumShared, RHS.End, End);
 294     End += EltDiff;
 295     destroy_range(RHS.Begin+NumShared, RHS.End);
 296     RHS.End = RHS.Begin+NumShared;
 297   }
 298 }
 299
 300 template <typename T>
 301 const SmallVectorImpl<T> &
 302 SmallVectorImpl<T>::operator=(const SmallVectorImpl<T> &RHS) {
 303   // Avoid self-assignment.
 304   if (this == &RHS) return *this;
 305
 306   // If we already have sufficient space, assign the common elements, then
 307   // destroy any excess.
 308   unsigned RHSSize = RHS.size();
 309   unsigned CurSize = size();
 310   if (CurSize >= RHSSize) {
 311     // Assign common elements.
 312     iterator NewEnd = std::copy(RHS.Begin, RHS.Begin+RHSSize, Begin);
 313
 314     // Destroy excess elements.
 315     destroy_range(NewEnd, End);
 316
 317     // Trim.
 318     End = NewEnd;
 319     return *this;
 320   }
 321
 322   // If we have to grow to have enough elements, destroy the current elements.
 323   // This allows us to avoid copying them during the grow.
 324   if (unsigned(Capacity-Begin) < RHSSize) {
 325     // Destroy current elements.
 326     destroy_range(Begin, End);
 327     End = Begin;
 328     CurSize = 0;
 329     grow(RHSSize);
 330   } else if (CurSize) {
 331     // Otherwise, use assignment for the already-constructed elements.
 332     std::copy(RHS.Begin, RHS.Begin+CurSize, Begin);
 333   }
 334
 335   // Copy construct the new elements in place.
 336   std::uninitialized_copy(RHS.Begin+CurSize, RHS.End, Begin+CurSize);
 337
 338   // Set end.
 339   End = Begin+RHSSize;
 340   return *this;
 341 }
 342
 343 /// SmallVector - This is a 'vector' (really, a variable-sized array), optimized
 344 /// for the case when the array is small.  It contains some number of elements
 345 /// in-place, which allows it to avoid heap allocation when the actual number of
 346 /// elements is below that threshold.  This allows normal "small" cases to be
 347 /// fast without losing generality for large inputs.
 348 ///
 349 /// Note that this does not attempt to be exception safe.
 350 ///
 351 template <typename T, unsigned N>
 352 class SmallVector : public SmallVectorImpl<T> {
 353   /// InlineElts - These are 'N-1' elements that are stored inline in the body
 354   /// of the vector.  The extra '1' element is stored in SmallVectorImpl.
 355   typedef typename SmallVectorImpl<T>::U U;
 356   enum {
 357     // MinUs - The number of U's require to cover N T's.
 358     MinUs = (sizeof(T)*N+sizeof(U)-1)/sizeof(U),
 359
 360     // NumInlineEltsElts - The number of elements actually in this array.  There
 361     // is already one in the parent class, and we have to round up to avoid
 362     // having a zero-element array.
 363     NumInlineEltsElts = (MinUs - 1) > 0 ? (MinUs - 1) : 1,
 364
 365     // NumTsAvailable - The number of T's we actually have space for, which may
 366     // be more than N due to rounding.
 367     NumTsAvailable = (NumInlineEltsElts+1)*sizeof(U) / sizeof(T)
 368   };
 369   U InlineElts[NumInlineEltsElts];
 370 public:
 371   SmallVector() : SmallVectorImpl<T>(NumTsAvailable) {
 372   }
 373
 374   template<typename ItTy>
 375   SmallVector(ItTy S, ItTy E) : SmallVectorImpl<T>(NumTsAvailable) {
 376     append(S, E);
 377   }
 378
 379   SmallVector(const SmallVector &RHS) : SmallVectorImpl<T>(NumTsAvailable) {
 380     operator=(RHS);
 381   }
 382
 383   const SmallVector &operator=(const SmallVector &RHS) {
 384     SmallVectorImpl<T>::operator=(RHS);
 385     return *this;
 386   }
 387 };
 388
 389 } // End llvm namespace
 390
 391 namespace std {
 392   /// Implement std::swap in terms of SmallVector swap.
 393   template<typename T>
 394   inline void
 395   swap(llvm::SmallVectorImpl<T> &LHS, llvm::SmallVectorImpl<T> &RHS) {
 396     LHS.swap(RHS);
 397   }
 398
 399   /// Implement std::swap in terms of SmallVector swap.
 400   template<typename T, unsigned N>
 401   inline void
 402   swap(llvm::SmallVector<T, N> &LHS, llvm::SmallVector<T, N> &RHS) {
 403     LHS.swap(RHS);
 404   }
 405 }
 406
 407 #endif