#include <Array.h>

Public Types
using	ElementType = InElementType

using	ElementAllocatorType = InElementAllocatorType

Public Member Functions
ULANG_FORCEINLINE	TArrayG (RawAllocatorArgsType &&... RawAllocatorArgs)

ULANG_FORCEINLINE	TArrayG (const typename ElementAllocatorType::RawAllocatorType &RawAllocator)

ULANG_FORCEINLINE	TArrayG (const ElementType *Ptr, int32_t Count, RawAllocatorArgsType &&... RawAllocatorArgs)

ULANG_FORCEINLINE	TArrayG (int32_t Count, const ElementType &Value=ElementType(), RawAllocatorArgsType &&... RawAllocatorArgs)

	TArrayG (std::initializer_list< InElementType > InitList, RawAllocatorArgsType &&... RawAllocatorArgs)

template<typename OtherElementType >
	TArrayG (std::initializer_list< OtherElementType > InitList, RawAllocatorArgsType &&... RawAllocatorArgs)

template<typename OtherElementType , typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
ULANG_FORCEINLINE	TArrayG (const TArrayG< OtherElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &Other, RawAllocatorArgsType &&... RawAllocatorArgs)

ULANG_FORCEINLINE	TArrayG (const TArrayG &Other)

ULANG_FORCEINLINE	TArrayG (const TArrayG &Other, int32_t ExtraSlack)

TArrayG &	operator= (const TArrayG &Other)

ULANG_FORCEINLINE	TArrayG (TArrayG &&Other)

	TArrayG (TArrayG &&Other, int32_t ExtraSlack)

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
ULANG_FORCEINLINE	TArrayG (TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &&Other)

TArrayG &	operator= (TArrayG &&Other)

	~TArrayG ()

ULANG_FORCEINLINE ElementType *	GetData ()

ULANG_FORCEINLINE const ElementType *	GetData () const

ULANG_FORCEINLINE uint32_t	GetTypeSize () const

ULANG_FORCEINLINE uint32_t	GetAllocatedSize (void) const

ULANG_FORCEINLINE int32_t	GetSlack () const

ULANG_FORCEINLINE void	CheckInvariants () const

ULANG_FORCEINLINE void	RangeCheck (int32_t Index) const

ULANG_FORCEINLINE bool	IsValidIndex (int32_t Index) const

ULANG_FORCEINLINE int32_t	Num () const

ULANG_FORCEINLINE int32_t	Max () const

ULANG_FORCEINLINE const ElementAllocatorType::RawAllocatorType &	GetRawAllocator () const

ULANG_FORCEINLINE bool	IsEmpty () const

ULANG_FORCEINLINE bool	IsFilled () const

ULANG_FORCEINLINE ElementType &	operator[] (int32_t Index)

ULANG_FORCEINLINE const ElementType &	operator[] (int32_t Index) const

ULANG_FORCEINLINE ElementType	Pop (bool bAllowShrinking=true)

ULANG_FORCEINLINE void	Push (ElementType &&Item)

ULANG_FORCEINLINE void	Push (const ElementType &Item)

ULANG_FORCEINLINE ElementType &	Top ()

ULANG_FORCEINLINE const ElementType &	Top () const

ULANG_FORCEINLINE ElementType &	Last (int32_t IndexFromTheEnd=0)

ULANG_FORCEINLINE const ElementType &	Last (int32_t IndexFromTheEnd=0) const

ULANG_FORCEINLINE void	Shrink ()

ULANG_FORCEINLINE bool	Find (const ElementType &Item, int32_t &Index) const

int32_t	Find (const ElementType &Item) const

ULANG_FORCEINLINE bool	FindLast (const ElementType &Item, int32_t &Index) const

int32_t	FindLast (const ElementType &Item) const

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

template<typename Predicate >
ULANG_FORCEINLINE int32_t	FindLastByPredicate (Predicate Pred) const

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

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

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

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

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

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

template<typename Predicate >
TArrayG	FilterByPredicate (Predicate Pred) const

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

template<typename Predicate >
ULANG_FORCEINLINE bool	ContainsByPredicate (Predicate Pred) const

bool	operator== (const TArrayG &OtherArray) const

ULANG_FORCEINLINE bool	operator!= (const TArrayG &OtherArray) const

