LLVM 22.0.0git
llvm::SmallVectorBase< Size_T > Class Template Reference

This is all the stuff common to all SmallVectors. More...

#include "llvm/ADT/SmallVector.h"

Public Member Functions

size_t size () const
size_t capacity () const
bool empty () const

Protected Member Functions

 SmallVectorBase ()=delete
 SmallVectorBase (void *FirstEl, size_t TotalCapacity)
LLVM_ABI void * mallocForGrow (void *FirstEl, size_t MinSize, size_t TSize, size_t &NewCapacity)
 This is a helper for grow() that's out of line to reduce code duplication.
LLVM_ABI 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.
void set_size (size_t N)
 Set the array size to N, which the current array must have enough capacity for.
void set_allocation_range (void *Begin, size_t N)
 Set the array data pointer to Begin and capacity to N.

Static Protected Member Functions

static constexpr size_t SizeTypeMax ()
 The maximum value of the Size_T used.

Protected Attributes

void * BeginX
Size_T Size = 0
Size_T Capacity

Detailed Description

template<class Size_T>
class llvm::SmallVectorBase< Size_T >

This is all the stuff common to all SmallVectors.

The template parameter specifies the type which should be used to hold the Size and Capacity of the SmallVector, so it can be adjusted. Using 32 bit size is desirable to shrink the size of the SmallVector. Using 64 bit size is desirable for cases like SmallVector<char>, where a 32 bit size would limit the vector to ~4GB. SmallVectors are used for buffering bitcode output - which can exceed 4GB.

Definition at line 53 of file SmallVector.h.

Constructor & Destructor Documentation

◆ SmallVectorBase() [1/2]

template<class Size_T>
llvm::SmallVectorBase< Size_T >::SmallVectorBase ( )
protecteddelete

◆ SmallVectorBase() [2/2]

template<class Size_T>
llvm::SmallVectorBase< Size_T >::SmallVectorBase ( void * FirstEl,
size_t TotalCapacity )
inlineprotected

Definition at line 64 of file SmallVector.h.

Member Function Documentation

◆ capacity()

template<class Size_T>
size_t llvm::SmallVectorBase< Size_T >::capacity ( ) const
inline

◆ empty()

template<class Size_T>
bool llvm::SmallVectorBase< Size_T >::empty ( ) const
inlinenodiscard

Definition at line 82 of file SmallVector.h.

◆ grow_pod()

template<class Size_T>
void SmallVectorBase::grow_pod ( void * FirstEl,
size_t MinSize,
size_t TSize )
protected

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.

This function will report a fatal error if it cannot increase capacity.

Definition at line 146 of file SmallVector.cpp.

References BeginX, capacity(), getNewCapacity(), replaceAllocation(), llvm::safe_malloc(), llvm::safe_realloc(), set_allocation_range(), and llvm::size().

◆ mallocForGrow()

template<class Size_T>
void * SmallVectorBase::mallocForGrow ( void * FirstEl,
size_t MinSize,
size_t TSize,
size_t & NewCapacity )
protected

This is a helper for grow() that's out of line to reduce code duplication.

This function will report a fatal error if it can't grow at least to MinSize.

Definition at line 132 of file SmallVector.cpp.

References capacity(), getNewCapacity(), replaceAllocation(), and llvm::safe_malloc().

◆ set_allocation_range()

template<class Size_T>
void llvm::SmallVectorBase< Size_T >::set_allocation_range ( void * Begin,
size_t N )
inlineprotected

Set the array data pointer to Begin and capacity to N.

This does not construct or destroy any elements in the vector.

Definition at line 98 of file SmallVector.h.

Referenced by grow_pod().

◆ set_size()

template<class Size_T>
void llvm::SmallVectorBase< Size_T >::set_size ( size_t N)
inlineprotected

Set the array size to N, which the current array must have enough capacity for.

This does not construct or destroy any elements in the vector.

Definition at line 89 of file SmallVector.h.

◆ size()

template<class Size_T>
size_t llvm::SmallVectorBase< Size_T >::size ( ) const
inline

Definition at line 79 of file SmallVector.h.

◆ SizeTypeMax()

template<class Size_T>
constexpr size_t llvm::SmallVectorBase< Size_T >::SizeTypeMax ( )
inlinestaticconstexprprotected

The maximum value of the Size_T used.

Definition at line 59 of file SmallVector.h.

Referenced by llvm::SmallVectorBase< SmallVectorSizeType< T > >::set_allocation_range().

Member Data Documentation

◆ BeginX

template<class Size_T>
void* llvm::SmallVectorBase< Size_T >::BeginX
protected

Definition at line 55 of file SmallVector.h.

Referenced by grow_pod().

◆ Capacity

template<class Size_T>
Size_T llvm::SmallVectorBase< Size_T >::Capacity
protected

Definition at line 56 of file SmallVector.h.

◆ Size

template<class Size_T>
Size_T llvm::SmallVectorBase< Size_T >::Size = 0
protected

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