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