LLVM  12.0.0git
Public Member Functions | List of all members
llvm::SmallVector< T, N > Class Template Reference

This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small. More...

#include "llvm/ADT/SmallVector.h"

Inherits llvm::SmallVectorImpl< T >, and llvm::SmallVectorStorage< T, N >.

Collaboration diagram for llvm::SmallVector< T, N >:
Collaboration graph
[legend]

Public Member Functions

 SmallVector ()
 
 ~SmallVector ()
 
 SmallVector (size_t Size, const T &Value=T())
 
template<typename ItTy , typename = std::enable_if_t<std::is_convertible< typename std::iterator_traits<ItTy>::iterator_category, std::input_iterator_tag>::value>>
 SmallVector (ItTy S, ItTy E)
 
template<typename RangeTy >
 SmallVector (const iterator_range< RangeTy > &R)
 
 SmallVector (std::initializer_list< T > IL)
 
 SmallVector (const SmallVector &RHS)
 
SmallVectoroperator= (const SmallVector &RHS)
 
 SmallVector (SmallVector &&RHS)
 
 SmallVector (SmallVectorImpl< T > &&RHS)
 
SmallVectoroperator= (SmallVector &&RHS)
 
SmallVectoroperator= (SmallVectorImpl< T > &&RHS)
 
SmallVectoroperator= (std::initializer_list< T > IL)
 
- Public Member Functions inherited from llvm::SmallVectorImpl< T >
 SmallVectorImpl (const SmallVectorImpl &)=delete
 
 ~SmallVectorImpl ()
 
void clear ()
 
void resize (size_type N)
 
void resize (size_type N, const T &NV)
 
void reserve (size_type N)
 
void pop_back_n (size_type NumItems)
 
LLVM_NODISCARD T pop_back_val ()
 
void swap (SmallVectorImpl &RHS)
 
template<typename in_iter , typename = std::enable_if_t<std::is_convertible< typename std::iterator_traits<in_iter>::iterator_category, std::input_iterator_tag>::value>>
void append (in_iter in_start, in_iter in_end)
 Add the specified range to the end of the SmallVector. More...
 
void append (size_type NumInputs, const T &Elt)
 Append NumInputs copies of Elt to the end. More...
 
void append (std::initializer_list< T > IL)
 
void assign (size_type NumElts, const T &Elt)
 
template<typename in_iter , typename = std::enable_if_t<std::is_convertible< typename std::iterator_traits<in_iter>::iterator_category, std::input_iterator_tag>::value>>
void assign (in_iter in_start, in_iter in_end)
 
void assign (std::initializer_list< T > IL)
 
iterator erase (const_iterator CI)
 
iterator erase (const_iterator CS, const_iterator CE)
 
iterator insert (iterator I, T &&Elt)
 
iterator insert (iterator I, const T &Elt)
 
iterator insert (iterator I, size_type NumToInsert, const T &Elt)
 
template<typename ItTy , typename = std::enable_if_t<std::is_convertible< typename std::iterator_traits<ItTy>::iterator_category, std::input_iterator_tag>::value>>
iterator insert (iterator I, ItTy From, ItTy To)
 
void insert (iterator I, std::initializer_list< T > IL)
 
template<typename... ArgTypes>
reference emplace_back (ArgTypes &&... Args)
 
SmallVectorImploperator= (const SmallVectorImpl &RHS)
 
SmallVectorImploperator= (SmallVectorImpl &&RHS)
 
bool operator== (const SmallVectorImpl &RHS) const
 
bool operator!= (const SmallVectorImpl &RHS) const
 
bool operator< (const SmallVectorImpl &RHS) const
 
- Public Member Functions inherited from llvm::SmallVectorTemplateBase< T >
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...
 

Additional Inherited Members

- Public Types inherited from llvm::SmallVectorImpl< T >
using iterator = typename SuperClass::iterator
 
using const_iterator = typename SuperClass::const_iterator
 
using reference = typename SuperClass::reference
 
using size_type = typename SuperClass::size_type
 
- 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 Member Functions inherited from llvm::SmallVectorImpl< T >
 SmallVectorImpl (unsigned N)
 
- Protected Member Functions inherited from llvm::SmallVectorTemplateBase< T >
 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...
 
- 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 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)
 
void assertSafeToEmplace (ArgType1 &Arg1, ArgTypes &... Args)
 Check whether any argument will be invalidated by growing for emplace_back. More...
 
