LLVM  14.0.0git
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | Friends | List of all members
llvm::SmallVectorTemplateBase< T, bool > Class Template Reference

SmallVectorTemplateBase<TriviallyCopyable = false> - This is where we put method implementations that are designed to work with non-trivial T's. More...

#include "llvm/ADT/SmallVector.h"

Inheritance diagram for llvm::SmallVectorTemplateBase< T, bool >:
Inheritance graph
[legend]
Collaboration diagram for llvm::SmallVectorTemplateBase< T, bool >:
Collaboration graph
[legend]

Public Member Functions

void push_back (const T &Elt)
 
void push_back (T &&Elt)
 
void pop_back ()
 
- Public Member Functions inherited from llvm::SmallVectorTemplateCommon< T >
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
size_type size_in_bytes () const
 
size_type max_size () const
 
size_t capacity_in_bytes () const
 
pointer data ()
 Return a pointer to the vector's buffer, even if empty(). More...
 
const_pointer data () const
 Return a pointer to the vector's buffer, even if empty(). More...
 
reference operator[] (size_type idx)
 
const_reference operator[] (size_type idx) const
 
reference front ()
 
const_reference front () const
 
reference back ()
 
const_reference back () const
 
- Public Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
size_t size () const
 
size_t capacity () const
 
LLVM_NODISCARD bool empty () const
 
void set_size (size_t N)
 Set the array size to N, which the current array must have enough capacity for. More...
 

Protected Types

using ValueParamT = const T &
 

Protected Member Functions

 SmallVectorTemplateBase (size_t Size)
 
void grow (size_t MinSize=0)
 Grow the allocated memory (without initializing new elements), doubling the size of the allocated memory. More...
 
T * mallocForGrow (size_t MinSize, size_t &NewCapacity)
 Create a new allocation big enough for MinSize and pass back its size in NewCapacity. More...
 
void moveElementsForGrow (T *NewElts)
 Move existing elements over to the new allocation NewElts, the middle section of grow(). More...
 
void takeAllocationForGrow (T *NewElts, size_t NewCapacity)
 Transfer ownership of the allocation, finishing up grow(). More...
 
const T * reserveForParamAndGetAddress (const T &Elt, size_t N=1)
 Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage. More...
 
T * reserveForParamAndGetAddress (T &Elt, size_t N=1)
 Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage. More...
 
void growAndAssign (size_t NumElts, const T &Elt)
 
template<typename... ArgTypes>
T & growAndEmplaceBack (ArgTypes &&... Args)
 
- Protected Member Functions inherited from llvm::SmallVectorTemplateCommon< T >
 SmallVectorTemplateCommon (size_t Size)
 
void grow_pod (size_t MinSize, size_t TSize)
 
bool isSmall () const
 Return true if this is a smallvector which has not had dynamic memory allocated for it. More...
 
void resetToSmall ()
 Put this vector in a state of being small. More...
 
bool isReferenceToRange (const void *V, const void *First, const void *Last) const
 Return true if V is an internal reference to the given range. More...
 
bool isReferenceToStorage (const void *V) const
 Return true if V is an internal reference to this vector. More...
 
bool isRangeInStorage (const void *First, const void *Last) const
 Return true if First and Last form a valid (possibly empty) range in this vector's storage. More...
 
bool isSafeToReferenceAfterResize (const void *Elt, size_t NewSize)
 Return true unless Elt will be invalidated by resizing the vector to NewSize. More...
 
void assertSafeToReferenceAfterResize (const void *Elt, size_t NewSize)
 Check whether Elt will be invalidated by resizing the vector to NewSize. More...
 
void assertSafeToAdd (const void *Elt, size_t N=1)
 Check whether Elt will be invalidated by increasing the size of the vector by N. More...
 
void assertSafeToReferenceAfterClear (const T *From, const T *To)
 Check whether any part of the range will be invalidated by clearing. More...
 
void assertSafeToReferenceAfterClear (ItTy, ItTy)
 
void assertSafeToAddRange (const T *From, const T *To)
 Check whether any part of the range will be invalidated by growing. More...
 
void assertSafeToAddRange (ItTy, ItTy)
 
- Protected Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
 SmallVectorBase ()=delete
 
 SmallVectorBase (void *FirstEl, size_t TotalCapacity)
 
void * mallocForGrow (size_t MinSize, size_t TSize, size_t &NewCapacity)
 This is a helper for grow() that's out of line to reduce code duplication. More...
 
