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

#include "llvm/ADT/SmallVector.h"

Inheritance diagram for llvm::SmallVectorTemplateBase< T, true >:

[legend]

Public Member Functions
void	push_back (ValueParamT Elt)
void	pop_back ()
Public Member Functions inherited from llvm::SmallVectorTemplateCommon< T, typename >
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().
const_pointer	data () const
	Return a pointer to the vector's buffer, even if empty().
reference	operator[] (size_type idx)
const_reference	operator[] (size_type idx) const
reference	front ()
const_reference	front () const
reference	back ()
const_reference	back () const
size_t	capacity () const
bool	empty () const
size_t	size () const
Public Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
size_t	size () const
size_t	capacity () const
bool	empty () const

Protected Types
using	ValueParamT = std::conditional_t<TakesParamByValue, T, const T &>
	Either const T& or T, depending on whether it's cheap enough to take parameters by value.

Protected Member Functions
	SmallVectorTemplateBase (size_t Size)
void	grow (size_t MinSize=0)
	Double the size of the allocated memory, guaranteeing space for at least one more element or MinSize if specified.
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.
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.
void	growAndAssign (size_t NumElts, T Elt)
template<typename... ArgTypes>
T &	growAndEmplaceBack (ArgTypes &&... Args)
T *	mallocForGrow (size_t MinSize, size_t &NewCapacity)
	Create a new allocation big enough for `MinSize` and pass back its size in `NewCapacity`.
void	moveElementsForGrow (T *NewElts)
	Move existing elements over to the new allocation `NewElts`, the middle section of grow().
void	takeAllocationForGrow (T *NewElts, size_t NewCapacity)
	Transfer ownership of the allocation, finishing up grow().
Protected Member Functions inherited from llvm::SmallVectorTemplateCommon< T, typename >
void *	getFirstEl () const
	Find the address of the first element.
	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.
void	resetToSmall ()
	Put this vector in a state of being small.
bool	isReferenceToRange (const void V, const void First, const void *Last) const
	Return true if V is an internal reference to the given range.
bool	isReferenceToStorage (const void *V) const
	Return true if V is an internal reference to this vector.
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.
bool	isSafeToReferenceAfterResize (const void *Elt, size_t NewSize)
	Return true unless Elt will be invalidated by resizing the vector to NewSize.
void	assertSafeToReferenceAfterResize (const void *Elt, size_t NewSize)
	Check whether Elt will be invalidated by resizing the vector to NewSize.
void	assertSafeToAdd (const void *Elt, size_t N=1)
	Check whether Elt will be invalidated by increasing the size of the vector by N.
template<class ItTy>
void	assertSafeToReferenceAfterClear (ItTy From, ItTy To)
	Check whether any part of the range will be invalidated by clearing.
template<class ItTy>
void	assertSafeToAddRange (ItTy From, ItTy To)
	Check whether any part of the range will be invalidated by growing.
Protected Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
	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 void	destroy_range (T , T )
template<typename It1, typename It2>
static void	uninitialized_move (It1 I, It1 E, It2 Dest)
	Move the range [I, E) onto the uninitialized memory starting with "Dest", constructing elements into it as needed.
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 into it as needed.
static ValueParamT	forward_value_param (ValueParamT V)
	Copy `V` or return a reference, depending on ValueParamT.
