contrib/llvm/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_range.h"
  18 #include "llvm/Support/AlignOf.h"
  19 #include "llvm/Support/Compiler.h"
  20 #include "llvm/Support/MathExtras.h"
  21 #include "llvm/Support/type_traits.h"
  22 #include <algorithm>
  23 #include <cassert>
  24 #include <cstddef>
  25 #include <cstdlib>
  26 #include <cstring>
  27 #include <initializer_list>
  28 #include <iterator>
  29 #include <memory>
  30 #include <new>
  31 #include <type_traits>
  32 #include <utility>
  33
  34 namespace llvm {
  35
  36 /// This is all the non-templated stuff common to all SmallVectors.
  37 class SmallVectorBase {
  38 protected:
  39   void *BeginX, *EndX, *CapacityX;
  40
  41 protected:
  42   SmallVectorBase(void *FirstEl, size_t Size)
  43     : BeginX(FirstEl), EndX(FirstEl), CapacityX((char*)FirstEl+Size) {}
  44
  45   /// This is an implementation of the grow() method which only works
  46   /// on POD-like data types and is out of line to reduce code duplication.
  47   void grow_pod(void *FirstEl, size_t MinSizeInBytes, size_t TSize);
  48
  49 public:
  50   /// This returns size()*sizeof(T).
  51   size_t size_in_bytes() const {
  52     return size_t((char*)EndX - (char*)BeginX);
  53   }
  54
  55   /// capacity_in_bytes - This returns capacity()*sizeof(T).
  56   size_t capacity_in_bytes() const {
  57     return size_t((char*)CapacityX - (char*)BeginX);
  58   }
  59
  60   LLVM_NODISCARD bool empty() const { return BeginX == EndX; }
  61 };
  62
  63 /// This is the part of SmallVectorTemplateBase which does not depend on whether
  64 /// the type T is a POD. The extra dummy template argument is used by ArrayRef
  65 /// to avoid unnecessarily requiring T to be complete.
  66 template <typename T, typename = void>
  67 class SmallVectorTemplateCommon : public SmallVectorBase {
  68 private:
  69   template <typename, unsigned> friend struct SmallVectorStorage;
  70
  71   // Allocate raw space for N elements of type T.  If T has a ctor or dtor, we
  72   // don't want it to be automatically run, so we need to represent the space as
  73   // something else.  Use an array of char of sufficient alignment.
  74   using U = AlignedCharArrayUnion<T>;
  75   U FirstEl;
  76   // Space after 'FirstEl' is clobbered, do not add any instance vars after it.
  77
  78 protected:
  79   SmallVectorTemplateCommon(size_t Size) : SmallVectorBase(&FirstEl, Size) {}
  80
  81   void grow_pod(size_t MinSizeInBytes, size_t TSize) {
  82     SmallVectorBase::grow_pod(&FirstEl, MinSizeInBytes, TSize);
  83   }
  84
  85   /// Return true if this is a smallvector which has not had dynamic
  86   /// memory allocated for it.
  87   bool isSmall() const {
  88     return BeginX == static_cast<const void*>(&FirstEl);
  89   }
  90
  91   /// Put this vector in a state of being small.
  92   void resetToSmall() {
  93     BeginX = EndX = CapacityX = &FirstEl;
  94   }
  95
  96   void setEnd(T *P) { this->EndX = P; }
  97
  98 public:
  99   using size_type = size_t;
 100   using difference_type = ptrdiff_t;
 101   using value_type = T;
 102   using iterator = T *;
 103   using const_iterator = const T *;
 104
 105   using const_reverse_iterator = std::reverse_iterator<const_iterator>;
 106   using reverse_iterator = std::reverse_iterator<iterator>;
 107
 108   using reference = T &;
 109   using const_reference = const T &;
 110   using pointer = T *;
 111   using const_pointer = const T *;
 112
 113   // forward iterator creation methods.
 114   LLVM_ATTRIBUTE_ALWAYS_INLINE
 115   iterator begin() { return (iterator)this->BeginX; }
 116   LLVM_ATTRIBUTE_ALWAYS_INLINE
 117   const_iterator begin() const { return (const_iterator)this->BeginX; }
 118   LLVM_ATTRIBUTE_ALWAYS_INLINE
 119   iterator end() { return (iterator)this->EndX; }
 120   LLVM_ATTRIBUTE_ALWAYS_INLINE
 121   const_iterator end() const { return (const_iterator)this->EndX; }
 122
 123 protected:
 124   iterator capacity_ptr() { return (iterator)this->CapacityX; }
 125   const_iterator capacity_ptr() const { return (const_iterator)this->CapacityX;}
 126
 127 public:
 128   // reverse iterator creation methods.
 129   reverse_iterator rbegin()            { return reverse_iterator(end()); }
 130   const_reverse_iterator rbegin() const{ return const_reverse_iterator(end()); }
 131   reverse_iterator rend()              { return reverse_iterator(begin()); }
 132   const_reverse_iterator rend() const { return const_reverse_iterator(begin());}
 133
 134   LLVM_ATTRIBUTE_ALWAYS_INLINE
 135   size_type size() const { return end()-begin(); }
 136   size_type max_size() const { return size_type(-1) / sizeof(T); }
 137
 138   /// Return the total number of elements in the currently allocated buffer.
 139   size_t capacity() const { return capacity_ptr() - begin(); }
 140
 141   /// Return a pointer to the vector's buffer, even if empty().
 142   pointer data() { return pointer(begin()); }
 143   /// Return a pointer to the vector's buffer, even if empty().
 144   const_pointer data() const { return const_pointer(begin()); }
 145
 146   LLVM_ATTRIBUTE_ALWAYS_INLINE
 147   reference operator[](size_type idx) {
 148     assert(idx < size());
 149     return begin()[idx];
 150   }
 151   LLVM_ATTRIBUTE_ALWAYS_INLINE
 152   const_reference operator[](size_type idx) const {
 153     assert(idx < size());
 154     return begin()[idx];
 155   }
 156
 157   reference front() {
 158     assert(!empty());
 159     return begin()[0];
 160   }
 161   const_reference front() const {
 162     assert(!empty());
 163     return begin()[0];
 164   }
 165
 166   reference back() {
 167     assert(!empty());
 168     return end()[-1];
 169   }
 170   const_reference back() const {
 171     assert(!empty());
 172     return end()[-1];
 173   }
 174 };
 175
 176 /// SmallVectorTemplateBase<isPodLike = false> - This is where we put method
 177 /// implementations that are designed to work with non-POD-like T's.
 178 template <typename T, bool isPodLike>
 179 class SmallVectorTemplateBase : public SmallVectorTemplateCommon<T> {
 180 protected:
 181   SmallVectorTemplateBase(size_t Size) : SmallVectorTemplateCommon<T>(Size) {}
 182
 183   static void destroy_range(T *S, T *E) {
 184     while (S != E) {
 185       --E;
 186       E->~T();
 187     }
 188   }
 189
 190   /// Move the range [I, E) into the uninitialized memory starting with "Dest",
 191   /// constructing elements as needed.
 192   template<typename It1, typename It2>
 193   static void uninitialized_move(It1 I, It1 E, It2 Dest) {
 194     std::uninitialized_copy(std::make_move_iterator(I),
 195                             std::make_move_iterator(E), Dest);
 196   }
 197
 198   /// Copy the range [I, E) onto the uninitialized memory starting with "Dest",
 199   /// constructing elements as needed.
 200   template<typename It1, typename It2>
 201   static void uninitialized_copy(It1 I, It1 E, It2 Dest) {
 202     std::uninitialized_copy(I, E, Dest);
 203   }
 204
 205   /// Grow the allocated memory (without initializing new elements), doubling
 206   /// the size of the allocated memory. Guarantees space for at least one more
 207   /// element, or MinSize more elements if specified.
 208   void grow(size_t MinSize = 0);
 209
 210 public:
 211   void push_back(const T &Elt) {
 212     if (LLVM_UNLIKELY(this->EndX >= this->CapacityX))
 213       this->grow();
 214     ::new ((void*) this->end()) T(Elt);
 215     this->setEnd(this->end()+1);
 216   }
 217
 218   void push_back(T &&Elt) {
 219     if (LLVM_UNLIKELY(this->EndX >= this->CapacityX))
 220       this->grow();
 221     ::new ((void*) this->end()) T(::std::move(Elt));
 222     this->setEnd(this->end()+1);
 223   }
 224
 225   void pop_back() {
 226     this->setEnd(this->end()-1);
 227     this->end()->~T();
 228   }
 229 };
 230
 231 // Define this out-of-line to dissuade the C++ compiler from inlining it.
 232 template <typename T, bool isPodLike>
 233 void SmallVectorTemplateBase<T, isPodLike>::grow(size_t MinSize) {
 234   size_t CurCapacity = this->capacity();
 235   size_t CurSize = this->size();
 236   // Always grow, even from zero.
 237   size_t NewCapacity = size_t(NextPowerOf2(CurCapacity+2));
 238   if (NewCapacity < MinSize)
 239     NewCapacity = MinSize;
 240   T *NewElts = static_cast<T*>(malloc(NewCapacity*sizeof(T)));
 241
 242   // Move the elements over.
 243   this->uninitialized_move(this->begin(), this->end(), NewElts);
 244
 245   // Destroy the original elements.
 246   destroy_range(this->begin(), this->end());
 247
 248   // If this wasn't grown from the inline copy, deallocate the old space.
 249   if (!this->isSmall())
 250     free(this->begin());
 251
 252   this->setEnd(NewElts+CurSize);
 253   this->BeginX = NewElts;
 254   this->CapacityX = this->begin()+NewCapacity;
 255 }
 256
 257
 258 /// SmallVectorTemplateBase<isPodLike = true> - This is where we put method
 259 /// implementations that are designed to work with POD-like T's.
 260 template <typename T>
 261 class SmallVectorTemplateBase<T, true> : public SmallVectorTemplateCommon<T> {
 262 protected:
 263   SmallVectorTemplateBase(size_t Size) : SmallVectorTemplateCommon<T>(Size) {}
 264
 265   // No need to do a destroy loop for POD's.
 266   static void destroy_range(T *, T *) {}
 267
 268   /// Move the range [I, E) onto the uninitialized memory
 269   /// starting with "Dest", constructing elements into it as needed.
 270   template<typename It1, typename It2>
 271   static void uninitialized_move(It1 I, It1 E, It2 Dest) {
 272     // Just do a copy.
 273     uninitialized_copy(I, E, Dest);
 274   }
 275
 276   /// Copy the range [I, E) onto the uninitialized memory
 277   /// starting with "Dest", constructing elements into it as needed.
 278   template<typename It1, typename It2>
 279   static void uninitialized_copy(It1 I, It1 E, It2 Dest) {
 280     // Arbitrary iterator types; just use the basic implementation.
 281     std::uninitialized_copy(I, E, Dest);
 282   }
 283
 284   /// Copy the range [I, E) onto the uninitialized memory
 285   /// starting with "Dest", constructing elements into it as needed.
 286   template <typename T1, typename T2>
 287   static void uninitialized_copy(
 288       T1 *I, T1 *E, T2 *Dest,
 289       typename std::enable_if<std::is_same<typename std::remove_const<T1>::type,
 290                                            T2>::value>::type * = nullptr) {
 291     // Use memcpy for PODs iterated by pointers (which includes SmallVector
 292     // iterators): std::uninitialized_copy optimizes to memmove, but we can
 293     // use memcpy here. Note that I and E are iterators and thus might be
 294     // invalid for memcpy if they are equal.
 295     if (I != E)
 296       memcpy(Dest, I, (E - I) * sizeof(T));
 297   }
 298
 299   /// Double the size of the allocated memory, guaranteeing space for at
 300   /// least one more element or MinSize if specified.
 301   void grow(size_t MinSize = 0) {
 302     this->grow_pod(MinSize*sizeof(T), sizeof(T));
 303   }
 304
 305 public:
 306   void push_back(const T &Elt) {
 307     if (LLVM_UNLIKELY(this->EndX >= this->CapacityX))
 308       this->grow();
 309     memcpy(this->end(), &Elt, sizeof(T));
 310     this->setEnd(this->end()+1);
 311   }
 312
 313   void pop_back() {
 314     this->setEnd(this->end()-1);
 315   }
 316 };
 317
 318 /// This class consists of common code factored out of the SmallVector class to
 319 /// reduce code duplication based on the SmallVector 'N' template parameter.
 320 template <typename T>
 321 class SmallVectorImpl : public SmallVectorTemplateBase<T, isPodLike<T>::value> {
 322   using SuperClass = SmallVectorTemplateBase<T, isPodLike<T>::value>;
 323
 324 public:
 325   using iterator = typename SuperClass::iterator;
 326   using const_iterator = typename SuperClass::const_iterator;
 327   using size_type = typename SuperClass::size_type;
 328
 329 protected:
 330   // Default ctor - Initialize to empty.
 331   explicit SmallVectorImpl(unsigned N)
 332     : SmallVectorTemplateBase<T, isPodLike<T>::value>(N*sizeof(T)) {
 333   }
 334
 335 public:
 336   SmallVectorImpl(const SmallVectorImpl &) = delete;
 337
 338   ~SmallVectorImpl() {
 339     // Destroy the constructed elements in the vector.
 340     this->destroy_range(this->begin(), this->end());
 341
 342     // If this wasn't grown from the inline copy, deallocate the old space.
 343     if (!this->isSmall())
 344       free(this->begin());
 345   }
 346
 347   void clear() {
 348     this->destroy_range(this->begin(), this->end());
 349     this->EndX = this->BeginX;
 350   }
 351
 352   void resize(size_type N) {
 353     if (N < this->size()) {
 354       this->destroy_range(this->begin()+N, this->end());
 355       this->setEnd(this->begin()+N);
 356     } else if (N > this->size()) {
 357       if (this->capacity() < N)
 358         this->grow(N);
 359       for (auto I = this->end(), E = this->begin() + N; I != E; ++I)
 360         new (&*I) T();
 361       this->setEnd(this->begin()+N);
 362     }
 363   }
 364
 365   void resize(size_type N, const T &NV) {
 366     if (N < this->size()) {
 367       this->destroy_range(this->begin()+N, this->end());
 368       this->setEnd(this->begin()+N);
 369     } else if (N > this->size()) {
 370       if (this->capacity() < N)
 371         this->grow(N);
 372       std::uninitialized_fill(this->end(), this->begin()+N, NV);
 373       this->setEnd(this->begin()+N);
 374     }
 375   }
 376
 377   void reserve(size_type N) {
 378     if (this->capacity() < N)
 379       this->grow(N);
 380   }
 381
 382   LLVM_NODISCARD T pop_back_val() {
 383     T Result = ::std::move(this->back());
 384     this->pop_back();
 385     return Result;
 386   }
 387
 388   void swap(SmallVectorImpl &RHS);
 389
 390   /// Add the specified range to the end of the SmallVector.
 391   template<typename in_iter>
 392   void append(in_iter in_start, in_iter in_end) {
 393     size_type NumInputs = std::distance(in_start, in_end);
 394     // Grow allocated space if needed.
 395     if (NumInputs > size_type(this->capacity_ptr()-this->end()))
 396       this->grow(this->size()+NumInputs);
 397
 398     // Copy the new elements over.
 399     this->uninitialized_copy(in_start, in_end, this->end());
 400     this->setEnd(this->end() + NumInputs);
 401   }
 402
 403   /// Add the specified range to the end of the SmallVector.
 404   void append(size_type NumInputs, const T &Elt) {
 405     // Grow allocated space if needed.
 406     if (NumInputs > size_type(this->capacity_ptr()-this->end()))
 407       this->grow(this->size()+NumInputs);
 408
 409     // Copy the new elements over.
 410     std::uninitialized_fill_n(this->end(), NumInputs, Elt);
 411     this->setEnd(this->end() + NumInputs);
 412   }
 413
 414   void append(std::initializer_list<T> IL) {
 415     append(IL.begin(), IL.end());
 416   }
 417
 418   // FIXME: Consider assigning over existing elements, rather than clearing &
 419   // re-initializing them - for all assign(...) variants.
 420
 421   void assign(size_type NumElts, const T &Elt) {
 422     clear();
 423     if (this->capacity() < NumElts)
 424       this->grow(NumElts);
 425     this->setEnd(this->begin()+NumElts);
 426     std::uninitialized_fill(this->begin(), this->end(), Elt);
 427   }
 428
 429   template <typename in_iter> void assign(in_iter in_start, in_iter in_end) {
 430     clear();
 431     append(in_start, in_end);
 432   }
 433
 434   void assign(std::initializer_list<T> IL) {
 435     clear();
 436     append(IL);
 437   }
 438
 439   iterator erase(const_iterator CI) {
 440     // Just cast away constness because this is a non-const member function.
 441     iterator I = const_cast<iterator>(CI);
 442
 443     assert(I >= this->begin() && "Iterator to erase is out of bounds.");
 444     assert(I < this->end() && "Erasing at past-the-end iterator.");
 445
 446     iterator N = I;
 447     // Shift all elts down one.
 448     std::move(I+1, this->end(), I);
 449     // Drop the last elt.
 450     this->pop_back();
 451     return(N);
 452   }
 453
 454   iterator erase(const_iterator CS, const_iterator CE) {
 455     // Just cast away constness because this is a non-const member function.
 456     iterator S = const_cast<iterator>(CS);
 457     iterator E = const_cast<iterator>(CE);
 458
 459     assert(S >= this->begin() && "Range to erase is out of bounds.");
 460     assert(S <= E && "Trying to erase invalid range.");
 461     assert(E <= this->end() && "Trying to erase past the end.");
 462
 463     iterator N = S;
 464     // Shift all elts down.
 465     iterator I = std::move(E, this->end(), S);
 466     // Drop the last elts.
 467     this->destroy_range(I, this->end());
 468     this->setEnd(I);
 469     return(N);
 470   }
 471
 472   iterator insert(iterator I, T &&Elt) {
 473     if (I == this->end()) {  // Important special case for empty vector.
 474       this->push_back(::std::move(Elt));
 475       return this->end()-1;
 476     }
 477
 478     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
 479     assert(I <= this->end() && "Inserting past the end of the vector.");
 480
 481     if (this->EndX >= this->CapacityX) {
 482       size_t EltNo = I-this->begin();
 483       this->grow();
 484       I = this->begin()+EltNo;
 485     }
 486
 487     ::new ((void*) this->end()) T(::std::move(this->back()));
 488     // Push everything else over.
 489     std::move_backward(I, this->end()-1, this->end());
 490     this->setEnd(this->end()+1);
 491
 492     // If we just moved the element we're inserting, be sure to update
 493     // the reference.
 494     T *EltPtr = &Elt;
 495     if (I <= EltPtr && EltPtr < this->EndX)
 496       ++EltPtr;
 497
 498     *I = ::std::move(*EltPtr);
 499     return I;
 500   }
 501
 502   iterator insert(iterator I, const T &Elt) {
 503     if (I == this->end()) {  // Important special case for empty vector.
 504       this->push_back(Elt);
 505       return this->end()-1;
 506     }
 507
 508     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
 509     assert(I <= this->end() && "Inserting past the end of the vector.");
 510
 511     if (this->EndX >= this->CapacityX) {
 512       size_t EltNo = I-this->begin();
 513       this->grow();
 514       I = this->begin()+EltNo;
 515     }
 516     ::new ((void*) this->end()) T(std::move(this->back()));
 517     // Push everything else over.
 518     std::move_backward(I, this->end()-1, this->end());
 519     this->setEnd(this->end()+1);
 520
 521     // If we just moved the element we're inserting, be sure to update
 522     // the reference.
 523     const T *EltPtr = &Elt;
 524     if (I <= EltPtr && EltPtr < this->EndX)
 525       ++EltPtr;
 526
 527     *I = *EltPtr;
 528     return I;
 529   }
 530
 531   iterator insert(iterator I, size_type NumToInsert, const T &Elt) {
 532     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
 533     size_t InsertElt = I - this->begin();
 534
 535     if (I == this->end()) {  // Important special case for empty vector.
 536       append(NumToInsert, Elt);
 537       return this->begin()+InsertElt;
 538     }
 539
 540     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
 541     assert(I <= this->end() && "Inserting past the end of the vector.");
 542
 543     // Ensure there is enough space.
 544     reserve(this->size() + NumToInsert);
 545
 546     // Uninvalidate the iterator.
 547     I = this->begin()+InsertElt;
 548
 549     // If there are more elements between the insertion point and the end of the
 550     // range than there are being inserted, we can use a simple approach to
 551     // insertion.  Since we already reserved space, we know that this won't
 552     // reallocate the vector.
 553     if (size_t(this->end()-I) >= NumToInsert) {
 554       T *OldEnd = this->end();
 555       append(std::move_iterator<iterator>(this->end() - NumToInsert),
 556              std::move_iterator<iterator>(this->end()));
 557
 558       // Copy the existing elements that get replaced.
 559       std::move_backward(I, OldEnd-NumToInsert, OldEnd);
 560
 561       std::fill_n(I, NumToInsert, Elt);
 562       return I;
 563     }
 564
 565     // Otherwise, we're inserting more elements than exist already, and we're
 566     // not inserting at the end.
 567
 568     // Move over the elements that we're about to overwrite.
 569     T *OldEnd = this->end();
 570     this->setEnd(this->end() + NumToInsert);
 571     size_t NumOverwritten = OldEnd-I;
 572     this->uninitialized_move(I, OldEnd, this->end()-NumOverwritten);
 573
 574     // Replace the overwritten part.
 575     std::fill_n(I, NumOverwritten, Elt);
 576
 577     // Insert the non-overwritten middle part.
 578     std::uninitialized_fill_n(OldEnd, NumToInsert-NumOverwritten, Elt);
 579     return I;
 580   }
 581
 582   template<typename ItTy>
 583   iterator insert(iterator I, ItTy From, ItTy To) {
 584     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
 585     size_t InsertElt = I - this->begin();
 586
 587     if (I == this->end()) {  // Important special case for empty vector.
 588       append(From, To);
 589       return this->begin()+InsertElt;
 590     }
 591
 592     assert(I >= this->begin() && "Insertion iterator is out of bounds.");
 593     assert(I <= this->end() && "Inserting past the end of the vector.");
 594
 595     size_t NumToInsert = std::distance(From, To);
 596
 597     // Ensure there is enough space.
 598     reserve(this->size() + NumToInsert);
 599
 600     // Uninvalidate the iterator.
 601     I = this->begin()+InsertElt;
 602
 603     // If there are more elements between the insertion point and the end of the
 604     // range than there are being inserted, we can use a simple approach to
 605     // insertion.  Since we already reserved space, we know that this won't
 606     // reallocate the vector.
 607     if (size_t(this->end()-I) >= NumToInsert) {
 608       T *OldEnd = this->end();
 609       append(std::move_iterator<iterator>(this->end() - NumToInsert),
 610              std::move_iterator<iterator>(this->end()));
 611
 612       // Copy the existing elements that get replaced.
 613       std::move_backward(I, OldEnd-NumToInsert, OldEnd);
 614
 615       std::copy(From, To, I);
 616       return I;
 617     }
 618
 619     // Otherwise, we're inserting more elements than exist already, and we're
 620     // not inserting at the end.
 621
 622     // Move over the elements that we're about to overwrite.
 623     T *OldEnd = this->end();
 624     this->setEnd(this->end() + NumToInsert);
 625     size_t NumOverwritten = OldEnd-I;
 626     this->uninitialized_move(I, OldEnd, this->end()-NumOverwritten);
 627
 628     // Replace the overwritten part.
 629     for (T *J = I; NumOverwritten > 0; --NumOverwritten) {
 630       *J = *From;
 631       ++J; ++From;
 632     }
 633
 634     // Insert the non-overwritten middle part.
 635     this->uninitialized_copy(From, To, OldEnd);
 636     return I;
 637   }
 638
 639   void insert(iterator I, std::initializer_list<T> IL) {
 640     insert(I, IL.begin(), IL.end());
 641   }
 642
 643   template <typename... ArgTypes> void emplace_back(ArgTypes &&... Args) {
 644     if (LLVM_UNLIKELY(this->EndX >= this->CapacityX))
 645       this->grow();
 646     ::new ((void *)this->end()) T(std::forward<ArgTypes>(Args)...);
 647     this->setEnd(this->end() + 1);
 648   }
 649
 650   SmallVectorImpl &operator=(const SmallVectorImpl &RHS);
 651
 652   SmallVectorImpl &operator=(SmallVectorImpl &&RHS);
 653
 654   bool operator==(const SmallVectorImpl &RHS) const {
 655     if (this->size() != RHS.size()) return false;
 656     return std::equal(this->begin(), this->end(), RHS.begin());
 657   }
 658   bool operator!=(const SmallVectorImpl &RHS) const {
 659     return !(*this == RHS);
 660   }
 661
 662   bool operator<(const SmallVectorImpl &RHS) const {
 663     return std::lexicographical_compare(this->begin(), this->end(),
 664                                         RHS.begin(), RHS.end());
 665   }
 666
 667   /// Set the array size to \p N, which the current array must have enough
 668   /// capacity for.
 669   ///
 670   /// This does not construct or destroy any elements in the vector.
 671   ///
 672   /// Clients can use this in conjunction with capacity() to write past the end
 673   /// of the buffer when they know that more elements are available, and only
 674   /// update the size later. This avoids the cost of value initializing elements
 675   /// which will only be overwritten.
 676   void set_size(size_type N) {
 677     assert(N <= this->capacity());
 678     this->setEnd(this->begin() + N);
 679   }
 680 };
 681
 682 template <typename T>
 683 void SmallVectorImpl<T>::swap(SmallVectorImpl<T> &RHS) {
 684   if (this == &RHS) return;
 685
 686   // We can only avoid copying elements if neither vector is small.
 687   if (!this->isSmall() && !RHS.isSmall()) {
 688     std::swap(this->BeginX, RHS.BeginX);
 689     std::swap(this->EndX, RHS.EndX);
 690     std::swap(this->CapacityX, RHS.CapacityX);
 691     return;
 692   }
 693   if (RHS.size() > this->capacity())
 694     this->grow(RHS.size());
 695   if (this->size() > RHS.capacity())
 696     RHS.grow(this->size());
 697
 698   // Swap the shared elements.
 699   size_t NumShared = this->size();
 700   if (NumShared > RHS.size()) NumShared = RHS.size();
 701   for (size_type i = 0; i != NumShared; ++i)
 702     std::swap((*this)[i], RHS[i]);
 703
 704   // Copy over the extra elts.
 705   if (this->size() > RHS.size()) {
 706     size_t EltDiff = this->size() - RHS.size();
 707     this->uninitialized_copy(this->begin()+NumShared, this->end(), RHS.end());
 708     RHS.setEnd(RHS.end()+EltDiff);
 709     this->destroy_range(this->begin()+NumShared, this->end());
 710     this->setEnd(this->begin()+NumShared);
 711   } else if (RHS.size() > this->size()) {
 712     size_t EltDiff = RHS.size() - this->size();
 713     this->uninitialized_copy(RHS.begin()+NumShared, RHS.end(), this->end());
 714     this->setEnd(this->end() + EltDiff);
 715     this->destroy_range(RHS.begin()+NumShared, RHS.end());
 716     RHS.setEnd(RHS.begin()+NumShared);
 717   }
 718 }
 719
 720 template <typename T>
 721 SmallVectorImpl<T> &SmallVectorImpl<T>::
 722   operator=(const SmallVectorImpl<T> &RHS) {
 723   // Avoid self-assignment.
 724   if (this == &RHS) return *this;
 725
 726   // If we already have sufficient space, assign the common elements, then
 727   // destroy any excess.
 728   size_t RHSSize = RHS.size();
 729   size_t CurSize = this->size();
 730   if (CurSize >= RHSSize) {
 731     // Assign common elements.
 732     iterator NewEnd;
 733     if (RHSSize)
 734       NewEnd = std::copy(RHS.begin(), RHS.begin()+RHSSize, this->begin());
 735     else
 736       NewEnd = this->begin();
 737
 738     // Destroy excess elements.
 739     this->destroy_range(NewEnd, this->end());
 740
 741     // Trim.
 742     this->setEnd(NewEnd);
 743     return *this;
 744   }
 745
 746   // If we have to grow to have enough elements, destroy the current elements.
 747   // This allows us to avoid copying them during the grow.
 748   // FIXME: don't do this if they're efficiently moveable.
 749   if (this->capacity() < RHSSize) {
 750     // Destroy current elements.
 751     this->destroy_range(this->begin(), this->end());
 752     this->setEnd(this->begin());
 753     CurSize = 0;
 754     this->grow(RHSSize);
 755   } else if (CurSize) {
 756     // Otherwise, use assignment for the already-constructed elements.
 757     std::copy(RHS.begin(), RHS.begin()+CurSize, this->begin());
 758   }
 759
 760   // Copy construct the new elements in place.
 761   this->uninitialized_copy(RHS.begin()+CurSize, RHS.end(),
 762                            this->begin()+CurSize);
 763
 764   // Set end.
 765   this->setEnd(this->begin()+RHSSize);
 766   return *this;
 767 }
 768
 769 template <typename T>
 770 SmallVectorImpl<T> &SmallVectorImpl<T>::operator=(SmallVectorImpl<T> &&RHS) {
 771   // Avoid self-assignment.
 772   if (this == &RHS) return *this;
 773
 774   // If the RHS isn't small, clear this vector and then steal its buffer.
 775   if (!RHS.isSmall()) {
 776     this->destroy_range(this->begin(), this->end());
 777     if (!this->isSmall()) free(this->begin());
 778     this->BeginX = RHS.BeginX;
 779     this->EndX = RHS.EndX;
 780     this->CapacityX = RHS.CapacityX;
 781     RHS.resetToSmall();
 782     return *this;
 783   }
 784
 785   // If we already have sufficient space, assign the common elements, then
 786   // destroy any excess.
 787   size_t RHSSize = RHS.size();
 788   size_t CurSize = this->size();
 789   if (CurSize >= RHSSize) {
 790     // Assign common elements.
 791     iterator NewEnd = this->begin();
 792     if (RHSSize)
 793       NewEnd = std::move(RHS.begin(), RHS.end(), NewEnd);
 794
 795     // Destroy excess elements and trim the bounds.
 796     this->destroy_range(NewEnd, this->end());
 797     this->setEnd(NewEnd);
 798
 799     // Clear the RHS.
 800     RHS.clear();
 801
 802     return *this;
 803   }
 804
 805   // If we have to grow to have enough elements, destroy the current elements.
 806   // This allows us to avoid copying them during the grow.
 807   // FIXME: this may not actually make any sense if we can efficiently move
 808   // elements.
 809   if (this->capacity() < RHSSize) {
 810     // Destroy current elements.
 811     this->destroy_range(this->begin(), this->end());
 812     this->setEnd(this->begin());
 813     CurSize = 0;
 814     this->grow(RHSSize);
 815   } else if (CurSize) {
 816     // Otherwise, use assignment for the already-constructed elements.
 817     std::move(RHS.begin(), RHS.begin()+CurSize, this->begin());
 818   }
 819
 820   // Move-construct the new elements in place.
 821   this->uninitialized_move(RHS.begin()+CurSize, RHS.end(),
 822                            this->begin()+CurSize);
 823
 824   // Set end.
 825   this->setEnd(this->begin()+RHSSize);
 826
 827   RHS.clear();
 828   return *this;
 829 }
 830
 831 /// Storage for the SmallVector elements which aren't contained in
 832 /// SmallVectorTemplateCommon. There are 'N-1' elements here. The remaining '1'
 833 /// element is in the base class. This is specialized for the N=1 and N=0 cases
 834 /// to avoid allocating unnecessary storage.
 835 template <typename T, unsigned N>
 836 struct SmallVectorStorage {
 837   typename SmallVectorTemplateCommon<T>::U InlineElts[N - 1];
 838 };
 839 template <typename T> struct SmallVectorStorage<T, 1> {};
 840 template <typename T> struct SmallVectorStorage<T, 0> {};
 841
 842 /// This is a 'vector' (really, a variable-sized array), optimized
 843 /// for the case when the array is small.  It contains some number of elements
 844 /// in-place, which allows it to avoid heap allocation when the actual number of
 845 /// elements is below that threshold.  This allows normal "small" cases to be
 846 /// fast without losing generality for large inputs.
 847 ///
 848 /// Note that this does not attempt to be exception safe.
 849 ///
 850 template <typename T, unsigned N>
 851 class SmallVector : public SmallVectorImpl<T> {
 852   /// Inline space for elements which aren't stored in the base class.
 853   SmallVectorStorage<T, N> Storage;
 854
 855 public:
 856   SmallVector() : SmallVectorImpl<T>(N) {}
 857
 858   explicit SmallVector(size_t Size, const T &Value = T())
 859     : SmallVectorImpl<T>(N) {
 860     this->assign(Size, Value);
 861   }
 862
 863   template<typename ItTy>
 864   SmallVector(ItTy S, ItTy E) : SmallVectorImpl<T>(N) {
 865     this->append(S, E);
 866   }
 867
 868   template <typename RangeTy>
 869   explicit SmallVector(const iterator_range<RangeTy> &R)
 870       : SmallVectorImpl<T>(N) {
 871     this->append(R.begin(), R.end());
 872   }
 873
 874   SmallVector(std::initializer_list<T> IL) : SmallVectorImpl<T>(N) {
 875     this->assign(IL);
 876   }
 877
 878   SmallVector(const SmallVector &RHS) : SmallVectorImpl<T>(N) {
 879     if (!RHS.empty())
 880       SmallVectorImpl<T>::operator=(RHS);
 881   }
 882
 883   const SmallVector &operator=(const SmallVector &RHS) {
 884     SmallVectorImpl<T>::operator=(RHS);
 885     return *this;
 886   }
 887
 888   SmallVector(SmallVector &&RHS) : SmallVectorImpl<T>(N) {
 889     if (!RHS.empty())
 890       SmallVectorImpl<T>::operator=(::std::move(RHS));
 891   }
 892
 893   SmallVector(SmallVectorImpl<T> &&RHS) : SmallVectorImpl<T>(N) {
 894     if (!RHS.empty())
 895       SmallVectorImpl<T>::operator=(::std::move(RHS));
 896   }
 897
 898   const SmallVector &operator=(SmallVector &&RHS) {
 899     SmallVectorImpl<T>::operator=(::std::move(RHS));
 900     return *this;
 901   }
 902
 903   const SmallVector &operator=(SmallVectorImpl<T> &&RHS) {
 904     SmallVectorImpl<T>::operator=(::std::move(RHS));
 905     return *this;
 906   }
 907
 908   const SmallVector &operator=(std::initializer_list<T> IL) {
 909     this->assign(IL);
 910     return *this;
 911   }
 912 };
 913
 914 template<typename T, unsigned N>
 915 static inline size_t capacity_in_bytes(const SmallVector<T, N> &X) {
 916   return X.capacity_in_bytes();
 917 }
 918
 919 } // end namespace llvm
 920
 921 namespace std {
 922
 923   /// Implement std::swap in terms of SmallVector swap.
 924   template<typename T>
 925   inline void
 926   swap(llvm::SmallVectorImpl<T> &LHS, llvm::SmallVectorImpl<T> &RHS) {
 927     LHS.swap(RHS);
 928   }
 929
 930   /// Implement std::swap in terms of SmallVector swap.
 931   template<typename T, unsigned N>
 932   inline void
 933   swap(llvm::SmallVector<T, N> &LHS, llvm::SmallVector<T, N> &RHS) {
 934     LHS.swap(RHS);
 935   }
 936
 937 } // end namespace std
 938
 939 #endif // LLVM_ADT_SMALLVECTOR_H