#include <Array.h>

Inheritance diagram for TArray< InElementType, InAllocatorType >:

Public Types
using	SizeType = typename InAllocatorType::SizeType

using	ElementType = InElementType

using	AllocatorType = InAllocatorType

using	ElementAllocatorType = std::conditional_t< AllocatorType::NeedsElementType, typename AllocatorType::template ForElementType< ElementType >, typename AllocatorType::ForAnyElementType >

using	IntrusiveUnsetOptionalStateType = TArray

using	TIterator = TIndexedContainerIterator< TArray, ElementType, SizeType >

using	TConstIterator = TIndexedContainerIterator< const TArray, const ElementType, SizeType >

using	RangedForIteratorType = TCheckedPointerIterator< ElementType, SizeType, false >

using	RangedForConstIteratorType = TCheckedPointerIterator< const ElementType, SizeType, false >

using	RangedForReverseIteratorType = TCheckedPointerIterator< ElementType, SizeType, true >

using	RangedForConstReverseIteratorType = TCheckedPointerIterator< const ElementType, SizeType, true >

Public Member Functions
UE_FORCEINLINE_HINT constexpr	TArray ()

consteval	TArray (EConstEval)

UE_FORCEINLINE_HINT	TArray (const ElementType *Ptr, SizeType Count)

template<typename OtherElementType , typename OtherSizeType >
	TArray (const TArrayView< OtherElementType, OtherSizeType > &Other)

	TArray (std::initializer_list< InElementType > InitList)

template<typename OtherElementType , typename OtherAllocator >
UE_FORCEINLINE_HINT	TArray (const TArray< OtherElementType, OtherAllocator > &Other)

UE_FORCEINLINE_HINT	TArray (const TArray &Other)

UE_FORCEINLINE_HINT	TArray (const TArray &Other, SizeType ExtraSlack)

TArray &	operator= (std::initializer_list< InElementType > InitList)

template<typename OtherAllocatorType >
TArray &	operator= (const TArray< ElementType, OtherAllocatorType > &Other)

TArray &	operator= (const TArray &Other)

template<typename OtherElementType , typename OtherSizeType >
TArray &	operator= (const TArrayView< OtherElementType, OtherSizeType > &Other)

UE_FORCEINLINE_HINT	TArray (TArray &&Other)

template<typename OtherElementType , typename OtherAllocator >
UE_FORCEINLINE_HINT	TArray (TArray< OtherElementType, OtherAllocator > &&Other)

template<typename OtherElementType >
	TArray (TArray< OtherElementType, AllocatorType > &&Other, SizeType ExtraSlack)

TArray &	operator= (TArray &&Other)

	~TArray ()

UE_NODEBUG	TArray (FIntrusiveUnsetOptionalState Tag)

UE_NODEBUG bool	operator== (FIntrusiveUnsetOptionalState Tag) const

UE_NODEBUG UE_FORCEINLINE_HINT ElementType *	GetData () UE_LIFETIMEBOUND

UE_REWRITE const ElementType *	GetData () const UE_LIFETIMEBOUND

UE_NODEBUG UE_FORCEINLINE_HINT SIZE_T	GetAllocatedSize (void) const

UE_NODEBUG UE_FORCEINLINE_HINT SizeType	GetSlack () const

UE_NODEBUG UE_FORCEINLINE_HINT void	CheckInvariants () const

UE_FORCEINLINE_HINT void	RangeCheck (SizeType Index) const

UE_FORCEINLINE_HINT void	RangeCheck (SizeType Index, SizeType Count) const

UE_NODEBUG UE_FORCEINLINE_HINT bool	IsValidIndex (SizeType Index) const

UE_REWRITE bool	IsEmpty () const

UE_REWRITE SizeType	Num () const

UE_NODEBUG UE_FORCEINLINE_HINT SIZE_T	NumBytes () const

UE_REWRITE SizeType	Max () const

UE_NODEBUG UE_FORCEINLINE_HINT ElementType &	operator[] (SizeType Index) UE_LIFETIMEBOUND

UE_REWRITE const ElementType &	operator[] (SizeType Index) const UE_LIFETIMEBOUND

