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/Support/type_traits.h"
  18 #include <algorithm>
  19 #include <cassert>
  20 #include <cstddef>
  21 #include <cstdlib>
  22 #include <cstring>
  23 #include <iterator>
  24 #include <memory>
  25
  26 #ifdef _MSC_VER
  27 namespace std {
  28 #if _MSC_VER <= 1310
  29   // Work around flawed VC++ implementation of std::uninitialized_copy.  Define
  30   // additional overloads so that elements with pointer types are recognized as
  31   // scalars and not objects, causing bizarre type conversion errors.
  32   template<class T1, class T2>
  33   inline _Scalar_ptr_iterator_tag _Ptr_cat(T1 **, T2 **) {
  34     _Scalar_ptr_iterator_tag _Cat;
  35     return _Cat;
  36   }
  37
  38   template<class T1, class T2>
  39   inline _Scalar_ptr_iterator_tag _Ptr_cat(T1* const *, T2 **) {
  40     _Scalar_ptr_iterator_tag _Cat;
  41     return _Cat;
  42   }
  43 #else
  44 // FIXME: It is not clear if the problem is fixed in VS 2005.  What is clear
  45 // is that the above hack won't work if it wasn't fixed.
  46 #endif
  47 }
  48 #endif
  49
  50 namespace llvm {
  51
  52 /// SmallVectorBase - This is all the non-templated stuff common to all
  53 /// SmallVectors.
  54 class SmallVectorBase {
  55 protected:
  56   void *BeginX, *EndX, *CapacityX;
  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 use some number of union instances for
  62   // the space, which guarantee maximal alignment.
  63   union U {
  64     double D;
  65     long double LD;
  66     long long L;
  67     void *P;
  68   } FirstEl;
  69   // Space after 'FirstEl' is clobbered, do not add any instance vars after it.
  70
  71 protected:
  72   SmallVectorBase(size_t Size)
  73     : BeginX(&FirstEl), EndX(&FirstEl), CapacityX((char*)&FirstEl+Size) {}
  74
  75   /// isSmall - Return true if this is a smallvector which has not had dynamic
  76   /// memory allocated for it.
  77   bool isSmall() const {
  78     return BeginX == static_cast<const void*>(&FirstEl);
  79   }
  80
  81   /// grow_pod - This is an implementation of the grow() method which only works
  82   /// on POD-like data types and is out of line to reduce code duplication.
  83   void grow_pod(size_t MinSizeInBytes, size_t TSize);
  84
  85 public:
  86   /// size_in_bytes - This returns size()*sizeof(T).
  87   size_t size_in_bytes() const {
  88     return size_t((char*)EndX - (char*)BeginX);
  89   }
  90
  91   /// capacity_in_bytes - This returns capacity()*sizeof(T).
  92   size_t capacity_in_bytes() const {
  93     return size_t((char*)CapacityX - (char*)BeginX);
  94   }
  95
  96   bool empty() const { return BeginX == EndX; }
  97 };
  98
  99
 100 template <typename T>
 101 class SmallVectorTemplateCommon : public SmallVectorBase {
 102 protected:
 103   SmallVectorTemplateCommon(size_t Size) : SmallVectorBase(Size) {}
 104
 105   void setEnd(T *P) { this->EndX = P; }
 106 public:
 107   typedef size_t size_type;
 108   typedef ptrdiff_t difference_type;
 109   typedef T value_type;
 110   typedef T *iterator;
 111   typedef const T *const_iterator;
 112
 113   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 114   typedef std::reverse_iterator<iterator> reverse_iterator;
 115
 116   typedef T &reference;
 117   typedef const T &const_reference;
 118   typedef T *pointer;
 119   typedef const T *const_pointer;
 120
 121   // forward iterator creation methods.
 122   iterator begin() { return (iterator)this->BeginX; }
 123   const_iterator begin() const { return (const_iterator)this->BeginX; }
 124   iterator end() { return (iterator)this->EndX; }
 125   const_iterator end() const { return (const_iterator)this->EndX; }
 126 protected:
 127   iterator capacity_ptr() { return (iterator)this->CapacityX; }
 128   const_iterator capacity_ptr() const { return (const_iterator)this->CapacityX;}
 129 public:
 130
 131   // reverse iterator creation methods.
 132   reverse_iterator rbegin()            { return reverse_iterator(end()); }
 133   const_reverse_iterator rbegin() const{ return const_reverse_iterator(end()); }
 134   reverse_iterator rend()              { return reverse_iterator(begin()); }
 135   const_reverse_iterator rend() const { return const_reverse_iterator(begin());}
 136
 137   size_type size() const { return end()-begin(); }
 138   size_type max_size() const { return size_type(-1) / sizeof(T); }
 139
 140   /// capacity - Return the total number of elements in the currently allocated
 141   /// buffer.
 142   size_t capacity() const { return capacity_ptr() - begin(); }
 143
 144   /// data - Return a pointer to the vector's buffer, even if empty().
 145   pointer data() { return pointer(begin()); }
 146   /// data - Return a pointer to the vector's buffer, even if empty().
 147   const_pointer data() const { return const_pointer(begin()); }
 148
 149   reference operator[](unsigned idx) {
 150     assert(begin() + idx < end());
 151     return begin()[idx];
 152   }
 153   const_reference operator[](unsigned idx) const {
 154     assert(begin() + idx < end());
 155     return begin()[idx];
 156   }
 157
 158   reference front() {
 159     return begin()[0];
 160   }
 161   const_reference front() const {
 162     return begin()[0];
 163   }
 164
 165   reference back() {
 166     return end()[-1];
 167   }
 168   const_reference back() const {
 169     return end()[-1];
 170   }
 171 };
 172
 173 /// SmallVectorTemplateBase<isPodLike = false> - This is where we put method
 174 /// implementations that are designed to work with non-POD-like T's.
 175 template <typename T, bool isPodLike>
 176 class SmallVectorTemplateBase : public SmallVectorTemplateCommon<T> {
 177 protected:
 178   SmallVectorTemplateBase(size_t Size) : SmallVectorTemplateCommon<T>(Size) {}
 179
 180   static void destroy_range(T *S, T *E) {
 181     while (S != E) {
 182       --E;
 183       E->~T();
 184     }
 185   }
 186
 187   /// uninitialized_copy - Copy the range [I, E) onto the uninitialized memory
 188   /// starting with "Dest", constructing elements into it as needed.
 189   template<typename It1, typename It2>
 190   static void uninitialized_copy(It1 I, It1 E, It2 Dest) {
 191     std::uninitialized_copy(I, E, Dest);
 192   }
 193
 194   /// grow - double the size of the allocated memory, guaranteeing space for at
 195   /// least one more element or MinSize if specified.
 196   void grow(size_t MinSize = 0);
 197 };
 198
 199 // Define this out-of-line to dissuade the C++ compiler from inlining it.
 200 template <typename T, bool isPodLike>
 201 void SmallVectorTemplateBase<T, isPodLike>::grow(size_t MinSize) {
 202   size_t CurCapacity = this->capacity();
 203   size_t CurSize = this->size();
 204   size_t NewCapacity = 2*CurCapacity + 1; // Always grow, even from zero.
 205   if (NewCapacity < MinSize)
 206     NewCapacity = MinSize;
 207   T *NewElts = static_cast<T*>(malloc(NewCapacity*sizeof(T)));
 208
 209   // Copy the elements over.
 210   this->uninitialized_copy(this->begin(), this->end(), NewElts);
 211
 212   // Destroy the original elements.
 213   destroy_range(this->begin(), this->end());
 214
 215   // If this wasn't grown from the inline copy, deallocate the old space.
 216   if (!this->isSmall())
 217     free(this->begin());
 218
 219   this->setEnd(NewElts+CurSize);
 220   this->BeginX = NewElts;
 221   this->CapacityX = this->begin()+NewCapacity;
 222 }
 223
 224
 225 /// SmallVectorTemplateBase<isPodLike = true> - This is where we put method
 226 /// implementations that are designed to work with POD-like T's.
 227 template <typename T>
 228 class SmallVectorTemplateBase<T, true> : public SmallVectorTemplateCommon<T> {
 229 protected:
 230   SmallVectorTemplateBase(size_t Size) : SmallVectorTemplateCommon<T>(Size) {}
 231
 232   // No need to do a destroy loop for POD's.
 233   static void destroy_range(T *, T *) {}
 234
 235   /// uninitialized_copy - Copy the range [I, E) onto the uninitialized memory
 236   /// starting with "Dest", constructing elements into it as needed.
 237   template<typename It1, typename It2>
 238   static void uninitialized_copy(It1 I, It1 E, It2 Dest) {
 239     // Arbitrary iterator types; just use the basic implementation.
 240     std::uninitialized_copy(I, E, Dest);
 241   }
 242
 243   /// uninitialized_copy - Copy the range [I, E) onto the uninitialized memory
 244   /// starting with "Dest", constructing elements into it as needed.
 245   template<typename T1, typename T2>
 246   static void uninitialized_copy(T1 *I, T1 *E, T2 *Dest) {
 247     // Use memcpy for PODs iterated by pointers (which includes SmallVector
 248     // iterators): std::uninitialized_copy optimizes to memmove, but we can
 249     // use memcpy here.
 250     memcpy(Dest, I, (E-I)*sizeof(T));
 251   }
 252
 253   /// grow - double the size of the allocated memory, guaranteeing space for at
 254   /// least one more element or MinSize if specified.
 255   void grow(size_t MinSize = 0) {
 256     this->grow_pod(MinSize*sizeof(T), sizeof(T));
 257   }
 258 };
 259
 260
 261 /// SmallVectorImpl - This class consists of common code factored out of the
 262 /// SmallVector class to reduce code duplication based on the SmallVector 'N'
 263 /// template parameter.
 264 template <typename T>
 265 class SmallVectorImpl : public SmallVectorTemplateBase<T, isPodLike<T>::value> {
 266   typedef SmallVectorTemplateBase<T, isPodLike<T>::value > SuperClass;
 267
 268   SmallVectorImpl(const SmallVectorImpl&); // DISABLED.
 269 public:
 270   typedef typename SuperClass::iterator iterator;
 271   typedef typename SuperClass::size_type size_type;
 272
 273 protected:
 274   // Default ctor - Initialize to empty.
 275   explicit SmallVectorImpl(unsigned N)
 276     : SmallVectorTemplateBase<T, isPodLike<T>::value>(N*sizeof(T)) {
 277   }
 278
 279 public:
 280   ~SmallVectorImpl() {
 281     // Destroy the constructed elements in the vector.
 282     this->destroy_range(this->begin(), this->end());
 283
 284     // If this wasn't grown from the inline copy, deallocate the old space.
 285     if (!this->isSmall())
 286       free(this->begin());
 287   }
 288
 289
 290   void clear() {
 291     this->destroy_range(this->begin(), this->end());
 292     this->EndX = this->BeginX;
 293   }
 294
 295   void resize(unsigned N) {
 296     if (N < this->size()) {
 297       this->destroy_range(this->begin()+N, this->end());
 298       this->setEnd(this->begin()+N);
 299     } else if (N > this->size()) {
 300       if (this->capacity() < N)
 301         this->grow(N);
 302       std::uninitialized_fill(this->end(), this->begin()+N, T());
 303       this->setEnd(this->begin()+N);
 304     }
 305   }
 306
 307   void resize(unsigned N, const T &NV) {
 308     if (N < this->size()) {
 309       this->destroy_range(this->begin()+N, this->end());
 310       this->setEnd(this->begin()+N);
 311     } else if (N > this->size()) {
 312       if (this->capacity() < N)
 313         this->grow(N);
 314       std::uninitialized_fill(this->end(), this->begin()+N, NV);
 315       this->setEnd(this->begin()+N);
 316     }
 317   }
 318
 319   void reserve(unsigned N) {
 320     if (this->capacity() < N)
 321       this->grow(N);
 322   }
 323
 324   void push_back(const T &Elt) {
 325     if (this->EndX < this->CapacityX) {
 326     Retry:
 327       new (this->end()) T(Elt);
 328       this->setEnd(this->end()+1);
 329       return;
 330     }
 331     this->grow();
 332     goto Retry;
 333   }
 334
 335   void pop_back() {
 336     this->setEnd(this->end()-1);
 337     this->end()->~T();
 338   }
 339
 340   T pop_back_val() {
 341     T Result = this->back();
 342     pop_back();
 343     return Result;
 344   }
 345
 346   void swap(SmallVectorImpl &RHS);
 347
 348   /// append - Add the specified range to the end of the SmallVector.
 349   ///
 350   template<typename in_iter>
 351   void append(in_iter in_start, in_iter in_end) {
 352     size_type NumInputs = std::distance(in_start, in_end);
 353     // Grow allocated space if needed.
 354     if (NumInputs > size_type(this->capacity_ptr()-this->end()))
 355       this->grow(this->size()+NumInputs);
 356
 357     // Copy the new elements over.
 358     // TODO: NEED To compile time dispatch on whether in_iter is a random access
 359     // iterator to use the fast uninitialized_copy.
 360     std::uninitialized_copy(in_start, in_end, this->end());
 361     this->setEnd(this->end() + NumInputs);
 362   }
 363
 364   /// append - Add the specified range to the end of the SmallVector.
 365   ///
 366   void append(size_type NumInputs, const T &Elt) {
 367     // Grow allocated space if needed.
 368     if (NumInputs > size_type(this->capacity_ptr()-this->end()))
 369       this->grow(this->size()+NumInputs);
 370
 371     // Copy the new elements over.
 372     std::uninitialized_fill_n(this->end(), NumInputs, Elt);
 373     this->setEnd(this->end() + NumInputs);
 374   }
 375
 376   void assign(unsigned NumElts, const T &Elt) {
 377     clear();
 378     if (this->capacity() < NumElts)
 379       this->grow(NumElts);
 380     this->setEnd(this->begin()+NumElts);
 381     std::uninitialized_fill(this->begin(), this->end(), Elt);
 382   }
 383
 384   iterator erase(iterator I) {
 385     iterator N = I;
 386     // Shift all elts down one.
 387     std::copy(I+1, this->end(), I);
 388     // Drop the last elt.
 389     pop_back();
 390     return(N);
 391   }
 392
 393   iterator erase(iterator S, iterator E) {
 394     iterator N = S;
 395     // Shift all elts down.
 396     iterator I = std::copy(E, this->end(), S);
 397     // Drop the last elts.
 398     this->destroy_range(I, this->end());
 399     this->setEnd(I);
 400     return(N);
 401   }
 402
 403   iterator insert(iterator I, const T &Elt) {
 404     if (I == this->end()) {  // Important special case for empty vector.
 405       push_back(Elt);
 406       return this->end()-1;
 407     }
 408
 409     if (this->EndX < this->CapacityX) {
 410     Retry:
 411       new (this->end()) T(this->back());
 412       this->setEnd(this->end()+1);
 413       // Push everything else over.
 414       std::copy_backward(I, this->end()-1, this->end());
 415
 416       // If we just moved the element we're inserting, be sure to update
 417       // the reference.
 418       const T *EltPtr = &Elt;
 419       if (I <= EltPtr && EltPtr < this->EndX)
 420         ++EltPtr;
 421
 422       *I = *EltPtr;
 423       return I;
 424     }
 425     size_t EltNo = I-this->begin();
 426     this->grow();
 427     I = this->begin()+EltNo;
 428     goto Retry;
 429   }
 430
 431   iterator insert(iterator I, size_type NumToInsert, const T &Elt) {
 432     if (I == this->end()) {  // Important special case for empty vector.
 433       append(NumToInsert, Elt);
 434       return this->end()-1;
 435     }
 436
 437     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
 438     size_t InsertElt = I - this->begin();
 439
 440     // Ensure there is enough space.
 441     reserve(static_cast<unsigned>(this->size() + NumToInsert));
 442
 443     // Uninvalidate the iterator.
 444     I = this->begin()+InsertElt;
 445
 446     // If there are more elements between the insertion point and the end of the
 447     // range than there are being inserted, we can use a simple approach to
 448     // insertion.  Since we already reserved space, we know that this won't
 449     // reallocate the vector.
 450     if (size_t(this->end()-I) >= NumToInsert) {
 451       T *OldEnd = this->end();
 452       append(this->end()-NumToInsert, this->end());
 453
 454       // Copy the existing elements that get replaced.
 455       std::copy_backward(I, OldEnd-NumToInsert, OldEnd);
 456
 457       std::fill_n(I, NumToInsert, Elt);
 458       return I;
 459     }
 460
 461     // Otherwise, we're inserting more elements than exist already, and we're
 462     // not inserting at the end.
 463
 464     // Copy over the elements that we're about to overwrite.
 465     T *OldEnd = this->end();
 466     this->setEnd(this->end() + NumToInsert);
 467     size_t NumOverwritten = OldEnd-I;
 468     this->uninitialized_copy(I, OldEnd, this->end()-NumOverwritten);
 469
 470     // Replace the overwritten part.
 471     std::fill_n(I, NumOverwritten, Elt);
 472
 473     // Insert the non-overwritten middle part.
 474     std::uninitialized_fill_n(OldEnd, NumToInsert-NumOverwritten, Elt);
 475     return I;
 476   }
 477
 478   template<typename ItTy>
 479   iterator insert(iterator I, ItTy From, ItTy To) {
 480     if (I == this->end()) {  // Important special case for empty vector.
 481       append(From, To);
 482       return this->end()-1;
 483     }
 484
 485     size_t NumToInsert = std::distance(From, To);
 486     // Convert iterator to elt# to avoid invalidating iterator when we reserve()
 487     size_t InsertElt = I - this->begin();
 488
 489     // Ensure there is enough space.
 490     reserve(static_cast<unsigned>(this->size() + NumToInsert));
 491
 492     // Uninvalidate the iterator.
 493     I = this->begin()+InsertElt;
 494
 495     // If there are more elements between the insertion point and the end of the
 496     // range than there are being inserted, we can use a simple approach to
 497     // insertion.  Since we already reserved space, we know that this won't
 498     // reallocate the vector.
 499     if (size_t(this->end()-I) >= NumToInsert) {
 500       T *OldEnd = this->end();
 501       append(this->end()-NumToInsert, this->end());
 502
 503       // Copy the existing elements that get replaced.
 504       std::copy_backward(I, OldEnd-NumToInsert, OldEnd);
 505
 506       std::copy(From, To, I);
 507       return I;
 508     }
 509
 510     // Otherwise, we're inserting more elements than exist already, and we're
 511     // not inserting at the end.
 512
 513     // Copy over the elements that we're about to overwrite.
 514     T *OldEnd = this->end();
 515     this->setEnd(this->end() + NumToInsert);
 516     size_t NumOverwritten = OldEnd-I;
 517     this->uninitialized_copy(I, OldEnd, this->end()-NumOverwritten);
 518
 519     // Replace the overwritten part.
 520     for (; NumOverwritten > 0; --NumOverwritten) {
 521       *I = *From;
 522       ++I; ++From;
 523     }
 524
 525     // Insert the non-overwritten middle part.
 526     this->uninitialized_copy(From, To, OldEnd);
 527     return I;
 528   }
 529
 530   const SmallVectorImpl
 531   &operator=(const SmallVectorImpl &RHS);
 532
 533   bool operator==(const SmallVectorImpl &RHS) const {
 534     if (this->size() != RHS.size()) return false;
 535     return std::equal(this->begin(), this->end(), RHS.begin());
 536   }
 537   bool operator!=(const SmallVectorImpl &RHS) const {
 538     return !(*this == RHS);
 539   }
 540
 541   bool operator<(const SmallVectorImpl &RHS) const {
 542     return std::lexicographical_compare(this->begin(), this->end(),
 543                                         RHS.begin(), RHS.end());
 544   }
 545
 546   /// set_size - Set the array size to \arg N, which the current array must have
 547   /// enough capacity for.
 548   ///
 549   /// This does not construct or destroy any elements in the vector.
 550   ///
 551   /// Clients can use this in conjunction with capacity() to write past the end
 552   /// of the buffer when they know that more elements are available, and only
 553   /// update the size later. This avoids the cost of value initializing elements
 554   /// which will only be overwritten.
 555   void set_size(unsigned N) {
 556     assert(N <= this->capacity());
 557     this->setEnd(this->begin() + N);
 558   }
 559 };
 560
 561
 562 template <typename T>
 563 void SmallVectorImpl<T>::swap(SmallVectorImpl<T> &RHS) {
 564   if (this == &RHS) return;
 565
 566   // We can only avoid copying elements if neither vector is small.
 567   if (!this->isSmall() && !RHS.isSmall()) {
 568     std::swap(this->BeginX, RHS.BeginX);
 569     std::swap(this->EndX, RHS.EndX);
 570     std::swap(this->CapacityX, RHS.CapacityX);
 571     return;
 572   }
 573   if (RHS.size() > this->capacity())
 574     this->grow(RHS.size());
 575   if (this->size() > RHS.capacity())
 576     RHS.grow(this->size());
 577
 578   // Swap the shared elements.
 579   size_t NumShared = this->size();
 580   if (NumShared > RHS.size()) NumShared = RHS.size();
 581   for (unsigned i = 0; i != static_cast<unsigned>(NumShared); ++i)
 582     std::swap((*this)[i], RHS[i]);
 583
 584   // Copy over the extra elts.
 585   if (this->size() > RHS.size()) {
 586     size_t EltDiff = this->size() - RHS.size();
 587     this->uninitialized_copy(this->begin()+NumShared, this->end(), RHS.end());
 588     RHS.setEnd(RHS.end()+EltDiff);
 589     this->destroy_range(this->begin()+NumShared, this->end());
 590     this->setEnd(this->begin()+NumShared);
 591   } else if (RHS.size() > this->size()) {
 592     size_t EltDiff = RHS.size() - this->size();
 593     this->uninitialized_copy(RHS.begin()+NumShared, RHS.end(), this->end());
 594     this->setEnd(this->end() + EltDiff);
 595     this->destroy_range(RHS.begin()+NumShared, RHS.end());
 596     RHS.setEnd(RHS.begin()+NumShared);
 597   }
 598 }
 599
 600 template <typename T>
 601 const SmallVectorImpl<T> &SmallVectorImpl<T>::
 602   operator=(const SmallVectorImpl<T> &RHS) {
 603   // Avoid self-assignment.
 604   if (this == &RHS) return *this;
 605
 606   // If we already have sufficient space, assign the common elements, then
 607   // destroy any excess.
 608   size_t RHSSize = RHS.size();
 609   size_t CurSize = this->size();
 610   if (CurSize >= RHSSize) {
 611     // Assign common elements.
 612     iterator NewEnd;
 613     if (RHSSize)
 614       NewEnd = std::copy(RHS.begin(), RHS.begin()+RHSSize, this->begin());
 615     else
 616       NewEnd = this->begin();
 617
 618     // Destroy excess elements.
 619     this->destroy_range(NewEnd, this->end());
 620
 621     // Trim.
 622     this->setEnd(NewEnd);
 623     return *this;
 624   }
 625
 626   // If we have to grow to have enough elements, destroy the current elements.
 627   // This allows us to avoid copying them during the grow.
 628   if (this->capacity() < RHSSize) {
 629     // Destroy current elements.
 630     this->destroy_range(this->begin(), this->end());
 631     this->setEnd(this->begin());
 632     CurSize = 0;
 633     this->grow(RHSSize);
 634   } else if (CurSize) {
 635     // Otherwise, use assignment for the already-constructed elements.
 636     std::copy(RHS.begin(), RHS.begin()+CurSize, this->begin());
 637   }
 638
 639   // Copy construct the new elements in place.
 640   this->uninitialized_copy(RHS.begin()+CurSize, RHS.end(),
 641                            this->begin()+CurSize);
 642
 643   // Set end.
 644   this->setEnd(this->begin()+RHSSize);
 645   return *this;
 646 }
 647
 648
 649 /// SmallVector - This is a 'vector' (really, a variable-sized array), optimized
 650 /// for the case when the array is small.  It contains some number of elements
 651 /// in-place, which allows it to avoid heap allocation when the actual number of
 652 /// elements is below that threshold.  This allows normal "small" cases to be
 653 /// fast without losing generality for large inputs.
 654 ///
 655 /// Note that this does not attempt to be exception safe.
 656 ///
 657 template <typename T, unsigned N>
 658 class SmallVector : public SmallVectorImpl<T> {
 659   /// InlineElts - These are 'N-1' elements that are stored inline in the body
 660   /// of the vector.  The extra '1' element is stored in SmallVectorImpl.
 661   typedef typename SmallVectorImpl<T>::U U;
 662   enum {
 663     // MinUs - The number of U's require to cover N T's.
 664     MinUs = (static_cast<unsigned int>(sizeof(T))*N +
 665              static_cast<unsigned int>(sizeof(U)) - 1) /
 666             static_cast<unsigned int>(sizeof(U)),
 667
 668     // NumInlineEltsElts - The number of elements actually in this array.  There
 669     // is already one in the parent class, and we have to round up to avoid
 670     // having a zero-element array.
 671     NumInlineEltsElts = MinUs > 1 ? (MinUs - 1) : 1,
 672
 673     // NumTsAvailable - The number of T's we actually have space for, which may
 674     // be more than N due to rounding.
 675     NumTsAvailable = (NumInlineEltsElts+1)*static_cast<unsigned int>(sizeof(U))/
 676                      static_cast<unsigned int>(sizeof(T))
 677   };
 678   U InlineElts[NumInlineEltsElts];
 679 public:
 680   SmallVector() : SmallVectorImpl<T>(NumTsAvailable) {
 681   }
 682
 683   explicit SmallVector(unsigned Size, const T &Value = T())
 684     : SmallVectorImpl<T>(NumTsAvailable) {
 685     this->assign(Size, Value);
 686   }
 687
 688   template<typename ItTy>
 689   SmallVector(ItTy S, ItTy E) : SmallVectorImpl<T>(NumTsAvailable) {
 690     this->append(S, E);
 691   }
 692
 693   SmallVector(const SmallVector &RHS) : SmallVectorImpl<T>(NumTsAvailable) {
 694     if (!RHS.empty())
 695       SmallVectorImpl<T>::operator=(RHS);
 696   }
 697
 698   const SmallVector &operator=(const SmallVector &RHS) {
 699     SmallVectorImpl<T>::operator=(RHS);
 700     return *this;
 701   }
 702
 703 };
 704
 705 /// Specialize SmallVector at N=0.  This specialization guarantees
 706 /// that it can be instantiated at an incomplete T if none of its
 707 /// members are required.
 708 template <typename T>
 709 class SmallVector<T,0> : public SmallVectorImpl<T> {
 710 public:
 711   SmallVector() : SmallVectorImpl<T>(0) {}
 712
 713   explicit SmallVector(unsigned Size, const T &Value = T())
 714     : SmallVectorImpl<T>(0) {
 715     this->assign(Size, Value);
 716   }
 717
 718   template<typename ItTy>
 719   SmallVector(ItTy S, ItTy E) : SmallVectorImpl<T>(0) {
 720     this->append(S, E);
 721   }
 722
 723   SmallVector(const SmallVector &RHS) : SmallVectorImpl<T>(0) {
 724     SmallVectorImpl<T>::operator=(RHS);
 725   }
 726
 727   SmallVector &operator=(const SmallVectorImpl<T> &RHS) {
 728     return SmallVectorImpl<T>::operator=(RHS);
 729   }
 730
 731 };
 732
 733 template<typename T, unsigned N>
 734 static inline size_t capacity_in_bytes(const SmallVector<T, N> &X) {
 735   return X.capacity_in_bytes();
 736 }
 737
 738 } // End llvm namespace
 739
 740 namespace std {
 741   /// Implement std::swap in terms of SmallVector swap.
 742   template<typename T>
 743   inline void
 744   swap(llvm::SmallVectorImpl<T> &LHS, llvm::SmallVectorImpl<T> &RHS) {
 745     LHS.swap(RHS);
 746   }
 747
 748   /// Implement std::swap in terms of SmallVector swap.
 749   template<typename T, unsigned N>
 750   inline void
 751   swap(llvm::SmallVector<T, N> &LHS, llvm::SmallVector<T, N> &RHS) {
 752     LHS.swap(RHS);
 753   }
 754 }
 755
 756 #endif