ULANG_FORCEINLINE int32_t	AddUninitialized (int32_t Count=1)

void	InsertUninitialized (int32_t Index, int32_t Count=1)

void	InsertZeroed (int32_t Index, int32_t Count=1)

ElementType &	InsertZeroed_GetRef (int32_t Index)

void	InsertDefaulted (int32_t Index, int32_t Count=1)

ElementType &	InsertDefaulted_GetRef (int32_t Index)

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

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
int32_t	Insert (const TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &Items, const int32_t InIndex)

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
int32_t	Insert (TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &&Items, const int32_t InIndex)

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

ULANG_FORCEINLINE void	CheckAddress (void const *Addr) const

int32_t	Insert (ElementType &&Item, int32_t Index)

int32_t	Insert (const ElementType &Item, int32_t Index)

ElementType &	Insert_GetRef (ElementType &&Item, int32_t Index)

ElementType &	Insert_GetRef (const ElementType &Item, int32_t Index)

ULANG_FORCEINLINE void	RemoveAt (int32_t Index)

template<typename CountType >
ULANG_FORCEINLINE void	RemoveAt (int32_t Index, CountType Count, bool bAllowShrinking=true)

ULANG_FORCEINLINE void	RemoveAtSwap (int32_t Index)

template<typename CountType >
ULANG_FORCEINLINE void	RemoveAtSwap (int32_t Index, CountType Count, bool bAllowShrinking=true)

int32_t	Replace (const ElementType &OldItem, const ElementType &NewItem)

void	Reset (int32_t NewSize=0)

void	Empty (int32_t Slack=0)

void	SetNum (int32_t NewNum, bool bAllowShrinking=true)

void	SetNumZeroed (int32_t NewNum, bool bAllowShrinking=true)

void	SetNumUninitialized (int32_t NewNum, bool bAllowShrinking=true)

void	SetNumUnsafeInternal (int32_t NewNum)

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
void	Append (const TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &Source)

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
void	Append (TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &&Source)

void	Append (const ElementType *Ptr, int32_t Count)

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

TArrayG &	operator+= (TArrayG &&Other)

TArrayG &	operator+= (const TArrayG &Other)

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

template<typename... ArgsType>
ULANG_FORCEINLINE int32_t	Emplace (ArgsType &&... Args)

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

template<typename... ArgsType>
ULANG_FORCEINLINE void	EmplaceAt (int32_t Index, ArgsType &&... Args)

template<typename... ArgsType>
ULANG_FORCEINLINE ElementType &	EmplaceAt_GetRef (int32_t Index, ArgsType &&... Args)

ULANG_FORCEINLINE int32_t	Add (ElementType &&Item)

ULANG_FORCEINLINE int32_t	Add (const ElementType &Item)

ULANG_FORCEINLINE ElementType &	Add_GetRef (ElementType &&Item)

ULANG_FORCEINLINE ElementType &	Add_GetRef (const ElementType &Item)

int32_t	AddZeroed (int32_t Count=1)

ElementType &	AddZeroed_GetRef ()

int32_t	AddDefaulted (int32_t Count=1)

ElementType &	AddDefaulted_GetRef ()

ULANG_FORCEINLINE int32_t	AddUnique (ElementType &&Item)

ULANG_FORCEINLINE int32_t	AddUnique (const ElementType &Item)

ULANG_FORCEINLINE void	Reserve (int32_t Number)

void	Init (const ElementType &Element, int32_t Number)

int32_t	RemoveSingle (const ElementType &Item)

template<typename OtherElementType >
int32_t	Remove (const OtherElementType &Item)

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

template<class PREDICATE_CLASS >
void	RemoveAllSwap (const PREDICATE_CLASS &Predicate, bool bAllowShrinking=true)

int32_t	RemoveSingleSwap (const ElementType &Item, bool bAllowShrinking=true)

int32_t	RemoveSwap (const ElementType &Item)

ULANG_FORCEINLINE ElementType *	begin ()

ULANG_FORCEINLINE const ElementType *	begin () const

ULANG_FORCEINLINE ElementType *	end ()

ULANG_FORCEINLINE const ElementType *	end () const

void	Sort ()

template<class PredicateType >
void	Sort (const PredicateType &Predicate)

template<class PredicateType >
void	StableSort (const PredicateType &Predicate)

void	RemoveSuccessiveDuplicates ()