void grow_pod (void *FirstEl, size_t MinSize, size_t TSize)
 This is an implementation of the grow() method which only works on POD-like data types and is out of line to reduce code duplication. More...
 

Static Protected Member Functions

static void destroy_range (T *S, T *E)
 
template<typename It1 , typename It2 >
static void uninitialized_move (It1 I, It1 E, It2 Dest)
 Move the range [I, E) into the uninitialized memory starting with "Dest", constructing elements as needed. More...
 
template<typename It1 , typename It2 >
static void uninitialized_copy (It1 I, It1 E, It2 Dest)
 Copy the range [I, E) onto the uninitialized memory starting with "Dest", constructing elements as needed. More...
 
static T && forward_value_param (T &&V)
 
static const T & forward_value_param (const T &V)
 
- Static Protected Member Functions inherited from llvm::SmallVectorTemplateCommon< T >
static const TreserveForParamAndGetAddressImpl (U *This, const T &Elt, size_t N)
 Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage. More...
 
- Static Protected Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
static constexpr size_t SizeTypeMax ()
 The maximum value of the Size_T used. More...
 

Static Protected Attributes

static constexpr bool TakesParamByValue = false
 

Friends

class SmallVectorTemplateCommon< T >
 

Additional Inherited Members

- Public Types inherited from llvm::SmallVectorTemplateCommon< T >
using size_type = size_t
 
using difference_type = ptrdiff_t
 
using value_type = T
 
using iterator = T *
 
using const_iterator = const T *
 
using const_reverse_iterator = std::reverse_iterator< const_iterator >
 
using reverse_iterator = std::reverse_iterator< iterator >
 
using reference = T &
 
using const_reference = const T &
 
using pointer = T *
 
using const_pointer = const T *
 
- Protected Attributes inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
void * BeginX
 
SmallVectorSizeType< TSize
 
SmallVectorSizeType< TCapacity
 

Detailed Description

template<typename T, bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
class llvm::SmallVectorTemplateBase< T, bool >

SmallVectorTemplateBase<TriviallyCopyable = false> - This is where we put method implementations that are designed to work with non-trivial T's.

We approximate is_trivially_copyable with trivial move/copy construction and trivial destruction. While the standard doesn't specify that you're allowed copy these types with memcpy, there is no way for the type to observe this. This catches the important case of std::pair<POD, POD>, which is not trivially assignable.

Definition at line 315 of file SmallVector.h.

Member Typedef Documentation

◆ ValueParamT

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
using llvm::SmallVectorTemplateBase< T, bool >::ValueParamT = const T &
protected

Definition at line 320 of file SmallVector.h.

Constructor & Destructor Documentation

◆ SmallVectorTemplateBase()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
llvm::SmallVectorTemplateBase< T, bool >::SmallVectorTemplateBase ( size_t  Size)
inlineprotected

Definition at line 322 of file SmallVector.h.

Member Function Documentation

◆ destroy_range()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
static void llvm::SmallVectorTemplateBase< T, bool >::destroy_range ( T *  S,
T *  E 
)
inlinestaticprotected

Definition at line 324 of file SmallVector.h.

References E, and S.

Referenced by llvm::SmallVectorTemplateBase< T, bool >::growAndAssign().

◆ forward_value_param() [1/2]

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
static const T& llvm::SmallVectorTemplateBase< T, bool >::forward_value_param ( const T &  V)
inlinestaticprotected

Definition at line 380 of file SmallVector.h.

◆ forward_value_param() [2/2]

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
static T&& llvm::SmallVectorTemplateBase< T, bool >::forward_value_param ( T &&  V)
inlinestaticprotected

Definition at line 379 of file SmallVector.h.

References move.

◆ grow()

template<typename T , bool TriviallyCopyable>
void llvm::SmallVectorTemplateBase< T, TriviallyCopyable >::grow ( size_t  MinSize = 0)
protected

Grow the allocated memory (without initializing new elements), doubling the size of the allocated memory.

Guarantees space for at least one more element, or MinSize more elements if specified.

Definition at line 424 of file SmallVector.h.

References T.

Referenced by llvm::SmallVectorTemplateBase< T, true >::growAndAssign().

◆ growAndAssign()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void llvm::SmallVectorTemplateBase< T, bool >::growAndAssign ( size_t  NumElts,
const T &  Elt 
)
inlineprotected