ElementType	Pop (EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT ElementType	Pop (bool bAllowShrinking)

UE_NODEBUG UE_FORCEINLINE_HINT void	Push (ElementType &&Item)

UE_NODEBUG UE_FORCEINLINE_HINT void	Push (const ElementType &Item)

UE_NODEBUG UE_FORCEINLINE_HINT ElementType &	Top () UE_LIFETIMEBOUND

UE_REWRITE const ElementType &	Top () const UE_LIFETIMEBOUND

UE_NODEBUG UE_FORCEINLINE_HINT ElementType &	Last (SizeType IndexFromTheEnd=0) UE_LIFETIMEBOUND

UE_REWRITE const ElementType &	Last (SizeType IndexFromTheEnd=0) const UE_LIFETIMEBOUND

UE_FORCEINLINE_HINT void	Shrink ()

UE_NODEBUG UE_FORCEINLINE_HINT bool	Find (const ElementType &Item, SizeType &Index) const

SizeType	Find (const ElementType &Item) const

UE_NODEBUG UE_FORCEINLINE_HINT bool	FindLast (const ElementType &Item, SizeType &Index) const

SizeType	FindLast (const ElementType &Item) const

template<typename Predicate >
SizeType	FindLastByPredicate (Predicate Pred, SizeType Count) const

template<typename Predicate >
UE_NODEBUG UE_FORCEINLINE_HINT SizeType	FindLastByPredicate (Predicate Pred) const

template<typename KeyType >
SizeType	IndexOfByKey (const KeyType &Key) const

template<typename Predicate >
SizeType	IndexOfByPredicate (Predicate Pred) const

template<typename KeyType >
ElementType *	FindByKey (const KeyType &Key)

template<typename KeyType >
UE_REWRITE const ElementType *	FindByKey (const KeyType &Key) const

template<typename Predicate >
ElementType *	FindByPredicate (Predicate Pred)

template<typename Predicate >
UE_REWRITE const ElementType *	FindByPredicate (Predicate Pred) const

template<typename Predicate >
TArray< ElementType >	FilterByPredicate (Predicate Pred) const

template<typename ComparisonType >
bool	Contains (const ComparisonType &Item) const

template<typename Predicate >
UE_NODEBUG UE_FORCEINLINE_HINT bool	ContainsByPredicate (Predicate Pred) const

UE_NODEBUG bool	operator== (const TArray &OtherArray) const

UE_REWRITE bool	operator!= (const TArray &OtherArray) const

void	BulkSerialize (FArchive &Ar, bool bForcePerElementSerialization=false)

UE_NODEBUG void	CountBytes (FArchive &Ar) const

UE_FORCEINLINE_HINT SizeType	AddUninitialized ()

UE_FORCEINLINE_HINT SizeType	AddUninitialized (SizeType Count)

UE_NODEBUG UE_FORCEINLINE_HINT void	InsertUninitialized (SizeType Index)

UE_NODEBUG UE_FORCEINLINE_HINT void	InsertUninitialized (SizeType Index, SizeType Count)

void	InsertZeroed (SizeType Index)

void	InsertZeroed (SizeType Index, SizeType Count)

ElementType &	InsertZeroed_GetRef (SizeType Index) UE_LIFETIMEBOUND

void	InsertDefaulted (SizeType Index)

void	InsertDefaulted (SizeType Index, SizeType Count)

ElementType &	InsertDefaulted_GetRef (SizeType Index) UE_LIFETIMEBOUND

SizeType	Insert (std::initializer_list< ElementType > InitList, const SizeType InIndex)

template<typename OtherAllocator >
SizeType	Insert (const TArray< ElementType, OtherAllocator > &Items, const SizeType InIndex)

template<typename OtherAllocator >
SizeType	Insert (TArray< ElementType, OtherAllocator > &&Items, const SizeType InIndex)

SizeType	Insert (const ElementType *Ptr, SizeType Count, SizeType Index)

UE_FORCEINLINE_HINT void	CheckAddress (const ElementType *Addr) const

SizeType	Insert (ElementType &&Item, SizeType Index)

SizeType	Insert (const ElementType &Item, SizeType Index)

ElementType &	Insert_GetRef (ElementType &&Item, SizeType Index) UE_LIFETIMEBOUND

ElementType &	Insert_GetRef (const ElementType &Item, SizeType Index) UE_LIFETIMEBOUND

void	RemoveAt (SizeType Index, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<UE::CIntegral CountType>
UE_FORCEINLINE_HINT void	RemoveAt (SizeType Index, CountType Count, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<typename CountType >
UE_FORCEINLINE_HINT void	RemoveAt (SizeType Index, CountType Count, bool bAllowShrinking)

UE_FORCEINLINE_HINT void	RemoveAtSwap (SizeType Index, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<UE::CIntegral CountType>
UE_FORCEINLINE_HINT void	RemoveAtSwap (SizeType Index, CountType Count, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<typename CountType >
UE_NODEBUG UE_FORCEINLINE_HINT void	RemoveAtSwap (SizeType Index, CountType Count, bool bAllowShrinking)

void	Reset (SizeType NewSize=0)

void	Empty (SizeType Slack=0)

void	SetNum (SizeType NewNum, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT void	SetNum (SizeType NewNum, bool bAllowShrinking)

void	SetNumZeroed (SizeType NewNum, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT void	SetNumZeroed (SizeType NewNum, bool bAllowShrinking)

void	SetNumUninitialized (SizeType NewNum, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT void	SetNumUninitialized (SizeType NewNum, bool bAllowShrinking)

void	SetNumUnsafeInternal (SizeType NewNum)

template<typename OtherElementType , typename OtherAllocatorType >
void	Append (const TArray< OtherElementType, OtherAllocatorType > &Source)

template<typename OtherElementType , typename OtherAllocator >
void	Append (TArray< OtherElementType, OtherAllocator > &&Source)

template<typename RangeType UE_REQUIRES>
void	Append (RangeType &&Source)

void	Append (const ElementType *Ptr, SizeType Count)

UE_FORCEINLINE_HINT void	Append (std::initializer_list< ElementType > InitList)

UE_NODEBUG TArray &	operator+= (TArray &&Other)

UE_NODEBUG TArray &	operator+= (const TArray &Other)

UE_NODEBUG TArray &	operator+= (std::initializer_list< ElementType > InitList)

template<typename... ArgsType>
UE_FORCEINLINE_HINT SizeType	Emplace (ArgsType &&... Args)

template<typename... ArgsType>
UE_FORCEINLINE_HINT ElementType &	Emplace_GetRef (ArgsType &&... Args) UE_LIFETIMEBOUND

template<typename... ArgsType>
UE_FORCEINLINE_HINT void	EmplaceAt (SizeType Index, ArgsType &&... Args)

template<typename... ArgsType>
UE_FORCEINLINE_HINT ElementType &	EmplaceAt_GetRef (SizeType Index, ArgsType &&... Args) UE_LIFETIMEBOUND

UE_NODEBUG UE_FORCEINLINE_HINT SizeType	Add (ElementType &&Item)

UE_NODEBUG UE_FORCEINLINE_HINT SizeType	Add (const ElementType &Item)

UE_NODEBUG UE_FORCEINLINE_HINT ElementType &	Add_GetRef (ElementType &&Item) UE_LIFETIMEBOUND

UE_NODEBUG UE_FORCEINLINE_HINT ElementType &	Add_GetRef (const ElementType &Item) UE_LIFETIMEBOUND

SizeType	AddZeroed ()

SizeType	AddZeroed (SizeType Count)

ElementType &	AddZeroed_GetRef () UE_LIFETIMEBOUND

SizeType	AddDefaulted ()

SizeType	AddDefaulted (SizeType Count)

ElementType &	AddDefaulted_GetRef () UE_LIFETIMEBOUND

template<typename AliasElementType = ElementType>
	operator TArray< typename TContainerElementTypeCompatibility< AliasElementType >::ReinterpretType, AllocatorType > & ()

template<typename AliasElementType = ElementType>
	operator const TArray< typename TContainerElementTypeCompatibility< AliasElementType >::ReinterpretType, AllocatorType > & () const

template<typename AliasElementType = ElementType>
TArray &	operator= (TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, AllocatorType > &&Other)

template<typename OtherAllocator , typename AliasElementType = ElementType>
TArray &	operator= (const TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, OtherAllocator > &Other)

template<typename OtherAllocator , typename AliasElementType = ElementType>
SizeType	Insert (const TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, OtherAllocator > &Items, const SizeType InIndex)

template<typename OtherAllocator , typename AliasElementType = ElementType>
SizeType	Insert (TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, OtherAllocator > &&Items, const SizeType InIndex)

template<typename AliasElementType = ElementType>
void	Append (const typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType *Ptr, SizeType Count)

UE_FORCEINLINE_HINT SizeType	AddUnique (ElementType &&Item)

UE_FORCEINLINE_HINT SizeType	AddUnique (const ElementType &Item)

UE_FORCEINLINE_HINT void	Reserve (SizeType Number)

void	Init (const ElementType &Element, SizeType Number)

SizeType	RemoveSingle (const ElementType &Item)

SizeType	Remove (const ElementType &Item)

template<class PREDICATE_CLASS >
SizeType	RemoveAll (const PREDICATE_CLASS &Predicate)

template<class PREDICATE_CLASS >
SizeType	RemoveAllSwap (const PREDICATE_CLASS &Predicate, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<class PREDICATE_CLASS >
UE_NODEBUG UE_FORCEINLINE_HINT SizeType	RemoveAllSwap (const PREDICATE_CLASS &Predicate, bool bAllowShrinking)

SizeType	RemoveSingleSwap (const ElementType &Item, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT SizeType	RemoveSingleSwap (const ElementType &Item, bool bAllowShrinking)

SizeType	RemoveSwap (const ElementType &Item, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT SizeType	RemoveSwap (const ElementType &Item, bool bAllowShrinking)

UE_FORCEINLINE_HINT void	SwapMemory (SizeType FirstIndexToSwap, SizeType SecondIndexToSwap)

UE_FORCEINLINE_HINT void	Swap (SizeType FirstIndexToSwap, SizeType SecondIndexToSwap)

template<typename SearchType >
bool	FindItemByClass (SearchType *Item=nullptr, SizeType ItemIndex=nullptr, SizeType StartIndex=0) const

UE_NODEBUG TIterator	CreateIterator ()

UE_NODEBUG TConstIterator	CreateConstIterator () const

UE_NODEBUG UE_FORCEINLINE_HINT RangedForIteratorType	begin ()

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstIteratorType	begin () const

UE_NODEBUG UE_FORCEINLINE_HINT RangedForIteratorType	end ()

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstIteratorType	end () const

UE_NODEBUG UE_FORCEINLINE_HINT RangedForReverseIteratorType	rbegin ()

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstReverseIteratorType	rbegin () const

UE_NODEBUG UE_FORCEINLINE_HINT RangedForReverseIteratorType	rend ()

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstReverseIteratorType	rend () const

UE_NODEBUG void	Sort ()

template<class PREDICATE_CLASS >
UE_NODEBUG void	Sort (const PREDICATE_CLASS &Predicate)

UE_NODEBUG void	StableSort ()

template<class PREDICATE_CLASS >
UE_NODEBUG void	StableSort (const PREDICATE_CLASS &Predicate)

void	WriteMemoryImage (FMemoryImageWriter &Writer) const

void	CopyUnfrozen (const FMemoryUnfreezeContent &Context, void *Dst) const

void	ToString (const FPlatformTypeLayoutParameters &LayoutParams, FMemoryToStringContext &OutContext) const

template<class PREDICATE_CLASS >
UE_NODEBUG UE_FORCEINLINE_HINT void	Heapify (const PREDICATE_CLASS &Predicate)

UE_NODEBUG void	Heapify ()

template<class PREDICATE_CLASS >
SizeType	HeapPush (ElementType &&InItem, const PREDICATE_CLASS &Predicate)

template<class PREDICATE_CLASS >
SizeType	HeapPush (const ElementType &InItem, const PREDICATE_CLASS &Predicate)

UE_NODEBUG SizeType	HeapPush (ElementType &&InItem)

UE_NODEBUG SizeType	HeapPush (const ElementType &InItem)

template<class PREDICATE_CLASS >
void	HeapPop (ElementType &OutItem, const PREDICATE_CLASS &Predicate, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<class PREDICATE_CLASS >
UE_NODEBUG UE_FORCEINLINE_HINT void	HeapPop (ElementType &OutItem, const PREDICATE_CLASS &Predicate, bool bAllowShrinking)

UE_NODEBUG void	HeapPop (ElementType &OutItem, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT void	HeapPop (ElementType &OutItem, bool bAllowShrinking)

template<class PREDICATE_CLASS >
UE_NODEBUG void	VerifyHeap (const PREDICATE_CLASS &Predicate)

template<class PREDICATE_CLASS >
void	HeapPopDiscard (const PREDICATE_CLASS &Predicate, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<class PREDICATE_CLASS >
UE_NODEBUG UE_FORCEINLINE_HINT void	HeapPopDiscard (const PREDICATE_CLASS &Predicate, bool bAllowShrinking)

UE_NODEBUG void	HeapPopDiscard (EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT void	HeapPopDiscard (bool bAllowShrinking)

UE_NODEBUG const ElementType &	HeapTop () const UE_LIFETIMEBOUND

UE_NODEBUG ElementType &	HeapTop () UE_LIFETIMEBOUND

template<class PREDICATE_CLASS >
void	HeapRemoveAt (SizeType Index, const PREDICATE_CLASS &Predicate, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

template<class PREDICATE_CLASS >
UE_NODEBUG void	HeapRemoveAt (SizeType Index, const PREDICATE_CLASS &Predicate, bool bAllowShrinking)

UE_NODEBUG void	HeapRemoveAt (SizeType Index, EAllowShrinking AllowShrinking=UE::Core::Private::AllowShrinkingByDefault< AllocatorType >())

UE_NODEBUG UE_FORCEINLINE_HINT void	HeapRemoveAt (SizeType Index, bool bAllowShrinking)

template<class PREDICATE_CLASS >
UE_NODEBUG void	HeapSort (const PREDICATE_CLASS &Predicate)

UE_NODEBUG void	HeapSort ()

UE_NODEBUG const ElementAllocatorType &	GetAllocatorInstance () const

UE_NODEBUG ElementAllocatorType &	GetAllocatorInstance ()

template<typename OtherElementType , typename OtherSizeType >
UE_FORCEINLINE_HINT	TArray (const TArrayView< OtherElementType, OtherSizeType > &Other)

template<typename OtherElementType , typename OtherSizeType >
TArray< InElementType, InAllocatorType > &	operator= (const TArrayView< OtherElementType, OtherSizeType > &Other)

Static Public Member Functions
UE_NODEBUG static UE_FORCEINLINE_HINT constexpr uint32	GetTypeSize ()

static void	AppendHash (const FPlatformTypeLayoutParameters &LayoutParams, FSHA1 &Hasher)

Static Public Attributes
static constexpr bool	bHasIntrusiveUnsetOptionalState = true

Protected Attributes
ElementAllocatorType	AllocatorInstance

SizeType	ArrayNum

SizeType	ArrayMax

Friends
template<typename OtherInElementType , typename OtherAllocator >
class	TArray
	Array that allocates elements on the heap.

template<typename ElementType , typename AllocatorType >
class	TIndirectArray

struct	TArrayPrivateFriend

Detailed Description

template<typename InElementType, typename InAllocatorType>
class TArray< InElementType, InAllocatorType >

Templated dynamic array

A dynamically sized array of typed elements. Makes the assumption that your elements are relocate-able; i.e. that they can be transparently moved to new memory without a copy constructor. The main implication is that pointers to elements in the TArray may be invalidated by adding or removing other elements to the array. Removal of elements is O(N) and invalidates the indices of subsequent elements.

Caution: as noted below some methods are not safe for element types that require constructors.

Examples: /work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

Member Typedef Documentation

◆ AllocatorType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::AllocatorType = InAllocatorType

◆ ElementAllocatorType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::ElementAllocatorType = std::conditional_t< AllocatorType::NeedsElementType, typename AllocatorType::template ForElementType<ElementType>, typename AllocatorType::ForAnyElementType >

◆ ElementType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::ElementType = InElementType

◆ IntrusiveUnsetOptionalStateType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::IntrusiveUnsetOptionalStateType = TArray

◆ RangedForConstIteratorType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::RangedForConstIteratorType = TCheckedPointerIterator<const ElementType, SizeType, false>

◆ RangedForConstReverseIteratorType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::RangedForConstReverseIteratorType = TCheckedPointerIterator<const ElementType, SizeType, true>

◆ RangedForIteratorType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::RangedForIteratorType = TCheckedPointerIterator< ElementType, SizeType, false>

◆ RangedForReverseIteratorType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::RangedForReverseIteratorType = TCheckedPointerIterator< ElementType, SizeType, true>

◆ SizeType

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::SizeType = typename InAllocatorType::SizeType

◆ TConstIterator

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::TConstIterator = TIndexedContainerIterator<const TArray, const ElementType, SizeType>

◆ TIterator

template<typename InElementType , typename InAllocatorType >

using TArray< InElementType, InAllocatorType >::TIterator = TIndexedContainerIterator< TArray, ElementType, SizeType>

Constructor & Destructor Documentation

◆ TArray() [1/13]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT constexpr TArray< InElementType, InAllocatorType >::TArray ( )

inlineconstexpr

Constructor, initializes element number counters.

◆ TArray() [2/13]

template<typename InElementType , typename InAllocatorType >

consteval TArray< InElementType, InAllocatorType >::TArray ( EConstEval )

inlineexplicit

Explicit consteval constructor for allocators that require zero-initialization of members for constant initialization

◆ TArray() [3/13]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray	(	const ElementType *	Ptr,
		SizeType	Count
	)

inline

Constructor from a raw array of elements.

Parameters

Ptr	A pointer to an array of elements to copy.
Count	The number of elements to copy from Ptr.

See also: Append

◆ TArray() [4/13]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherSizeType >

TArray< InElementType, InAllocatorType >::TArray ( const TArrayView< OtherElementType, OtherSizeType > & Other )

explicit

◆ TArray() [5/13]

template<typename InElementType , typename InAllocatorType >

TArray< InElementType, InAllocatorType >::TArray ( std::initializer_list< InElementType > InitList )

inline

Initializer list constructor

◆ TArray() [6/13]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherAllocator >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray ( const TArray< OtherElementType, OtherAllocator > & Other )

inlineexplicit

Copy constructor with changed allocator. Use the common routine to perform the copy.

Parameters

Other The source array to copy.

◆ TArray() [7/13]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray ( const TArray< InElementType, InAllocatorType > & Other )

inline

Copy constructor. Use the common routine to perform the copy.

Parameters

Other The source array to copy.

◆ TArray() [8/13]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray	(	const TArray< InElementType, InAllocatorType > &	Other,
		SizeType	ExtraSlack
	)

inline

Copy constructor. Use the common routine to perform the copy.

Parameters

Other	The source array to copy.
ExtraSlack	Tells how much extra memory should be preallocated at the end of the array in the number of elements.

◆ TArray() [9/13]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray ( TArray< InElementType, InAllocatorType > && Other )

inline

Move constructor.

Parameters

Other Array to move from.

◆ TArray() [10/13]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherAllocator >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray ( TArray< OtherElementType, OtherAllocator > && Other )

inlineexplicit

Move constructor.

Parameters

Other Array to move from.

◆ TArray() [11/13]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType >

TArray< InElementType, InAllocatorType >::TArray	(	TArray< OtherElementType, AllocatorType > &&	Other,
		SizeType	ExtraSlack
	)

inline

Move constructor.

Parameters

Other	Array to move from.
ExtraSlack	Tells how much extra memory should be preallocated at the end of the array in the number of elements.

◆ ~TArray()

template<typename InElementType , typename InAllocatorType >

TArray< InElementType, InAllocatorType >::~TArray ( )

inline

Destructor.

◆ TArray() [12/13]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG TArray< InElementType, InAllocatorType >::TArray ( FIntrusiveUnsetOptionalState Tag )

inlineexplicit

◆ TArray() [13/13]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherSizeType >

UE_FORCEINLINE_HINT TArray< InElementType, InAllocatorType >::TArray ( const TArrayView< OtherElementType, OtherSizeType > & Other )

Member Function Documentation

◆ Add() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::Add ( const ElementType & Item )

inline

Adds a new item to the end of the array, possibly reallocating the whole array to fit.

Parameters

Item	The item to add

Returns: Index to the new item

See also: AddDefaulted, AddUnique, AddZeroed, Append, Insert

◆ Add() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::Add ( ElementType && Item )

inline

Adds a new item to the end of the array, possibly reallocating the whole array to fit.

Move semantics version.

Parameters

Item	The item to add

Returns: Index to the new item

See also: AddDefaulted, AddUnique, AddZeroed, Append, Insert

◆ Add_GetRef() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::Add_GetRef ( const ElementType & Item )

inline

Adds a new item to the end of the array, possibly reallocating the whole array to fit.

Parameters

Item	The item to add

Returns: A reference to the newly-inserted element.

See also: AddDefaulted_GetRef, AddUnique_GetRef, AddZeroed_GetRef, Insert_GetRef

◆ Add_GetRef() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::Add_GetRef ( ElementType && Item )

inline

Adds a new item to the end of the array, possibly reallocating the whole array to fit.

Move semantics version.

Parameters

Item	The item to add

Returns: A reference to the newly-inserted element.

See also: AddDefaulted_GetRef, AddUnique_GetRef, AddZeroed_GetRef, Insert_GetRef

◆ AddDefaulted() [1/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::AddDefaulted ( )

inline

Adds new items to the end of the array, possibly reallocating the whole array to fit. The new items will be default-constructed.

Parameters

Count The number of new items to add.

Returns: Index to the first of the new items.

See also: Add, AddZeroed, AddUnique, Append, Insert

◆ AddDefaulted() [2/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::AddDefaulted ( SizeType Count )

inline

◆ AddDefaulted_GetRef()

template<typename InElementType , typename InAllocatorType >

ElementType & TArray< InElementType, InAllocatorType >::AddDefaulted_GetRef ( )

inline

Add a new item to the end of the array, possibly reallocating the whole array to fit. The new item will be default-constructed.

Returns: A reference to the newly-inserted element.

See also: Add_GetRef, AddZeroed_GetRef, AddUnique_GetRef, Insert_GetRef

◆ AddUninitialized() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::AddUninitialized ( )

inline

Adds a given number of uninitialized elements into the array.

Caution, AddUninitialized() will create elements without calling the constructor and this is not appropriate for element types that require a constructor to function properly.

Parameters

Count Number of elements to add.

Returns: Number of elements in array before addition.

◆ AddUninitialized() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::AddUninitialized ( SizeType Count )

inline

◆ AddUnique() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::AddUnique ( const ElementType & Item )

inline

Adds unique element to array if it doesn't exist.

Parameters

Item	Item to add.

Returns: Index of the element in the array.

See also: Add, AddDefaulted, AddZeroed, Append, Insert

◆ AddUnique() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::AddUnique ( ElementType && Item )

inline

Adds unique element to array if it doesn't exist.

Move semantics version.

Parameters

Item	Item to add.

Returns: Index of the element in the array.

See also: Add, AddDefaulted, AddZeroed, Append, Insert

◆ AddZeroed() [1/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::AddZeroed ( )

inline

Adds new items to the end of the array, possibly reallocating the whole array to fit. The new items will be zeroed.

Caution, AddZeroed() will create elements without calling the constructor and this is not appropriate for element types that require a constructor to function properly.

Parameters

Count The number of new items to add.

Returns: Index to the first of the new items.

See also: Add, AddDefaulted, AddUnique, Append, Insert

◆ AddZeroed() [2/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::AddZeroed ( SizeType Count )

inline

◆ AddZeroed_GetRef()

template<typename InElementType , typename InAllocatorType >

ElementType & TArray< InElementType, InAllocatorType >::AddZeroed_GetRef ( )

inline

Adds a new item to the end of the array, possibly reallocating the whole array to fit. The new item will be zeroed.

Caution, AddZeroed_GetRef() will create elements without calling the constructor and this is not appropriate for element types that require a constructor to function properly.

Returns: A reference to the newly-inserted element.

See also: Add_GetRef, AddDefaulted_GetRef, AddUnique_GetRef, Insert_GetRef

◆ Append() [1/6]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::Append	(	const ElementType *	Ptr,
		SizeType	Count
	)

inline

Adds a raw array of elements to the end of the TArray.

Parameters

Ptr	A pointer to an array of elements to add.
Count	The number of elements to insert from Ptr.

See also: Add, Insert

◆ Append() [2/6]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherAllocatorType >

void TArray< InElementType, InAllocatorType >::Append ( const TArray< OtherElementType, OtherAllocatorType > & Source )

inline

Appends the specified array to this array.

AllocatorType changing version.

Parameters

Source The array to append.

See also: Add, Insert

◆ Append() [3/6]

template<typename InElementType , typename InAllocatorType >

template<typename AliasElementType = ElementType>

void TArray< InElementType, InAllocatorType >::Append	(	const typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType *	Ptr,
		SizeType	Count
	)

inline

Adds a raw array of elements to the end of the TArray. Compatible element type version.

Parameters

Ptr	A pointer to an array of elements to add.
Count	The number of elements to insert from Ptr.

See also: Add, Insert

◆ Append() [4/6]

template<typename InElementType , typename InAllocatorType >

template<typename RangeType UE_REQUIRES>

void TArray< InElementType, InAllocatorType >::Append ( RangeType && Source )

inline

Appends the elements from a contiguous range to this array.

Parameters

Source The range of elements to append.

See also: Add, Insert

◆ Append() [5/6]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Append ( std::initializer_list< ElementType > InitList )

inline

Adds an initializer list of elements to the end of the TArray.

Parameters

InitList The initializer list of elements to add.

See also: Add, Insert

◆ Append() [6/6]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherAllocator >

void TArray< InElementType, InAllocatorType >::Append ( TArray< OtherElementType, OtherAllocator > && Source )

inline

Appends the specified array to this array.

Parameters

Source The array to append.

See also: Add, Insert

◆ AppendHash()

template<typename InElementType , typename InAllocatorType >

static void TArray< InElementType, InAllocatorType >::AppendHash	(	const FPlatformTypeLayoutParameters &	LayoutParams,
		FSHA1 &	Hasher
	)

inlinestatic

◆ begin() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForIteratorType TArray< InElementType, InAllocatorType >::begin ( )

inline

DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support.

◆ begin() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstIteratorType TArray< InElementType, InAllocatorType >::begin ( ) const

inline

◆ BulkSerialize()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::BulkSerialize	(	FArchive &	Ar,
		bool	bForcePerElementSerialization = `false`
	)

inline

Bulk serialize array as a single memory blob when loading. Uses regular serialization code for saving and doesn't serialize at all otherwise (e.g. transient, garbage collection, ...).

Requirements:

T's << operator needs to serialize ALL member variables in the SAME order they are layed out in memory.
T's << operator can NOT perform any fixup operations. This limitation can be lifted by manually copying the code after the BulkSerialize call.
T can NOT contain any member variables requiring constructor calls or pointers
sizeof(ElementType) must be equal to the sum of sizes of it's member variables.
- e.g. use pragma pack (push,1)/ (pop) to ensure alignment
- match up uint8/ WORDs so everything always end up being properly aligned
Code can not rely on serialization of T if neither IsLoading() nor IsSaving() is true.
Can only be called platforms that either have the same endianness as the one the content was saved with or had the endian conversion occur in a cooking process like e.g. for consoles.

Notes:

it is safe to call BulkSerialize on TTransArrays

IMPORTANT:

This is Overridden in XeD3dResourceArray.h Please make certain changes are propagated accordingly

Parameters

Ar	FArchive to bulk serialize this TArray to/from

◆ CheckAddress()

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::CheckAddress ( const ElementType * Addr ) const

inline

Checks that the specified address is not part of an element within the container. Used for implementations to check that reference arguments aren't going to be invalidated by possible reallocation.

Parameters

Addr	The address to check.

See also: Add, Remove

◆ CheckInvariants()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::CheckInvariants ( ) const

inline

Checks array invariants: if array size is greater than or equal to zero and less than or equal to the maximum.

◆ Contains()

template<typename InElementType , typename InAllocatorType >

template<typename ComparisonType >

bool TArray< InElementType, InAllocatorType >::Contains ( const ComparisonType & Item ) const

inline

Checks if this array contains the element.

Returns: True if found. False otherwise.

See also: ContainsByPredicate, FilterByPredicate, FindByPredicate

◆ ContainsByPredicate()

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

UE_NODEBUG UE_FORCEINLINE_HINT bool TArray< InElementType, InAllocatorType >::ContainsByPredicate ( Predicate Pred ) const

inline

Checks if this array contains an element for which the predicate is true.

Parameters

Predicate to use

Returns: True if found. False otherwise.

See also: Contains, Find

◆ CopyUnfrozen()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::CopyUnfrozen	(	const FMemoryUnfreezeContent &	Context,
		void *	Dst
	)		const

inline

◆ CountBytes()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::CountBytes ( FArchive & Ar ) const

inline

Count bytes needed to serialize this array.

Parameters

Ar	Archive to count for.

◆ CreateConstIterator()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG TConstIterator TArray< InElementType, InAllocatorType >::CreateConstIterator ( ) const

inline

Creates a const iterator for the contents of this array

Returns: The const iterator.

◆ CreateIterator()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG TIterator TArray< InElementType, InAllocatorType >::CreateIterator ( )

inline

Creates an iterator for the contents of this array

Returns: The iterator.

◆ Emplace()

template<typename InElementType , typename InAllocatorType >

template<typename... ArgsType>

UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::Emplace ( ArgsType &&... Args )

inline

Constructs a new item at the end of the array, possibly reallocating the whole array to fit.

Parameters

Args	The arguments to forward to the constructor of the new item.

Returns: Index to the new item

◆ Emplace_GetRef()

template<typename InElementType , typename InAllocatorType >

template<typename... ArgsType>

UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::Emplace_GetRef ( ArgsType &&... Args )

inline

Constructs a new item at the end of the array, possibly reallocating the whole array to fit.

Parameters

Args	The arguments to forward to the constructor of the new item.

Returns: A reference to the newly-inserted element.

◆ EmplaceAt()

template<typename InElementType , typename InAllocatorType >

template<typename... ArgsType>

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::EmplaceAt	(	SizeType	Index,
		ArgsType &&...	Args
	)

inline

Constructs a new item at a specified index, possibly reallocating the whole array to fit.

Parameters

Index	The index to add the item at.
Args	The arguments to forward to the constructor of the new item.

◆ EmplaceAt_GetRef()

template<typename InElementType , typename InAllocatorType >

template<typename... ArgsType>

UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::EmplaceAt_GetRef	(	SizeType	Index,
		ArgsType &&...	Args
	)

inline

Constructs a new item at a specified index, possibly reallocating the whole array to fit.

Parameters

Index	The index to add the item at.
Args	The arguments to forward to the constructor of the new item.

Returns: A reference to the newly-inserted element.

◆ Empty()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::Empty ( SizeType Slack = 0 )

inline

Empties the array. It calls the destructors on held items if needed.

Parameters

Slack (Optional) The expected usage size after empty operation. Default is 0.

◆ end() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForIteratorType TArray< InElementType, InAllocatorType >::end ( )

inline

◆ end() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstIteratorType TArray< InElementType, InAllocatorType >::end ( ) const

inline

◆ FilterByPredicate()

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

TArray< ElementType > TArray< InElementType, InAllocatorType >::FilterByPredicate ( Predicate Pred ) const

inline

Filters the elements in the array based on a predicate functor.

Parameters

Pred	The functor to apply to each element.

Returns: TArray with the same type as this object which contains the subset of elements for which the functor returns true.

See also: FindByPredicate, ContainsByPredicate

◆ Find() [1/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::Find ( const ElementType & Item ) const

inline

Finds element within the array.

Parameters

Item	Item to look for.

Returns: Index of the found element. INDEX_NONE otherwise.

See also: FindLast, FindLastByPredicate

◆ Find() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT bool TArray< InElementType, InAllocatorType >::Find	(	const ElementType &	Item,
		SizeType &	Index
	)		const

inline

Finds element within the array.

Parameters

Item	Item to look for.
Index	Will contain the found index.

Returns: True if found. False otherwise.

See also: FindLast, FindLastByPredicate

◆ FindByKey() [1/2]

template<typename InElementType , typename InAllocatorType >

template<typename KeyType >

ElementType * TArray< InElementType, InAllocatorType >::FindByKey ( const KeyType & Key )

inline

Finds an item by key (assuming the ElementType overloads operator== for the comparison). Time Complexity: O(n), starts iteration from the beginning so better performance if Key is in the front

Parameters

Key	The key to search by.

Returns: Pointer to the first matching element, or nullptr if none is found.

See also: Find

◆ FindByKey() [2/2]

template<typename InElementType , typename InAllocatorType >

template<typename KeyType >

UE_REWRITE const ElementType * TArray< InElementType, InAllocatorType >::FindByKey ( const KeyType & Key ) const

inline

◆ FindByPredicate() [1/2]

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

ElementType * TArray< InElementType, InAllocatorType >::FindByPredicate ( Predicate Pred )

inline

Finds an element which matches a predicate functor.

Parameters

Pred	The functor to apply to each element.

Returns: Pointer to the first element for which the predicate returns true, or nullptr if none is found.

See also: FilterByPredicate, ContainsByPredicate

◆ FindByPredicate() [2/2]

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

UE_REWRITE const ElementType * TArray< InElementType, InAllocatorType >::FindByPredicate ( Predicate Pred ) const

inline

◆ FindItemByClass()

template<typename InElementType , typename InAllocatorType >

template<typename SearchType >

bool TArray< InElementType, InAllocatorType >::FindItemByClass	(	SearchType **	Item = `nullptr`,
		SizeType *	ItemIndex = `nullptr`,
		SizeType	StartIndex = `0`
	)		const

inline

Searches for the first entry of the specified type, will only work with TArray<UObject*>. Optionally return the item's index, and can specify the start index.

Parameters

Item	(Optional output) If it's not null, then it will point to the found element. Untouched if element hasn't been found.
ItemIndex	(Optional output) If it's not null, then it will be set to the position of found element in the array. Untouched if element hasn't been found.
StartIndex	(Optional) Index in array at which the function should start to look for element.

Returns: True if element was found. False otherwise.

◆ FindLast() [1/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::FindLast ( const ElementType & Item ) const

inline

Finds element within the array starting from the end.

Parameters

Item	Item to look for.

Returns: Index of the found element. INDEX_NONE otherwise.

◆ FindLast() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT bool TArray< InElementType, InAllocatorType >::FindLast	(	const ElementType &	Item,
		SizeType &	Index
	)		const

inline

Finds element within the array starting from the end.

Parameters

Item	Item to look for.
Index	Output parameter. Found index.

Returns: True if found. False otherwise.

See also: Find, FindLastByPredicate

◆ FindLastByPredicate() [1/2]

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::FindLastByPredicate ( Predicate Pred ) const

inline

Searches the array for the last occurrence of an element which matches the specified predicate.

Parameters

Pred	Predicate taking array element and returns true if element matches search criteria, false otherwise.

Returns: Index of the found element. INDEX_NONE otherwise.

◆ FindLastByPredicate() [2/2]

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

SizeType TArray< InElementType, InAllocatorType >::FindLastByPredicate	(	Predicate	Pred,
		SizeType	Count
	)		const

inline

Searches an initial subrange of the array for the last occurrence of an element which matches the specified predicate.

Parameters

Pred	Predicate taking array element and returns true if element matches search criteria, false otherwise.
Count	The number of elements from the front of the array through which to search.

Returns: Index of the found element. INDEX_NONE otherwise.

◆ GetAllocatedSize()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SIZE_T TArray< InElementType, InAllocatorType >::GetAllocatedSize ( void ) const

inline

Helper function to return the amount of memory allocated by this container. Only returns the size of allocations made directly by the container, not the elements themselves.

Returns: Number of bytes allocated by this container.

◆ GetAllocatorInstance() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG ElementAllocatorType & TArray< InElementType, InAllocatorType >::GetAllocatorInstance ( )

inline

◆ GetAllocatorInstance() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG const ElementAllocatorType & TArray< InElementType, InAllocatorType >::GetAllocatorInstance ( ) const

inline

◆ GetData() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_REWRITE const ElementType * TArray< InElementType, InAllocatorType >::GetData ( ) const

inline

Helper function for returning a typed pointer to the first array entry.

Returns: Pointer to first array entry or nullptr if ArrayMax == 0.

◆ GetData() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType * TArray< InElementType, InAllocatorType >::GetData ( )

inline

Helper function for returning a typed pointer to the first array entry.

Returns: Pointer to first array entry or nullptr if ArrayMax == 0.

◆ GetSlack()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::GetSlack ( ) const

inline

Returns the amount of slack in this array in elements.

See also: Num, Shrink

◆ GetTypeSize()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG static UE_FORCEINLINE_HINT constexpr uint32 TArray< InElementType, InAllocatorType >::GetTypeSize ( )

inlinestaticconstexpr

Helper function returning the size of the inner type.

Returns: Size in bytes of array type.

◆ Heapify() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::Heapify ( )

inline

Builds an implicit heap from the array. Assumes < operator is defined for the template type.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ Heapify() [2/2]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Heapify ( const PREDICATE_CLASS & Predicate )

inline

Implicit heaps Builds an implicit heap from the array.

Parameters

Predicate Predicate class instance.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPop() [1/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::HeapPop	(	ElementType &	OutItem,
		bool	bAllowShrinking
	)

inline

◆ HeapPop() [2/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::HeapPop	(	ElementType &	OutItem,
		const PREDICATE_CLASS &	Predicate,
		bool	bAllowShrinking
	)

inline

◆ HeapPop() [3/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

void TArray< InElementType, InAllocatorType >::HeapPop	(	ElementType &	OutItem,
		const PREDICATE_CLASS &	Predicate,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes the top element from the heap.

Parameters

OutItem	The removed item.
Predicate	Predicate class instance.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPop() [4/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::HeapPop	(	ElementType &	OutItem,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes the top element from the heap. Assumes < operator is defined for the template type.

Parameters

OutItem	The removed item.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPopDiscard() [1/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::HeapPopDiscard ( bool bAllowShrinking )

inline

◆ HeapPopDiscard() [2/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::HeapPopDiscard	(	const PREDICATE_CLASS &	Predicate,
		bool	bAllowShrinking
	)

inline

◆ HeapPopDiscard() [3/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

void TArray< InElementType, InAllocatorType >::HeapPopDiscard	(	const PREDICATE_CLASS &	Predicate,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes the top element from the heap.

Parameters

Predicate	Predicate class instance.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPopDiscard() [4/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::HeapPopDiscard ( EAllowShrinking AllowShrinking = UE::Core::Private::AllowShrinkingByDefault<AllocatorType>() )

inline

Removes the top element from the heap. Assumes < operator is defined for the template type.

Parameters

AllowShrinking (Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPush() [1/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG SizeType TArray< InElementType, InAllocatorType >::HeapPush ( const ElementType & InItem )

inline

Adds a new element to the heap. Assumes < operator is defined for the template type.

Parameters

InItem Item to be added.

Returns: The index of the new element.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPush() [2/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

SizeType TArray< InElementType, InAllocatorType >::HeapPush	(	const ElementType &	InItem,
		const PREDICATE_CLASS &	Predicate
	)

inline

Adds a new element to the heap.

Parameters

InItem	Item to be added.
Predicate	Predicate class instance.

Returns: The index of the new element.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPush() [3/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG SizeType TArray< InElementType, InAllocatorType >::HeapPush ( ElementType && InItem )

inline

Adds a new element to the heap. Assumes < operator is defined for the template type.

Parameters

InItem Item to be added.

Returns: The index of the new element.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapPush() [4/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

SizeType TArray< InElementType, InAllocatorType >::HeapPush	(	ElementType &&	InItem,
		const PREDICATE_CLASS &	Predicate
	)

inline

Adds a new element to the heap.

Parameters

InItem	Item to be added.
Predicate	Predicate class instance.

Returns: The index of the new element.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapRemoveAt() [1/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::HeapRemoveAt	(	SizeType	Index,
		bool	bAllowShrinking
	)

inline

◆ HeapRemoveAt() [2/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::HeapRemoveAt	(	SizeType	Index,
		const PREDICATE_CLASS &	Predicate,
		bool	bAllowShrinking
	)

inline

◆ HeapRemoveAt() [3/4]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

void TArray< InElementType, InAllocatorType >::HeapRemoveAt	(	SizeType	Index,
		const PREDICATE_CLASS &	Predicate,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes an element from the heap.

Parameters

Index	Position at which to remove item.
Predicate	Predicate class instance.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapRemoveAt() [4/4]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::HeapRemoveAt	(	SizeType	Index,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes an element from the heap. Assumes < operator is defined for the template type.

Parameters

Index	Position at which to remove item.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapSort() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::HeapSort ( )

inline

Performs heap sort on the array. Assumes < operator is defined for the template type.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your array will be heapified by the values being pointed to, rather than the pointers' values. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapSort() [2/2]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::HeapSort ( const PREDICATE_CLASS & Predicate )

inline

Performs heap sort on the array.

Parameters

Predicate Predicate class instance.

Note: : If your array contains raw pointers, they will be automatically dereferenced during heapification. Therefore, your predicate will be passed references rather than pointers. The auto-dereferencing behavior does not occur with smart pointers.

◆ HeapTop() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG const ElementType & TArray< InElementType, InAllocatorType >::HeapTop ( ) const

inline

Returns the top element from the heap (does not remove the element).

Const version.

Returns: The reference to the top element from the heap.

◆ HeapTop() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG ElementType & TArray< InElementType, InAllocatorType >::HeapTop ( )

inline

Returns the top element from the heap (does not remove the element).

Returns: The reference to the top element from the heap.

◆ IndexOfByKey()

template<typename InElementType , typename InAllocatorType >

template<typename KeyType >

SizeType TArray< InElementType, InAllocatorType >::IndexOfByKey ( const KeyType & Key ) const

inline

Finds an item by key (assuming the ElementType overloads operator== for the comparison).

Parameters

Key	The key to search by.

Returns: Index to the first matching element, or INDEX_NONE if none is found.

◆ IndexOfByPredicate()

template<typename InElementType , typename InAllocatorType >

template<typename Predicate >

SizeType TArray< InElementType, InAllocatorType >::IndexOfByPredicate ( Predicate Pred ) const

inline

Finds an item by predicate.

Parameters

Pred	The predicate to match.

Returns: Index to the first matching element, or INDEX_NONE if none is found.

◆ Init()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::Init	(	const ElementType &	Element,
		SizeType	Number
	)

inline

Sets the size of the array, filling it with the given element.

Parameters

Element	The element to fill array with.
Number	The number of elements that the array should be able to contain after allocation.

◆ Insert() [1/8]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::Insert	(	const ElementType &	Item,
		SizeType	Index
	)

inline

Inserts a given element into the array at given location.

Parameters

Item	The element to insert.
Index	Tells where to insert the new elements.

Returns: Location at which the insert was done.

See also: Add, Remove

◆ Insert() [2/8]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::Insert	(	const ElementType *	Ptr,
		SizeType	Count,
		SizeType	Index
	)

inline

Inserts a raw array of elements at a particular index in the TArray.

Parameters

Ptr	A pointer to an array of elements to add.
Count	The number of elements to insert from Ptr.
Index	The index to insert the elements at.

Returns: The index of the first element inserted.

See also: Add, Remove

◆ Insert() [3/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherAllocator >

SizeType TArray< InElementType, InAllocatorType >::Insert	(	const TArray< ElementType, OtherAllocator > &	Items,
		const SizeType	InIndex
	)

inline

Inserts given elements into the array at given location.

Parameters

Items	Array of elements to insert.
InIndex	Tells where to insert the new elements.

Returns: Location at which the item was inserted.

◆ Insert() [4/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherAllocator , typename AliasElementType = ElementType>

SizeType TArray< InElementType, InAllocatorType >::Insert	(	const TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, OtherAllocator > &	Items,
		const SizeType	InIndex
	)

inline

Inserts given elements into the array at given location. Compatible element type version.

Parameters

Items	Array of elements to insert.
InIndex	Tells where to insert the new elements.

Returns: Location at which the item was inserted.

◆ Insert() [5/8]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::Insert	(	ElementType &&	Item,
		SizeType	Index
	)

inline

Inserts a given element into the array at given location. Move semantics version.

Parameters

Item	The element to insert.
Index	Tells where to insert the new elements.

Returns: Location at which the insert was done.

See also: Add, Remove

◆ Insert() [6/8]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::Insert	(	std::initializer_list< ElementType >	InitList,
		const SizeType	InIndex
	)

inline

Inserts given elements into the array at given location.

Parameters

InitList	Array of elements to insert.
InIndex	Tells where to insert the new elements.

Returns: Location at which the item was inserted.

◆ Insert() [7/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherAllocator >

SizeType TArray< InElementType, InAllocatorType >::Insert	(	TArray< ElementType, OtherAllocator > &&	Items,
		const SizeType	InIndex
	)

inline

Inserts given elements into the array at given location.

Parameters

Items	Array of elements to insert.
InIndex	Tells where to insert the new elements.

Returns: Location at which the item was inserted.

◆ Insert() [8/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherAllocator , typename AliasElementType = ElementType>

SizeType TArray< InElementType, InAllocatorType >::Insert	(	TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, OtherAllocator > &&	Items,
		const SizeType	InIndex
	)

inline

Inserts given elements into the array at given location. Compatible element type version.

Parameters

Items	Array of elements to insert.
InIndex	Tells where to insert the new elements.

Returns: Location at which the item was inserted.

◆ Insert_GetRef() [1/2]

template<typename InElementType , typename InAllocatorType >

ElementType & TArray< InElementType, InAllocatorType >::Insert_GetRef	(	const ElementType &	Item,
		SizeType	Index
	)

inline

Inserts a given element into the array at given location.

Parameters

Item	The element to insert.
Index	Tells where to insert the new element.

Returns: A reference to the newly-inserted element.

See also: Add, Remove

◆ Insert_GetRef() [2/2]

template<typename InElementType , typename InAllocatorType >

ElementType & TArray< InElementType, InAllocatorType >::Insert_GetRef	(	ElementType &&	Item,
		SizeType	Index
	)

inline

Inserts a given element into the array at given location. Move semantics version.

Parameters

Item	The element to insert.
Index	Tells where to insert the new element.

Returns: A reference to the newly-inserted element.

See also: Add, Remove

◆ InsertDefaulted() [1/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::InsertDefaulted ( SizeType Index )

inline

Inserts a given number of default-constructed elements into the array at a given location.

Parameters

Index	Tells where to insert the new elements.
Count	Number of elements to add.

See also: Insert, InsertUninitialized, InsertZeroed

◆ InsertDefaulted() [2/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::InsertDefaulted	(	SizeType	Index,
		SizeType	Count
	)

inline

◆ InsertDefaulted_GetRef()

template<typename InElementType , typename InAllocatorType >

ElementType & TArray< InElementType, InAllocatorType >::InsertDefaulted_GetRef ( SizeType Index )

inline

Inserts a default-constructed element into the array at a given location.

Parameters

Index Tells where to insert the new element.

Returns: A reference to the newly-inserted element.

See also: Insert_GetRef, InsertZeroed_GetRef

◆ InsertUninitialized() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::InsertUninitialized ( SizeType Index )

inline

Inserts a given number of uninitialized elements into the array at given location.

Caution, InsertUninitialized() will create elements without calling the constructor and this is not appropriate for element types that require a constructor to function properly.

Parameters

Index	Tells where to insert the new elements.
Count	Number of elements to add.

See also: Insert, InsertZeroed, InsertDefaulted

◆ InsertUninitialized() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::InsertUninitialized	(	SizeType	Index,
		SizeType	Count
	)

inline

◆ InsertZeroed() [1/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::InsertZeroed ( SizeType Index )

inline

Inserts a given number of zeroed elements into the array at given location.

Caution, InsertZeroed() will create elements without calling the constructor and this is not appropriate for element types that require a constructor to function properly.

Parameters

Index	Tells where to insert the new elements.
Count	Number of elements to add.

See also: Insert, InsertUninitialized, InsertDefaulted

◆ InsertZeroed() [2/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::InsertZeroed	(	SizeType	Index,
		SizeType	Count
	)

inline

◆ InsertZeroed_GetRef()

template<typename InElementType , typename InAllocatorType >

ElementType & TArray< InElementType, InAllocatorType >::InsertZeroed_GetRef ( SizeType Index )

inline

Inserts a zeroed element into the array at given location.

Caution, InsertZeroed_GetRef() will create an element without calling the constructor and this is not appropriate for element types that require a constructor to function properly.

Parameters

Index Tells where to insert the new element.

Returns: A reference to the newly-inserted element.

See also: Insert_GetRef, InsertDefaulted_GetRef

◆ IsEmpty()

template<typename InElementType , typename InAllocatorType >

UE_REWRITE bool TArray< InElementType, InAllocatorType >::IsEmpty ( ) const

inline

Returns true if the array is empty and contains no elements.

Returns: True if the array is empty.

See also: Num

◆ IsValidIndex()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT bool TArray< InElementType, InAllocatorType >::IsValidIndex ( SizeType Index ) const

inline

Tests if index is valid, i.e. greater than or equal to zero, and less than the number of elements in the array.

Parameters

Index Index to test.

Returns: True if index is valid. False otherwise.

◆ Last() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_REWRITE const ElementType & TArray< InElementType, InAllocatorType >::Last ( SizeType IndexFromTheEnd = 0 ) const

inline

◆ Last() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::Last ( SizeType IndexFromTheEnd = 0 )

inline

Returns n-th last element from the array.

Parameters

IndexFromTheEnd (Optional) Index from the end of array (default = 0).

Returns: Reference to n-th last element from the array.

◆ Max()

template<typename InElementType , typename InAllocatorType >

UE_REWRITE SizeType TArray< InElementType, InAllocatorType >::Max ( ) const

inline

Returns maximum number of elements in array.

Returns: Maximum number of elements in array.

See also: GetSlack

◆ Num()

template<typename InElementType , typename InAllocatorType >

UE_REWRITE SizeType TArray< InElementType, InAllocatorType >::Num ( ) const

inline

Returns number of elements in array.

Returns: Number of elements in array.

See also: GetSlack

◆ NumBytes()

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SIZE_T TArray< InElementType, InAllocatorType >::NumBytes ( ) const

inline

Returns: Number of bytes used, excluding slack

◆ operator const TArray< typename TContainerElementTypeCompatibility< AliasElementType >::ReinterpretType, AllocatorType > &()

template<typename InElementType , typename InAllocatorType >

template<typename AliasElementType = ElementType>

TArray< InElementType, InAllocatorType >::operator const TArray< typename TContainerElementTypeCompatibility< AliasElementType >::ReinterpretType, AllocatorType > & ( ) const

inline

Immutable implicit conversion operator to constant container of compatible element type.

◆ operator TArray< typename TContainerElementTypeCompatibility< AliasElementType >::ReinterpretType, AllocatorType > &()

template<typename InElementType , typename InAllocatorType >

template<typename AliasElementType = ElementType>

TArray< InElementType, InAllocatorType >::operator TArray< typename TContainerElementTypeCompatibility< AliasElementType >::ReinterpretType, AllocatorType > & ( )

inline

Mutable implicit conversion operator to container of compatible element type.

◆ operator!=()

template<typename InElementType , typename InAllocatorType >

UE_REWRITE bool TArray< InElementType, InAllocatorType >::operator!= ( const TArray< InElementType, InAllocatorType > & OtherArray ) const

inline

Inequality operator.

Parameters

OtherArray Array to compare.

Returns: True if this array is NOT the same as OtherArray. False otherwise.

◆ operator+=() [1/3]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG TArray & TArray< InElementType, InAllocatorType >::operator+= ( const TArray< InElementType, InAllocatorType > & Other )

inline

Appends the specified array to this array. Cannot append to self.

Parameters

Other The array to append.

◆ operator+=() [2/3]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG TArray & TArray< InElementType, InAllocatorType >::operator+= ( std::initializer_list< ElementType > InitList )

inline

Appends the specified initializer list to this array.

Parameters

InitList The initializer list to append.

◆ operator+=() [3/3]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG TArray & TArray< InElementType, InAllocatorType >::operator+= ( TArray< InElementType, InAllocatorType > && Other )

inline

Appends the specified array to this array. Cannot append to self.

Move semantics version.

Parameters

Other The array to append.

◆ operator=() [1/8]

template<typename InElementType , typename InAllocatorType >

TArray & TArray< InElementType, InAllocatorType >::operator= ( const TArray< InElementType, InAllocatorType > & Other )

inline

Assignment operator. First deletes all currently contained elements and then copies from other array.

Parameters

Other The source array to assign from.

◆ operator=() [2/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherAllocatorType >

TArray & TArray< InElementType, InAllocatorType >::operator= ( const TArray< ElementType, OtherAllocatorType > & Other )

inline

Assignment operator. First deletes all currently contained elements and then copies from other array.

AllocatorType changing version.

Parameters

Other The source array to assign from.

◆ operator=() [3/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherAllocator , typename AliasElementType = ElementType>

TArray & TArray< InElementType, InAllocatorType >::operator= ( const TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, OtherAllocator > & Other )

inline

Assignment operator. First deletes all currently contained elements and then copies from other array. Compatible element type version.

Parameters

Other The source array to assign from.

◆ operator=() [4/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherSizeType >

TArray & TArray< InElementType, InAllocatorType >::operator= ( const TArrayView< OtherElementType, OtherSizeType > & Other )

◆ operator=() [5/8]

template<typename InElementType , typename InAllocatorType >

template<typename OtherElementType , typename OtherSizeType >

TArray< InElementType, InAllocatorType > & TArray< InElementType, InAllocatorType >::operator= ( const TArrayView< OtherElementType, OtherSizeType > & Other )

inline

◆ operator=() [6/8]

template<typename InElementType , typename InAllocatorType >

TArray & TArray< InElementType, InAllocatorType >::operator= ( std::initializer_list< InElementType > InitList )

inline

Initializer list assignment operator. First deletes all currently contained elements and then copies from initializer list.

Parameters

InitList The initializer_list to copy from.

◆ operator=() [7/8]

template<typename InElementType , typename InAllocatorType >

TArray & TArray< InElementType, InAllocatorType >::operator= ( TArray< InElementType, InAllocatorType > && Other )

inline

Move assignment operator.

Parameters

Other Array to assign and move from.

◆ operator=() [8/8]

template<typename InElementType , typename InAllocatorType >

template<typename AliasElementType = ElementType>

TArray & TArray< InElementType, InAllocatorType >::operator= ( TArray< typename TContainerElementTypeCompatibility< ElementType >::CopyFromOtherType, AllocatorType > && Other )

inline

Move assignment operator. Compatible element type version.

Parameters

Other Array to assign and move from.

◆ operator==() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG bool TArray< InElementType, InAllocatorType >::operator== ( const TArray< InElementType, InAllocatorType > & OtherArray ) const

inline

Equality operator.

Parameters

OtherArray Array to compare.

Returns: True if this array is the same as OtherArray. False otherwise.

◆ operator==() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG bool TArray< InElementType, InAllocatorType >::operator== ( FIntrusiveUnsetOptionalState Tag ) const

inline

◆ operator[]() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_REWRITE const ElementType & TArray< InElementType, InAllocatorType >::operator[] ( SizeType Index ) const

inline

Array bracket operator. Returns reference to element at given index.

Const version of the above.

Returns: Reference to indexed element.

◆ operator[]() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::operator[] ( SizeType Index )

inline

Array bracket operator. Returns reference to element at given index.

Returns: Reference to indexed element.

◆ Pop() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType TArray< InElementType, InAllocatorType >::Pop ( bool bAllowShrinking )

inline

◆ Pop() [2/2]

template<typename InElementType , typename InAllocatorType >

ElementType TArray< InElementType, InAllocatorType >::Pop ( EAllowShrinking AllowShrinking = UE::Core::Private::AllowShrinkingByDefault<AllocatorType>() )

inline

Pops element from the array.

Parameters

AllowShrinking (Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Returns: Popped element.

◆ Push() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Push ( const ElementType & Item )

inline

Pushes element into the array.

Const ref version of the above.

Parameters

Item	Item to push.

See also: Pop, Top

◆ Push() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Push ( ElementType && Item )

inline

Pushes element into the array.

Parameters

Item	Item to push.

◆ RangeCheck() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RangeCheck ( SizeType Index ) const

inline

Checks if index is in array range.

Parameters

Index Index to check.

◆ RangeCheck() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RangeCheck	(	SizeType	Index,
		SizeType	Count
	)		const

inline

Checks if a range of indices are in the array range.

Parameters

Index	Index of the start of the range to check.
Count	Number of elements in the range.

◆ rbegin() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForReverseIteratorType TArray< InElementType, InAllocatorType >::rbegin ( )

inline

◆ rbegin() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstReverseIteratorType TArray< InElementType, InAllocatorType >::rbegin ( ) const

inline

◆ Remove()

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::Remove ( const ElementType & Item )

inline

Removes as many instances of Item as there are in the array, maintaining order but not indices.

Parameters

Item	Item to remove from array.

Returns: Number of removed elements.

See also: Add, Insert, RemoveAll, RemoveAllSwap, RemoveSingle, RemoveSwap

◆ RemoveAll()

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

SizeType TArray< InElementType, InAllocatorType >::RemoveAll ( const PREDICATE_CLASS & Predicate )

inline

Remove all instances that match the predicate, maintaining order but not indices Optimized to work with runs of matches/non-matches

Parameters

Predicate Predicate class instance

Returns: Number of removed elements.

See also: Add, Insert, RemoveAllSwap, RemoveSingle, RemoveSwap

◆ RemoveAllSwap() [1/2]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::RemoveAllSwap	(	const PREDICATE_CLASS &	Predicate,
		bool	bAllowShrinking
	)

inline

◆ RemoveAllSwap() [2/2]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

SizeType TArray< InElementType, InAllocatorType >::RemoveAllSwap	(	const PREDICATE_CLASS &	Predicate,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Remove all instances that match the predicate

Parameters

Predicate	Predicate class instance
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

See also: Remove, RemoveSingle, RemoveSingleSwap, RemoveSwap

◆ RemoveAt() [1/3]

template<typename InElementType , typename InAllocatorType >

template<typename CountType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RemoveAt	(	SizeType	Index,
		CountType	Count,
		bool	bAllowShrinking
	)

inline

◆ RemoveAt() [2/3]

template<typename InElementType , typename InAllocatorType >

template<UE::CIntegral CountType>

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RemoveAt	(	SizeType	Index,
		CountType	Count,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes an element (or elements) at given location, optionally shrinking the array.

Parameters

Index	Location in array of the element to remove.
Count	(Optional) Number of elements to remove. Default is 1.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ RemoveAt() [3/3]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::RemoveAt	(	SizeType	Index,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes an element at the given location, optionally shrinking the array.

Parameters

Index	Location in array of the element to remove.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ RemoveAtSwap() [1/3]

template<typename InElementType , typename InAllocatorType >

template<typename CountType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RemoveAtSwap	(	SizeType	Index,
		CountType	Count,
		bool	bAllowShrinking
	)

inline

◆ RemoveAtSwap() [2/3]

template<typename InElementType , typename InAllocatorType >

template<UE::CIntegral CountType>

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RemoveAtSwap	(	SizeType	Index,
		CountType	Count,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes an element (or elements) at given location, optionally shrinking the array.

This version is much more efficient than RemoveAt (O(Count) instead of O(ArrayNum)), but does not preserve the order.

Parameters

Index	Location in array of the element to remove.
Count	(Optional) Number of elements to remove. Default is 1.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ RemoveAtSwap() [3/3]

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::RemoveAtSwap	(	SizeType	Index,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes an element at the given location, optionally shrinking the array.

This version is much more efficient than RemoveAt (O(Count) instead of O(ArrayNum)), but does not preserve the order.

Parameters

Index	Location in array of the element to remove.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ RemoveSingle()

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::RemoveSingle ( const ElementType & Item )

inline

Removes the first occurrence of the specified item in the array, maintaining order but not indices.

Parameters

Item	The item to remove.

Returns: The number of items removed. For RemoveSingleItem, this is always either 0 or 1.

See also: Add, Insert, Remove, RemoveAll, RemoveAllSwap

◆ RemoveSingleSwap() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::RemoveSingleSwap	(	const ElementType &	Item,
		bool	bAllowShrinking
	)

inline

◆ RemoveSingleSwap() [2/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::RemoveSingleSwap	(	const ElementType &	Item,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes the first occurrence of the specified item in the array. This version is much more efficient O(Count) instead of O(ArrayNum), but does not preserve the order

Parameters

Item	The item to remove
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Returns: The number of items removed. For RemoveSingleItem, this is always either 0 or 1.

See also: Add, Insert, Remove, RemoveAll, RemoveAllSwap, RemoveSwap

◆ RemoveSwap() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT SizeType TArray< InElementType, InAllocatorType >::RemoveSwap	(	const ElementType &	Item,
		bool	bAllowShrinking
	)

inline

◆ RemoveSwap() [2/2]

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::RemoveSwap	(	const ElementType &	Item,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Removes all instances of a given item from the array.

This version is much more efficient, because it uses RemoveAtSwap internally which is O(Count) instead of RemoveAt which is O(ArrayNum), but does not preserve the order.

Parameters

Item	The item to remove
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

Returns: Number of elements removed.

See also: Add, Insert, Remove, RemoveAll, RemoveAllSwap

◆ rend() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForReverseIteratorType TArray< InElementType, InAllocatorType >::rend ( )

inline

◆ rend() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT RangedForConstReverseIteratorType TArray< InElementType, InAllocatorType >::rend ( ) const

inline

◆ Reserve()

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Reserve ( SizeType Number )

inline

Reserves memory such that the array can contain at least Number elements.

Parameters

Number The number of elements that the array should be able to contain after allocation.

See also: Shrink

◆ Reset()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::Reset ( SizeType NewSize = 0 )

inline

Same as empty, but doesn't change memory allocations, unless the new size is larger than the current array. It calls the destructors on held items if needed and then zeros the ArrayNum.

Parameters

NewSize The expected usage size after calling this function.

◆ SetNum() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::SetNum	(	SizeType	NewNum,
		bool	bAllowShrinking
	)

inline

◆ SetNum() [2/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::SetNum	(	SizeType	NewNum,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Resizes array to given number of elements.

Parameters

NewNum	New size of the array.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ SetNumUninitialized() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::SetNumUninitialized	(	SizeType	NewNum,
		bool	bAllowShrinking
	)

inline

◆ SetNumUninitialized() [2/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::SetNumUninitialized	(	SizeType	NewNum,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Resizes array to given number of elements. New elements will be uninitialized.

Parameters

NewNum	New size of the array.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ SetNumUnsafeInternal()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::SetNumUnsafeInternal ( SizeType NewNum )

inline

Does nothing except setting the new number of elements in the array. Does not destruct items, does not de-allocate memory.

Parameters

NewNum New number of elements in the array, must be <= the current number of elements in the array.

◆ SetNumZeroed() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::SetNumZeroed	(	SizeType	NewNum,
		bool	bAllowShrinking
	)

inline

◆ SetNumZeroed() [2/2]

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::SetNumZeroed	(	SizeType	NewNum,
		EAllowShrinking	AllowShrinking = `UE::Core::Private::AllowShrinkingByDefault<AllocatorType>()`
	)

inline

Resizes array to given number of elements, optionally shrinking it. New elements will be zeroed.

Parameters

NewNum	New size of the array.
AllowShrinking	(Optional) By default, arrays with large amounts of slack will automatically shrink. Use FNonshrinkingAllocator or pass EAllowShrinking::No to prevent this.

◆ Shrink()

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Shrink ( )

inline

Shrinks the array's used memory to smallest possible to store elements currently in it.

See also: Slack

◆ Sort() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::Sort ( )

inline

Sorts the array assuming < operator is defined for the item type.

Note: : If your array contains raw pointers, they will be automatically dereferenced during sorting. Therefore, your array will be sorted by the values being pointed to, rather than the pointers' values. If this is not desirable, please use Algo::Sort(MyArray) directly instead. The auto-dereferencing behavior does not occur with smart pointers.

◆ Sort() [2/2]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::Sort ( const PREDICATE_CLASS & Predicate )

inline

Sorts the array using user define predicate class.

Parameters

Predicate Predicate class instance.

Note: : If your array contains raw pointers, they will be automatically dereferenced during sorting. Therefore, your predicate will be passed references rather than pointers. If this is not desirable, please use Algo::Sort(MyArray, Predicate) directly instead. The auto-dereferencing behavior does not occur with smart pointers.

◆ StableSort() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::StableSort ( )

inline

Stable sorts the array assuming < operator is defined for the item type.

Stable sort is slower than non-stable algorithm.

Note: : If your array contains raw pointers, they will be automatically dereferenced during sorting. Therefore, your array will be sorted by the values being pointed to, rather than the pointers' values. If this is not desirable, please use Algo::StableSort(MyArray) directly instead. The auto-dereferencing behavior does not occur with smart pointers.

◆ StableSort() [2/2]

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::StableSort ( const PREDICATE_CLASS & Predicate )

inline

Stable sorts the array using user defined predicate class.

Stable sort is slower than non-stable algorithm.

Parameters

Predicate Predicate class instance

Note: : If your array contains raw pointers, they will be automatically dereferenced during sorting. Therefore, your predicate will be passed references rather than pointers. If this is not desirable, please use Algo::StableSort(MyArray, Predicate) directly instead. The auto-dereferencing behavior does not occur with smart pointers.

◆ Swap()

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::Swap	(	SizeType	FirstIndexToSwap,
		SizeType	SecondIndexToSwap
	)

inline

Element-wise array element swap.

This version is doing more sanity checks than SwapMemory.

Parameters

FirstIndexToSwap	Position of the first element to swap.
SecondIndexToSwap	Position of the second element to swap.

◆ SwapMemory()

template<typename InElementType , typename InAllocatorType >

UE_FORCEINLINE_HINT void TArray< InElementType, InAllocatorType >::SwapMemory	(	SizeType	FirstIndexToSwap,
		SizeType	SecondIndexToSwap
	)

inline

Element-wise array memory swap.

Parameters

FirstIndexToSwap	Position of the first element to swap.
SecondIndexToSwap	Position of the second element to swap.

◆ Top() [1/2]

template<typename InElementType , typename InAllocatorType >

UE_REWRITE const ElementType & TArray< InElementType, InAllocatorType >::Top ( ) const

inline

◆ Top() [2/2]

template<typename InElementType , typename InAllocatorType >

UE_NODEBUG UE_FORCEINLINE_HINT ElementType & TArray< InElementType, InAllocatorType >::Top ( )

inline

Returns the top element, i.e. the last one.

Returns: Reference to the top element.

See also: Pop, Push

◆ ToString()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::ToString	(	const FPlatformTypeLayoutParameters &	LayoutParams,
		FMemoryToStringContext &	OutContext
	)		const

inline

◆ VerifyHeap()

template<typename InElementType , typename InAllocatorType >

template<class PREDICATE_CLASS >

UE_NODEBUG void TArray< InElementType, InAllocatorType >::VerifyHeap ( const PREDICATE_CLASS & Predicate )

inline

Verifies the heap.

Parameters

Predicate Predicate class instance.

◆ WriteMemoryImage()

template<typename InElementType , typename InAllocatorType >

void TArray< InElementType, InAllocatorType >::WriteMemoryImage ( FMemoryImageWriter & Writer ) const

inline

Friends And Related Symbol Documentation

◆ TArray

template<typename InElementType , typename InAllocatorType >

template<typename OtherInElementType , typename OtherAllocator >

friend class TArray

friend

Array that allocates elements on the heap.

◆ TArrayPrivateFriend

template<typename InElementType , typename InAllocatorType >

friend struct TArrayPrivateFriend

friend

◆ TIndirectArray

template<typename InElementType , typename InAllocatorType >

template<typename ElementType , typename AllocatorType >

friend class TIndirectArray

friend

Member Data Documentation

◆ AllocatorInstance

template<typename InElementType , typename InAllocatorType >

ElementAllocatorType TArray< InElementType, InAllocatorType >::AllocatorInstance

protected

◆ ArrayMax

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::ArrayMax

protected

◆ ArrayNum

template<typename InElementType , typename InAllocatorType >

SizeType TArray< InElementType, InAllocatorType >::ArrayNum

protected

◆ bHasIntrusiveUnsetOptionalState

template<typename InElementType , typename InAllocatorType >

constexpr bool TArray< InElementType, InAllocatorType >::bHasIntrusiveUnsetOptionalState = true

staticconstexpr

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

Engine/Source/Runtime/Core/Public/Containers/Array.h
Engine/Source/Runtime/Core/Public/Containers/ArrayView.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ AllocatorType

◆ ElementAllocatorType

◆ ElementType

◆ IntrusiveUnsetOptionalStateType

◆ RangedForConstIteratorType

◆ RangedForConstReverseIteratorType

◆ RangedForIteratorType

◆ RangedForReverseIteratorType

◆ SizeType

◆ TConstIterator

◆ TIterator

Constructor & Destructor Documentation

◆ TArray() [1/13]

◆ TArray() [2/13]

◆ TArray() [3/13]

◆ TArray() [4/13]

◆ TArray() [5/13]

◆ TArray() [6/13]

◆ TArray() [7/13]

◆ TArray() [8/13]

◆ TArray() [9/13]

◆ TArray() [10/13]

◆ TArray() [11/13]

◆ ~TArray()

◆ TArray() [12/13]

◆ TArray() [13/13]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ Add_GetRef() [1/2]

◆ Add_GetRef() [2/2]

◆ AddDefaulted() [1/2]

◆ AddDefaulted() [2/2]

◆ AddDefaulted_GetRef()

◆ AddUninitialized() [1/2]

◆ AddUninitialized() [2/2]

◆ AddUnique() [1/2]

◆ AddUnique() [2/2]

◆ AddZeroed() [1/2]

◆ AddZeroed() [2/2]

◆ AddZeroed_GetRef()

◆ Append() [1/6]

◆ Append() [2/6]

◆ Append() [3/6]

◆ Append() [4/6]

◆ Append() [5/6]

◆ Append() [6/6]

◆ AppendHash()

◆ begin() [1/2]

◆ begin() [2/2]

◆ BulkSerialize()

◆ CheckAddress()

◆ CheckInvariants()

◆ Contains()

◆ ContainsByPredicate()

◆ CopyUnfrozen()

◆ CountBytes()

◆ CreateConstIterator()

◆ CreateIterator()

◆ Emplace()

◆ Emplace_GetRef()

◆ EmplaceAt()

◆ EmplaceAt_GetRef()

◆ Empty()

◆ end() [1/2]

◆ end() [2/2]

◆ FilterByPredicate()

◆ Find() [1/2]

◆ Find() [2/2]

◆ FindByKey() [1/2]

◆ FindByKey() [2/2]

◆ FindByPredicate() [1/2]