Protected Types
using	ElementStorageType = typename TChooseClass< ElementAllocatorType::NeedsElementType, typename ElementAllocatorType::template ForElementType< ElementType >, typename ElementAllocatorType::ForAnyElementType >::Result

Protected Attributes
ElementStorageType	_ElementStorage

int32_t	_ArrayNum

int32_t	_ArrayMax

Friends
template<typename OtherElementType , typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>
class	TArrayG

Detailed Description

template<typename InElementType, typename InElementAllocatorType, typename... RawAllocatorArgsType>
class uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >

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 TArrayG 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.

Member Typedef Documentation

◆ ElementAllocatorType

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

using uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::ElementAllocatorType = InElementAllocatorType

◆ ElementStorageType

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

using uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::ElementStorageType = typename TChooseClass< ElementAllocatorType::NeedsElementType, typename ElementAllocatorType::template ForElementType<ElementType>, typename ElementAllocatorType::ForAnyElementType >::Result

protected

◆ ElementType

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

using uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::ElementType = InElementType

Constructor & Destructor Documentation

◆ TArrayG() [1/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG ( RawAllocatorArgsType &&... RawAllocatorArgs )

inline

Constructor with given raw allocator arguments (none required for heap allocator).

◆ TArrayG() [2/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG ( const typename ElementAllocatorType::RawAllocatorType & RawAllocator )

inline

Constructor with given raw allocator.

◆ TArrayG() [3/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	const ElementType *	Ptr,
		int32_t	Count,
		RawAllocatorArgsType &&...	RawAllocatorArgs
	)

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

◆ TArrayG() [4/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	int32_t	Count,
		const ElementType &	Value = `ElementType()`,
		RawAllocatorArgsType &&...	RawAllocatorArgs
	)

inline

◆ TArrayG() [5/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	std::initializer_list< InElementType >	InitList,
		RawAllocatorArgsType &&...	RawAllocatorArgs
	)

inline

Initializer list constructor

◆ TArrayG() [6/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementType >

uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	std::initializer_list< OtherElementType >	InitList,
		RawAllocatorArgsType &&...	RawAllocatorArgs
	)

inline

◆ TArrayG() [7/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementType , typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	const TArrayG< OtherElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &	Other,
		RawAllocatorArgsType &&...	RawAllocatorArgs
	)

inlineexplicit

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

Parameters

Other The source array to copy.

◆ TArrayG() [8/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG ( const TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > & Other )

inline

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

Parameters

Other The source array to copy.

◆ TArrayG() [9/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	const TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > &	Other,
		int32_t	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.

◆ TArrayG() [10/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG ( TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > && Other )

inline

Move constructor.

Parameters

Other Array to move from.

◆ TArrayG() [11/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG	(	TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > &&	Other,
		int32_t	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.

◆ TArrayG() [12/12]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

ULANG_FORCEINLINE uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::TArrayG ( TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > && Other )

inlineexplicit

Move constructor.

Parameters

Other Array to move from.

◆ ~TArrayG()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::~TArrayG ( )

inline

Destructor.

Member Function Documentation

◆ Add() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::AddDefaulted ( int32_t Count = 1 )

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_GetRef()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::AddUninitialized ( int32_t Count = 1 )

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.

◆ AddUnique() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::AddUnique ( const ElementType & Item )

inline

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

Parameters

Args	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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::AddUnique ( ElementType && Item )

inline

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

Move semantics version.

Parameters

Args	Item to add.

Returns: Index of the element in the array.

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

◆ AddZeroed()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::AddZeroed ( int32_t Count = 1 )

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_GetRef()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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/4]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Append	(	const ElementType *	Ptr,
		int32_t	Count
	)

inline

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

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/4]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Append ( const TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > & Source )

inline

Appends the specified array to this array.

Allocator changing version.

Parameters

Source The array to append.

See also: Add, Insert

◆ Append() [3/4]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Append ( std::initializer_list< ElementType > InitList )

inline

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

Parameters

InitList The initializer list of elements to add.

See also: Add, Insert

◆ Append() [4/4]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Append ( TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > && Source )

inline

Appends the specified array to this array.

Parameters

Source The array to append.

See also: Add, Insert

◆ begin() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::begin ( )

inline

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

◆ begin() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::begin ( ) const

inline

◆ CheckAddress()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::CheckAddress ( void const * Addr ) const

inline

Checks that the specified address is not part of an element within the container. Used for implementations to ULANG_ASSERTF 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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::CheckInvariants ( ) const

inline

Checks array invariants: if array size is greater than zero and less than maximum.

◆ Contains()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename ComparisonType >

bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::ContainsByPredicate ( Predicate Pred ) const

inline

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

Parameters

Predicate to use

Returns: True if found. False otherwise.

See also: Contains, Find

◆ Emplace()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename... ArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename... ArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename... ArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::EmplaceAt	(	int32_t	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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename... ArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::EmplaceAt_GetRef	(	int32_t	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 InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Empty ( int32_t 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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::end ( )

inline

◆ end() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::end ( ) const

inline

◆ FilterByPredicate()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

TArrayG uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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: TArrayG 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 InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Find ( const ElementType & Item ) const

inline

Finds element within the array.

Parameters

Item	Item to look for.

Returns: Index of the found element. IndexNone otherwise.

See also: FindLast, FindLastByPredicate

◆ Find() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Find	(	const ElementType &	Item,
		int32_t &	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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename KeyType >

ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename KeyType >

ULANG_FORCEINLINE const ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::FindByKey ( 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: Pointer to the first matching element, or nullptr if none is found.

See also: Find

◆ FindByPredicate() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::FindByPredicate ( Predicate Pred )

inline

Finds an element which matches a predicate functor.

Parameters

Pred	The functor to apply to each element. true, or nullptr if none is found.

See also: FilterByPredicate, ContainsByPredicate

◆ FindByPredicate() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

ULANG_FORCEINLINE const ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::FindByPredicate ( Predicate Pred ) const

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

◆ FindLast() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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. IndexNone otherwise.

◆ FindLast() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::FindLast	(	const ElementType &	Item,
		int32_t &	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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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. IndexNone otherwise.

◆ FindLastByPredicate() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::FindLastByPredicate	(	Predicate	Pred,
		int32_t	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. IndexNone otherwise.

◆ GetAllocatedSize()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uint32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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.

◆ GetData() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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.

◆ GetData() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementType * uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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.

◆ GetRawAllocator()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementAllocatorType::RawAllocatorType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::GetRawAllocator ( ) const

inline

Accesses the raw allocator.

◆ GetSlack()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::GetSlack ( ) const

inline

Returns the amount of slack in this array in elements.

See also: Num, Shrink

◆ GetTypeSize()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE uint32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::GetTypeSize ( ) const

inline

Helper function returning the size of the inner type.

Returns: Size in bytes of array type.

◆ IndexOfByKey()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename KeyType >

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 IndexNone if none is found.

◆ IndexOfByPredicate()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename Predicate >

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::IndexOfByPredicate ( Predicate Pred ) const

inline

Finds an item by predicate.

Parameters

Pred	The predicate to match.

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

◆ Init()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Init	(	const ElementType &	Element,
		int32_t	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/6]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert	(	const ElementType &	Item,
		int32_t	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/6]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert	(	const ElementType *	Ptr,
		int32_t	Count,
		int32_t	Index
	)

inline

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

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/6]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert	(	const TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &	Items,
		const int32_t	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/6]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert	(	ElementType &&	Item,
		int32_t	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() [5/6]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert	(	std::initializer_list< ElementType >	InitList,
		const int32_t	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() [6/6]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert	(	TArrayG< ElementType, OtherElementAllocatorType, OtherRawAllocatorArgsType... > &&	Items,
		const int32_t	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_GetRef() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert_GetRef	(	const ElementType &	Item,
		int32_t	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 InElementAllocatorType , typename... RawAllocatorArgsType>

ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Insert_GetRef	(	ElementType &&	Item,
		int32_t	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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::InsertDefaulted	(	int32_t	Index,
		int32_t	Count = `1`
	)

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_GetRef()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::InsertDefaulted_GetRef ( int32_t 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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::InsertUninitialized	(	int32_t	Index,
		int32_t	Count = `1`
	)

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

◆ InsertZeroed()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::InsertZeroed	(	int32_t	Index,
		int32_t	Count = `1`
	)

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_GetRef()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::InsertZeroed_GetRef ( int32_t 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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::IsEmpty ( ) const

inline

Returns true if no elements in array

Returns: true if no elements in array or false if one or more elements.

See also: IsFull, Num

◆ IsFilled()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::IsFilled ( ) const

inline

Returns true if any elements in array

Returns: true if one or more elements in array or false no elements.

See also: IsEmpty, Num

◆ IsValidIndex()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::IsValidIndex ( int32_t 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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Last ( int32_t 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.

◆ Last() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Last ( int32_t IndexFromTheEnd = 0 ) const

inline

Returns n-th last element from the array.

Const version of the above.

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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Num ( ) const

inline

Returns number of elements in array.

Returns: Number of elements in array.

See also: GetSlack

◆ operator!=()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator!= ( const TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > & 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 InElementAllocatorType , typename... RawAllocatorArgsType>

TArrayG & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator+= ( const TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > & 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 InElementAllocatorType , typename... RawAllocatorArgsType>

TArrayG & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

TArrayG & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator+= ( TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > && Other )

inline

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

Move semantics version.

Parameters

Other The array to append.

◆ operator=() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

TArrayG & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator= ( const TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > & 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/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

TArrayG & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator= ( TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > && Other )

inline

Move assignment operator.

Parameters

Other Array to assign and move from.

◆ operator==()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

bool uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator== ( const TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType > & OtherArray ) const

inline

Equality operator.

Parameters

OtherArray Array to compare.

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

◆ operator[]() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator[] ( int32_t Index )

inline

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

Returns: Reference to indexed element.

◆ operator[]() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::operator[] ( int32_t Index ) const

inline

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

Const version of the above.

Returns: Reference to indexed element.

◆ Pop()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Pop ( bool bAllowShrinking = true )

inline

Pops element from the array.

Parameters

bAllowShrinking If this call allows shrinking of the array during element remove.

Returns: Popped element.

◆ Push() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Push ( ElementType && Item )

inline

Pushes element into the array.

Parameters

Item	Item to push.

◆ RangeCheck()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RangeCheck ( int32_t Index ) const

inline

Checks if index is in array range.

Parameters

Index Index to check.

◆ Remove()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementType >

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Remove ( const OtherElementType & 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 InElementAllocatorType , typename... RawAllocatorArgsType>

template<class PREDICATE_CLASS >

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<class PREDICATE_CLASS >

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveAllSwap	(	const PREDICATE_CLASS &	Predicate,
		bool	bAllowShrinking = `true`
	)

inline

Remove all instances that match the predicate

Parameters

Predicate Predicate class instance

See also: Remove, RemoveSingle, RemoveSingleSwap, RemoveSwap

◆ RemoveAt() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveAt ( int32_t Index )

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.
bAllowShrinking	(Optional) Tells if this call can shrink array if suitable after remove. Default is true.

◆ RemoveAt() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename CountType >

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveAt	(	int32_t	Index,
		CountType	Count,
		bool	bAllowShrinking = `true`
	)

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.
bAllowShrinking	(Optional) Tells if this call can shrink array if suitable after remove. Default is true.

◆ RemoveAtSwap() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveAtSwap ( int32_t Index )

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.
bAllowShrinking	(Optional) Tells if this call can shrink array if suitable after remove. Default is true.

◆ RemoveAtSwap() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename CountType >

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveAtSwap	(	int32_t	Index,
		CountType	Count,
		bool	bAllowShrinking = `true`
	)

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.
bAllowShrinking	(Optional) Tells if this call can shrink array if suitable after remove. Default is true.

◆ RemoveSingle()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveSingleSwap	(	const ElementType &	Item,
		bool	bAllowShrinking = `true`
	)

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

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

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

◆ RemoveSuccessiveDuplicates()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveSuccessiveDuplicates ( )

inline

Remove successive duplicates. Assumes that elements of the array have ==.

◆ RemoveSwap()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::RemoveSwap ( const ElementType & Item )

inline

Removes 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.

Returns: Number of elements removed.

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

◆ Replace()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Replace	(	const ElementType &	OldItem,
		const ElementType &	NewItem
	)

inline

Replaces specified element with the supplied element.

Parameters

OldItem	The element to replace.
NewItem	The element to replace with.

Returns: Location at which the replace was done.

See also: Add, Remove, Insert

◆ Reserve()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Reserve ( int32_t 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 InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Reset ( int32_t 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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::SetNum	(	int32_t	NewNum,
		bool	bAllowShrinking = `true`
	)

inline

Resizes array to given number of elements.

Parameters

NewNum	New size of the array.
bAllowShrinking	Tell if this function can shrink the memory in-use if suitable.

◆ SetNumUninitialized()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::SetNumUninitialized	(	int32_t	NewNum,
		bool	bAllowShrinking = `true`
	)

inline

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

Parameters

NewNum New size of the array.

◆ SetNumUnsafeInternal()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::SetNumUnsafeInternal ( int32_t 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()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::SetNumZeroed	(	int32_t	NewNum,
		bool	bAllowShrinking = `true`
	)

inline

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

Parameters

NewNum New size of the array.

◆ Shrink()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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 InElementAllocatorType , typename... RawAllocatorArgsType>

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::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) instead. The auto-dereferencing behavior does not occur with smart pointers.

◆ Sort() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<class PredicateType >

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Sort ( const PredicateType & Predicate )

inline

Sorts the array using user define predicate class.

Parameters

Predicate Predicate instance or lambda.

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) instead. The auto-dereferencing behavior does not occur with smart pointers.

◆ StableSort()

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<class PredicateType >

void uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::StableSort ( const PredicateType & Predicate )

inline

◆ Top() [1/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Top ( )

inline

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

Returns: Reference to the top element.

See also: Pop, Push

◆ Top() [2/2]

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ULANG_FORCEINLINE const ElementType & uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::Top ( ) const

inline

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

Const version of the above.

Returns: Reference to the top element.

See also: Pop, Push

Friends And Related Symbol Documentation

◆ TArrayG

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

template<typename OtherElementType , typename OtherElementAllocatorType , typename... OtherRawAllocatorArgsType>

friend class TArrayG

friend

Member Data Documentation

◆ _ArrayMax

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::_ArrayMax

protected

◆ _ArrayNum

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

int32_t uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::_ArrayNum

protected

◆ _ElementStorage

template<typename InElementType , typename InElementAllocatorType , typename... RawAllocatorArgsType>

ElementStorageType uLang::TArrayG< InElementType, InElementAllocatorType, RawAllocatorArgsType >::_ElementStorage

protected

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

Engine/Source/Runtime/Solaris/uLangCore/Public/uLang/Common/Containers/Array.h

Public Types

Public Member Functions

Protected Types

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ElementAllocatorType

◆ ElementStorageType

◆ ElementType

Constructor & Destructor Documentation

◆ TArrayG() [1/12]

◆ TArrayG() [2/12]

◆ TArrayG() [3/12]

◆ TArrayG() [4/12]

◆ TArrayG() [5/12]

◆ TArrayG() [6/12]

◆ TArrayG() [7/12]

◆ TArrayG() [8/12]

◆ TArrayG() [9/12]

◆ TArrayG() [10/12]

◆ TArrayG() [11/12]

◆ TArrayG() [12/12]

◆ ~TArrayG()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ Add_GetRef() [1/2]

◆ Add_GetRef() [2/2]

◆ AddDefaulted()

◆ AddDefaulted_GetRef()

◆ AddUninitialized()

◆ AddUnique() [1/2]

◆ AddUnique() [2/2]

◆ AddZeroed()

◆ AddZeroed_GetRef()

◆ Append() [1/4]

◆ Append() [2/4]

◆ Append() [3/4]

◆ Append() [4/4]

◆ begin() [1/2]

◆ begin() [2/2]

◆ CheckAddress()

◆ CheckInvariants()

◆ Contains()

◆ ContainsByPredicate()

◆ 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]

◆ FindByPredicate() [2/2]

◆ FindLast() [1/2]

◆ FindLast() [2/2]

◆ FindLastByPredicate() [1/2]

◆ FindLastByPredicate() [2/2]

◆ GetAllocatedSize()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetRawAllocator()

◆ GetSlack()

◆ GetTypeSize()

◆ IndexOfByKey()

◆ IndexOfByPredicate()

◆ Init()

◆ Insert() [1/6]

◆ Insert() [2/6]

◆ Insert() [3/6]

◆ Insert() [4/6]

◆ Insert() [5/6]

◆ Insert() [6/6]

◆ Insert_GetRef() [1/2]