void assertSafeToEmplace ()
 
- Protected Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
 SmallVectorBase ()=delete
 
 SmallVectorBase (void *FirstEl, size_t TotalCapacity)
 
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 inherited from llvm::SmallVectorTemplateBase< T >
static void destroy_range (T *S, T *E)
 
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...
 
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 Protected Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
static constexpr size_t SizeTypeMax ()
 The maximum value of the Size_T used. More...
 
static LLVM_ATTRIBUTE_NORETURN void report_size_overflow (size_t MinSize)
 Report that MinSize doesn't fit into this vector's size type. More...
 
static LLVM_ATTRIBUTE_NORETURN void report_at_maximum_capacity ()
 Report that this vector is already at maximum capacity. More...
 
- Protected Attributes inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
void * BeginX
 
SmallVectorSizeType< TSize
 
SmallVectorSizeType< TCapacity
 

Detailed Description

template<typename T, unsigned N>
class llvm::SmallVector< T, N >

This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.

It contains some number of elements in-place, which allows it to avoid heap allocation when the actual number of elements is below that threshold. This allows normal "small" cases to be fast without losing generality for large inputs.

Note that this does not attempt to be exception safe.

Definition at line 960 of file SmallVector.h.

Constructor & Destructor Documentation

◆ SmallVector() [1/8]

template<typename T, unsigned N>
llvm::SmallVector< T, N >::SmallVector ( )
inline

Definition at line 963 of file SmallVector.h.

◆ ~SmallVector()

template<typename T, unsigned N>
llvm::SmallVector< T, N >::~SmallVector ( )
inline

Definition at line 965 of file SmallVector.h.

◆ SmallVector() [2/8]

template<typename T, unsigned N>
llvm::SmallVector< T, N >::SmallVector ( size_t  Size,
const T Value = T() 
)
inlineexplicit

Definition at line 970 of file SmallVector.h.

◆ SmallVector() [3/8]

template<typename T, unsigned N>
template<typename ItTy , typename = std::enable_if_t<std::is_convertible< typename std::iterator_traits<ItTy>::iterator_category, std::input_iterator_tag>::value>>
llvm::SmallVector< T, N >::SmallVector ( ItTy  S,
ItTy  E 
)
inline

Definition at line 979 of file SmallVector.h.

◆ SmallVector() [4/8]

template<typename T, unsigned N>
template<typename RangeTy >
llvm::SmallVector< T, N >::SmallVector ( const iterator_range< RangeTy > &  R)
inlineexplicit

Definition at line 984 of file SmallVector.h.

◆ SmallVector() [5/8]

template<typename T, unsigned N>
llvm::SmallVector< T, N >::SmallVector ( std::initializer_list< T IL)
inline

Definition at line 989 of file SmallVector.h.

◆ SmallVector() [6/8]

template<typename T, unsigned N>
llvm::SmallVector< T, N >::SmallVector ( const SmallVector< T, N > &  RHS)
inline

Definition at line 993 of file SmallVector.h.

◆ SmallVector() [7/8]

template<typename T, unsigned N>
llvm::SmallVector< T, N >::SmallVector ( SmallVector< T, N > &&  RHS)
inline

Definition at line 1003 of file SmallVector.h.

◆ SmallVector() [8/8]

template<typename T, unsigned N>
llvm::SmallVector< T, N >::SmallVector ( SmallVectorImpl< T > &&  RHS)
inline

Definition at line 1008 of file SmallVector.h.

Member Function Documentation

◆ operator=() [1/4]

template<typename T, unsigned N>
SmallVector& llvm::SmallVector< T, N >::operator= ( const SmallVector< T, N > &  RHS)
inline

Definition at line 998 of file SmallVector.h.

◆ operator=() [2/4]

template<typename T, unsigned N>
SmallVector& llvm::SmallVector< T, N >::operator= ( SmallVector< T, N > &&  RHS)
inline

Definition at line 1013 of file SmallVector.h.

◆ operator=() [3/4]

template<typename T, unsigned N>
SmallVector& llvm::SmallVector< T, N >::operator= ( SmallVectorImpl< T > &&  RHS)
inline

Definition at line 1018 of file SmallVector.h.

◆ operator=() [4/4]

template<typename T, unsigned N>
SmallVector& llvm::SmallVector< T, N >::operator= ( std::initializer_list< T IL)
inline

Definition at line 1023 of file SmallVector.h.


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