Static Protected Member Functions inherited from llvm::SmallVectorTemplateCommon< T, typename >
template<class U>
static const T *	reserveForParamAndGetAddressImpl (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.
Static Protected Member Functions inherited from llvm::SmallVectorBase< SmallVectorSizeType< T > >
static constexpr size_t	SizeTypeMax ()
	The maximum value of the Size_T used.

Static Protected Attributes
static constexpr bool	TakesParamByValue = sizeof(T) <= 2 * sizeof(void *)
	True if it's cheap enough to take parameters by value.

Friends
class	SmallVectorTemplateCommon< T >

Additional Inherited Members
Public Types inherited from llvm::SmallVectorTemplateCommon< T, typename >
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< T >	Size
SmallVectorSizeType< T >	Capacity

Detailed Description

template<typename T>
class llvm::SmallVectorTemplateBase< T, true >

SmallVectorTemplateBase<TriviallyCopyable = true> - This is where we put method implementations that are designed to work with trivially copyable T's.

This allows using memcpy in place of copy/move construction and skipping destruction.

Definition at line 478 of file SmallVector.h.

Member Typedef Documentation

◆ ValueParamT

template<typename T>

using llvm::SmallVectorTemplateBase< T, true >::ValueParamT = std::conditional_t<TakesParamByValue, T, const T &>

protected

Either const T& or T, depending on whether it's cheap enough to take parameters by value.

Definition at line 488 of file SmallVector.h.

Constructor & Destructor Documentation

◆ SmallVectorTemplateBase()

template<typename T>

llvm::SmallVectorTemplateBase< T, true >::SmallVectorTemplateBase ( size_t Size )

inlineprotected

Definition at line 490 of file SmallVector.h.

References llvm::SmallVectorBase< SmallVectorSizeType< T > >::Size, llvm::SmallVectorTemplateCommon< T, typename >::SmallVectorTemplateCommon(), and T.

Member Function Documentation

◆ destroy_range()

template<typename T>

void llvm::SmallVectorTemplateBase< T, true >::destroy_range	(	T *	,
		T *	)

inlinestaticprotected

Definition at line 493 of file SmallVector.h.

References T.

◆ forward_value_param()

template<typename T>

ValueParamT llvm::SmallVectorTemplateBase< T, true >::forward_value_param ( ValueParamT V )

inlinestaticprotected

Copy V or return a reference, depending on ValueParamT.

Definition at line 541 of file SmallVector.h.

◆ grow()

template<typename T>

void llvm::SmallVectorTemplateBase< T, true >::grow ( size_t MinSize = 0 )

inlineprotected

Double the size of the allocated memory, guaranteeing space for at least one more element or MinSize if specified.

Definition at line 525 of file SmallVector.h.

References llvm::SmallVectorTemplateCommon< T, typename >::grow_pod(), and T.

◆ growAndAssign()

template<typename T>

void llvm::SmallVectorTemplateBase< T, true >::growAndAssign	(	size_t	NumElts,
		T	Elt )

inlineprotected

Definition at line 543 of file SmallVector.h.

References llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::SmallVectorTemplateBase< T, bool >::grow(), llvm::SmallVectorBase< SmallVectorSizeType< T > >::set_size(), and T.

◆ growAndEmplaceBack()

template<typename T>

template<typename... ArgTypes>

T & llvm::SmallVectorTemplateBase< T, true >::growAndEmplaceBack ( ArgTypes &&... Args )

inlineprotected

Definition at line 552 of file SmallVector.h.

References llvm::SmallVectorTemplateCommon< T, typename >::back(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and T.

◆ mallocForGrow()

T * llvm::SmallVectorTemplateBase< T, TriviallyCopyable >::mallocForGrow	(	size_t	MinSize,
		size_t &	NewCapacity )

protected

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 369 of file SmallVector.h.

◆ moveElementsForGrow()

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 373 of file SmallVector.h.

◆ pop_back()

template<typename T>

void llvm::SmallVectorTemplateBase< T, true >::pop_back ( )

inline

Definition at line 567 of file SmallVector.h.

References llvm::SmallVectorBase< SmallVectorSizeType< T > >::set_size(), and llvm::SmallVectorTemplateCommon< T, typename >::size().

◆ push_back()

template<typename T>

void llvm::SmallVectorTemplateBase< T, true >::push_back ( ValueParamT Elt )

inline

Definition at line 561 of file SmallVector.h.

References llvm::SmallVectorTemplateCommon< T, typename >::end(), llvm::SmallVectorTemplateBase< T, bool >::reserveForParamAndGetAddress(), llvm::SmallVectorBase< SmallVectorSizeType< T > >::set_size(), llvm::SmallVectorTemplateCommon< T, typename >::size(), and T.

◆ reserveForParamAndGetAddress() [1/2]

template<typename T>

const T * llvm::SmallVectorTemplateBase< T, true >::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 529 of file SmallVector.h.

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

◆ reserveForParamAndGetAddress() [2/2]

template<typename T>

T * llvm::SmallVectorTemplateBase< T, true >::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 535 of file SmallVector.h.

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

◆ takeAllocationForGrow()

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

protected

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

Definition at line 376 of file SmallVector.h.

◆ uninitialized_copy()

template<typename T>

template<typename It1, typename It2>

void llvm::SmallVectorTemplateBase< T, true >::uninitialized_copy	(	It1	I,
		It1	E,
		It2	Dest )

inlinestaticprotected

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

Definition at line 506 of file SmallVector.h.

References E(), I, and T.

◆ uninitialized_move()

template<typename T>

template<typename It1, typename It2>

void llvm::SmallVectorTemplateBase< T, true >::uninitialized_move	(	It1	I,
		It1	E,
		It2	Dest )

inlinestaticprotected

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

Definition at line 498 of file SmallVector.h.

References E(), I, and llvm::SmallVectorTemplateBase< T, bool >::uninitialized_copy().

◆ SmallVectorTemplateCommon< T >

template<typename T>

friend class SmallVectorTemplateCommon< T >

friend

Definition at line 428 of file SmallVector.h.

Member Data Documentation

◆ TakesParamByValue

template<typename T>

bool llvm::SmallVectorTemplateBase< T, true >::TakesParamByValue = sizeof(T) <= 2 * sizeof(void *)

staticconstexprprotected

True if it's cheap enough to take parameters by value.

Doing so avoids overhead related to mitigations for reference invalidation.

Definition at line 484 of file SmallVector.h.

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

include/llvm/ADT/SmallVector.h

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ValueParamT

Constructor & Destructor Documentation

◆ SmallVectorTemplateBase()

Member Function Documentation

◆ destroy_range()

◆ forward_value_param()

◆ grow()

◆ growAndAssign()

◆ growAndEmplaceBack()

◆ mallocForGrow()

◆ moveElementsForGrow()

◆ pop_back()

◆ push_back()

◆ reserveForParamAndGetAddress() [1/2]

◆ reserveForParamAndGetAddress() [2/2]

◆ takeAllocationForGrow()

◆ uninitialized_copy()

◆ uninitialized_move()

Friends And Related Symbol Documentation

◆ SmallVectorTemplateCommon< T >

Member Data Documentation

◆ TakesParamByValue