◆ growAndEmplaceBack()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
template<typename... ArgTypes>
T& llvm::SmallVectorTemplateBase< T, bool >::growAndEmplaceBack ( ArgTypes &&...  Args)
inlineprotected

◆ mallocForGrow()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
T* llvm::SmallVectorTemplateBase< T, bool >::mallocForGrow ( size_t  MinSize,
size_t NewCapacity 
)
inlineprotected

Create a new allocation big enough for MinSize and pass back its size in NewCapacity.

This is the first section of grow().

Definition at line 353 of file SmallVector.h.

References T.

Referenced by llvm::SmallVectorTemplateBase< T, bool >::growAndAssign(), and llvm::SmallVectorTemplateBase< T, bool >::growAndEmplaceBack().

◆ moveElementsForGrow()

template<typename T , bool TriviallyCopyable>
void llvm::SmallVectorTemplateBase< T, TriviallyCopyable >::moveElementsForGrow ( T *  NewElts)
protected

Move existing elements over to the new allocation NewElts, the middle section of grow().

Definition at line 433 of file SmallVector.h.

References llvm::sys::path::begin(), and llvm::sys::path::end().

Referenced by llvm::SmallVectorTemplateBase< T, bool >::growAndEmplaceBack().

◆ pop_back()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void llvm::SmallVectorTemplateBase< T, bool >::pop_back ( )
inline

◆ push_back() [1/2]

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void llvm::SmallVectorTemplateBase< T, bool >::push_back ( const T &  Elt)
inline

◆ push_back() [2/2]

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void llvm::SmallVectorTemplateBase< T, bool >::push_back ( T &&  Elt)
inline

◆ reserveForParamAndGetAddress() [1/2]

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
const T* llvm::SmallVectorTemplateBase< T, bool >::reserveForParamAndGetAddress ( const T &  Elt,
size_t  N = 1 
)
inlineprotected

Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage.

Definition at line 368 of file SmallVector.h.

References N, and llvm::SmallVectorTemplateCommon< T >::reserveForParamAndGetAddressImpl().

Referenced by llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::SmallVectorTemplateBase< T, true >::push_back().

◆ reserveForParamAndGetAddress() [2/2]

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
T* llvm::SmallVectorTemplateBase< T, bool >::reserveForParamAndGetAddress ( T &  Elt,
size_t  N = 1 
)
inlineprotected

Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage.

Definition at line 374 of file SmallVector.h.

References N, llvm::SmallVectorTemplateCommon< T >::reserveForParamAndGetAddressImpl(), and T.

◆ takeAllocationForGrow()

template<typename T , bool TriviallyCopyable>
void llvm::SmallVectorTemplateBase< T, TriviallyCopyable >::takeAllocationForGrow ( T *  NewElts,
size_t  NewCapacity 
)
protected

Transfer ownership of the allocation, finishing up grow().

Definition at line 444 of file SmallVector.h.

References llvm::sys::path::begin().

Referenced by llvm::SmallVectorTemplateBase< T, bool >::growAndAssign(), and llvm::SmallVectorTemplateBase< T, bool >::growAndEmplaceBack().

◆ uninitialized_copy()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
template<typename It1 , typename It2 >
static void llvm::SmallVectorTemplateBase< T, bool >::uninitialized_copy ( It1  I,
It1  E,
It2  Dest 
)
inlinestaticprotected

Copy the range [I, E) onto the uninitialized memory starting with "Dest", constructing elements as needed.

Definition at line 342 of file SmallVector.h.

References E, and I.

Referenced by llvm::SmallVectorTemplateBase< T, true >::uninitialized_move().

◆ uninitialized_move()

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
template<typename It1 , typename It2 >
static void llvm::SmallVectorTemplateBase< T, bool >::uninitialized_move ( It1  I,
It1  E,
It2  Dest 
)
inlinestaticprotected

Move the range [I, E) into the uninitialized memory starting with "Dest", constructing elements as needed.

Definition at line 334 of file SmallVector.h.

References E, and I.

Friends And Related Function Documentation

◆ SmallVectorTemplateCommon< T >

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
friend class SmallVectorTemplateCommon< T >
friend

Definition at line 316 of file SmallVector.h.

Member Data Documentation

◆ TakesParamByValue

template<typename T , bool = (is_trivially_copy_constructible<T>::value) && (is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
constexpr bool llvm::SmallVectorTemplateBase< T, bool >::TakesParamByValue = false
staticconstexprprotected

Definition at line 319 of file SmallVector.h.


The documentation for this class was generated from the following file: