#include <SparseArray.h>

Inheritance diagram for TSparseArray< InElementType, Allocator >:

Classes
class	TConstIterator

class	TConstSubsetIterator

class	TIterator

class	TRangedForConstIterator

class	TRangedForIterator

Public Types
using	IntrusiveUnsetOptionalStateType = TSparseArray

Public Member Functions
	~TSparseArray ()

	TSparseArray (FIntrusiveUnsetOptionalState Tag)

bool	operator== (FIntrusiveUnsetOptionalState Tag) const

int32	Add (const ElementType &Element)

int32	Add (ElementType &&Element)

template<typename... ArgsType>
int32	Emplace (ArgsType &&... Args)

template<typename... ArgsType>
int32	EmplaceAtLowestFreeIndex (int32 &LowestFreeIndexSearchStart, ArgsType &&... Args)

template<typename... ArgsType>
int32	EmplaceAt (int32 Index, ArgsType &&... Args)

void	Insert (int32 Index, typename TTypeTraits< ElementType >::ConstInitType Element)

void	RemoveAt (int32 Index, int32 Count=1)

void	Empty (int32 ExpectedNumElements=0)

void	Reset ()

bool	CompactStable ()

template<typename PREDICATE_CLASS >
void	Sort (const PREDICATE_CLASS &Predicate)

void	Sort ()

template<typename PREDICATE_CLASS >
void	StableSort (const PREDICATE_CLASS &Predicate)

void	StableSort ()

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

int32	FindArbitraryElementIndex () const

SIZE_T	GetAllocatedSize (void) const

void	CountBytes (FArchive &Ar) const

bool	IsCompact () const

bool	operator== (const TSparseArray &B) const

bool	operator!= (const TSparseArray &B) const

constexpr	TSparseArray ()=default

consteval	TSparseArray (EConstEval)

	TSparseArray (TSparseArray &&InCopy)

	TSparseArray (const TSparseArray &InCopy)

	TSparseArray (std::initializer_list< ElementType > InList)

TSparseArray &	operator= (TSparseArray &&InCopy)

TSparseArray &	operator= (const TSparseArray &InCopy)

TSparseArray &	operator= (std::initializer_list< ElementType > InList)

ElementType &	operator[] (int32 Index)

const ElementType &	operator[] (int32 Index) const

int32	PointerToIndex (const ElementType *Ptr) const

UE_FORCEINLINE_HINT void	CheckAddress (const ElementType *Addr) const

TIterator	CreateIterator ()

TConstIterator	CreateConstIterator () const

UE_FORCEINLINE_HINT TRangedForIterator	begin ()

UE_FORCEINLINE_HINT TRangedForConstIterator	begin () const

UE_FORCEINLINE_HINT TRangedForIterator	end ()

UE_FORCEINLINE_HINT TRangedForConstIterator	end () const

TSparseArray &	operator+= (const TSparseArray &OtherArray)

TSparseArray &	operator+= (const TArray< ElementType > &OtherArray)

void	WriteMemoryImage (FMemoryImageWriter &Writer) const

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

Static Public Member Functions
static void	AppendHash (const FPlatformTypeLayoutParameters &LayoutParams, FSHA1 &Hasher)

Static Public Attributes
static constexpr bool	bHasIntrusiveUnsetOptionalState = true

Friends
template<typename , typename >
class	TScriptSparseArray

Additional Inherited Members
Protected Types inherited from TSparseArrayBase< sizeof(InElementType), alignof(InElementType), Allocator >
typedef TSparseArrayElementOrFreeListLink< TAlignedBytes< SizeOfElementType, AlignOfElementType > >	FElementOrFreeListLink

typedef TArray< FElementOrFreeListLink, typename Allocator::ElementAllocator >	DataType

typedef TBitArray< typename Allocator::BitArrayAllocator >	AllocationBitArrayType

Protected Member Functions inherited from TSparseArrayBase< sizeof(InElementType), alignof(InElementType), Allocator >
	TSparseArrayBase (FIntrusiveUnsetOptionalState Tag)

constexpr	TSparseArrayBase ()

consteval	TSparseArrayBase (EConstEval)

	TSparseArrayBase (const TSparseArrayBase &InCopy)

FSparseArrayAllocationInfo	AllocateIndex (int32 Index)

FSparseArrayAllocationInfo	AddUninitialized ()

FSparseArrayAllocationInfo	AddUninitializedAtLowestFreeIndex (int32 &LowestFreeIndexSearchStart)

void	RemoveAtUninitialized (int32 Index, int32 Count=1)

void	Reserve (int32 ExpectedNumElements)

void	Shrink ()

void	SortFreeList ()

FSparseArrayAllocationInfo	InsertUninitialized (int32 Index)

bool	Compact ()

int32	GetMaxIndex () const

bool	IsEmpty () const

int32	Num () const

int32	Max () const

bool	IsValidIndex (int32 Index) const

bool	IsAllocated (int32 Index) const

Protected Attributes inherited from TSparseArrayBase< sizeof(InElementType), alignof(InElementType), Allocator >
DataType	Data

AllocationBitArrayType	AllocationFlags

int32	FirstFreeIndex

int32	NumFreeIndices

Detailed Description

template<typename InElementType, typename Allocator>
class TSparseArray< InElementType, Allocator >

A dynamically sized array where element indices aren't necessarily contiguous. Memory is allocated for all elements in the array's index range, so it doesn't save memory; but it does allow O(1) element removal that doesn't invalidate the indices of subsequent elements. It uses TArray to store the elements, and a TBitArray to store whether each element index is allocated (for fast iteration over allocated elements).

Member Typedef Documentation

◆ IntrusiveUnsetOptionalStateType

template<typename InElementType , typename Allocator >

using TSparseArray< InElementType, Allocator >::IntrusiveUnsetOptionalStateType = TSparseArray

Constructor & Destructor Documentation

◆ ~TSparseArray()

template<typename InElementType , typename Allocator >

TSparseArray< InElementType, Allocator >::~TSparseArray ( )

inline

Destructor.

◆ TSparseArray() [1/6]

template<typename InElementType , typename Allocator >

TSparseArray< InElementType, Allocator >::TSparseArray ( FIntrusiveUnsetOptionalState Tag )

inlineexplicit

◆ TSparseArray() [2/6]

template<typename InElementType , typename Allocator >

constexpr TSparseArray< InElementType, Allocator >::TSparseArray ( )

constexprdefault

Default constructor.

◆ TSparseArray() [3/6]

template<typename InElementType , typename Allocator >

consteval TSparseArray< InElementType, Allocator >::TSparseArray ( EConstEval )

inlineexplicit

◆ TSparseArray() [4/6]

template<typename InElementType , typename Allocator >

TSparseArray< InElementType, Allocator >::TSparseArray ( TSparseArray< InElementType, Allocator > && InCopy )

inline

Move constructor.

◆ TSparseArray() [5/6]

template<typename InElementType , typename Allocator >

TSparseArray< InElementType, Allocator >::TSparseArray ( const TSparseArray< InElementType, Allocator > & InCopy )

inline

Copy constructor.

◆ TSparseArray() [6/6]

template<typename InElementType , typename Allocator >

TSparseArray< InElementType, Allocator >::TSparseArray ( std::initializer_list< ElementType > InList )

inline

Initializer list constructor.

Member Function Documentation

◆ Add() [1/2]

template<typename InElementType , typename Allocator >

int32 TSparseArray< InElementType, Allocator >::Add ( const ElementType & Element )

inline

Adds an element to the array.

◆ Add() [2/2]

template<typename InElementType , typename Allocator >

int32 TSparseArray< InElementType, Allocator >::Add ( ElementType && Element )

inline

Adds an element to the array.

◆ AppendHash()

template<typename InElementType , typename Allocator >

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

inlinestatic

◆ begin() [1/2]

template<typename InElementType , typename Allocator >

UE_FORCEINLINE_HINT TRangedForIterator TSparseArray< InElementType, Allocator >::begin ( )

inline

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

◆ begin() [2/2]

template<typename InElementType , typename Allocator >

UE_FORCEINLINE_HINT TRangedForConstIterator TSparseArray< InElementType, Allocator >::begin ( ) const

inline

◆ CheckAddress()

template<typename InElementType , typename Allocator >

UE_FORCEINLINE_HINT void TSparseArray< InElementType, Allocator >::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.

◆ CompactStable()

template<typename InElementType , typename Allocator >

bool TSparseArray< InElementType, Allocator >::CompactStable ( )

inline

Compacts the allocated elements into a contiguous index range. Does not change the iteration order of the elements. Returns true if any elements were relocated, false otherwise.

◆ CopyUnfrozen()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::CopyUnfrozen	(	const FMemoryUnfreezeContent &	Context,
		void *	Dst
	)		const

inline

◆ CountBytes()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::CountBytes ( FArchive & Ar ) const

inline

Tracks the container's memory use through an archive.

◆ CreateConstIterator()

template<typename InElementType , typename Allocator >

TConstIterator TSparseArray< InElementType, Allocator >::CreateConstIterator ( ) const

inline

Creates a const iterator for the contents of this array

◆ CreateIterator()

template<typename InElementType , typename Allocator >

TIterator TSparseArray< InElementType, Allocator >::CreateIterator ( )

inline

Creates an iterator for the contents of this array

◆ Emplace()

template<typename InElementType , typename Allocator >

template<typename... ArgsType>

int32 TSparseArray< InElementType, Allocator >::Emplace ( ArgsType &&... Args )

inline

Constructs a new item at the last freed index of the array.

Parameters

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

Returns: Index to the new item

◆ EmplaceAt()

template<typename InElementType , typename Allocator >

template<typename... ArgsType>

int32 TSparseArray< InElementType, Allocator >::EmplaceAt	(	int32	Index,
		ArgsType &&...	Args
	)

inline

Constructs a new item at a given index of the array.

Parameters

Index	Index at which the new allocation will be done
Args	The arguments to forward to the constructor of the new item.

Returns: Index to the new item

◆ EmplaceAtLowestFreeIndex()

template<typename InElementType , typename Allocator >

template<typename... ArgsType>

int32 TSparseArray< InElementType, Allocator >::EmplaceAtLowestFreeIndex	(	int32 &	LowestFreeIndexSearchStart,
		ArgsType &&...	Args
	)

inline

Constructs a new item at the lowest free index of the array. This requires a search which can be accelerated with LowestFreeIndexSearchStart.

Parameters

LowestFreeIndexSearchStart	Where to start the search for a free index.
Args	The arguments to forward to the constructor of the new item.

Returns: Index to the new item

◆ Empty()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::Empty ( int32 ExpectedNumElements = 0 )

inline

Removes all elements from the array, potentially leaving space allocated for an expected number of elements about to be added.

Parameters

ExpectedNumElements - The expected number of elements about to be added.

◆ end() [1/2]

template<typename InElementType , typename Allocator >

UE_FORCEINLINE_HINT TRangedForIterator TSparseArray< InElementType, Allocator >::end ( )

inline

◆ end() [2/2]

template<typename InElementType , typename Allocator >

UE_FORCEINLINE_HINT TRangedForConstIterator TSparseArray< InElementType, Allocator >::end ( ) const

inline

◆ FindArbitraryElementIndex()

template<typename InElementType , typename Allocator >

int32 TSparseArray< InElementType, Allocator >::FindArbitraryElementIndex ( ) const

inline

Finds the index of an arbitrary element. Callers should not depend on particular patterns in the behaviour of this function.

Returns: The index of any element in the container, or INDEX_NONE if it is empty.

◆ GetAllocatedSize()

template<typename InElementType , typename Allocator >

SIZE_T TSparseArray< InElementType, Allocator >::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

◆ IndexOfByPredicate()

template<typename InElementType , typename Allocator >

template<typename Predicate >

int32 TSparseArray< InElementType, Allocator >::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.

◆ Insert()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::Insert	(	int32	Index,
		typename TTypeTraits< ElementType >::ConstInitType	Element
	)

inline

Inserts an element to the array.

◆ IsCompact()

template<typename InElementType , typename Allocator >

bool TSparseArray< InElementType, Allocator >::IsCompact ( ) const

inline

◆ operator!=()

template<typename InElementType , typename Allocator >

bool TSparseArray< InElementType, Allocator >::operator!= ( const TSparseArray< InElementType, Allocator > & B ) const

inline

Inequality comparison operator. Checks that both arrays have the same elements and element indices; that means that unallocated elements are signifigant!

◆ operator+=() [1/2]

template<typename InElementType , typename Allocator >

TSparseArray & TSparseArray< InElementType, Allocator >::operator+= ( const TArray< ElementType > & OtherArray )

inline

◆ operator+=() [2/2]

template<typename InElementType , typename Allocator >

TSparseArray & TSparseArray< InElementType, Allocator >::operator+= ( const TSparseArray< InElementType, Allocator > & OtherArray )

inline

Concatenation operators

◆ operator=() [1/3]

template<typename InElementType , typename Allocator >

TSparseArray & TSparseArray< InElementType, Allocator >::operator= ( const TSparseArray< InElementType, Allocator > & InCopy )

inline

Copy assignment operator.

◆ operator=() [2/3]

template<typename InElementType , typename Allocator >

TSparseArray & TSparseArray< InElementType, Allocator >::operator= ( std::initializer_list< ElementType > InList )

inline

Initializer list assignment operator.

◆ operator=() [3/3]

template<typename InElementType , typename Allocator >

TSparseArray & TSparseArray< InElementType, Allocator >::operator= ( TSparseArray< InElementType, Allocator > && InCopy )

inline

Move assignment operator.

◆ operator==() [1/2]

template<typename InElementType , typename Allocator >

bool TSparseArray< InElementType, Allocator >::operator== ( const TSparseArray< InElementType, Allocator > & B ) const

inline

Equality comparison operator. Checks that both arrays have the same elements and element indices; that means that unallocated elements are signifigant!

◆ operator==() [2/2]

template<typename InElementType , typename Allocator >

bool TSparseArray< InElementType, Allocator >::operator== ( FIntrusiveUnsetOptionalState Tag ) const

inline

◆ operator[]() [1/2]

template<typename InElementType , typename Allocator >

ElementType & TSparseArray< InElementType, Allocator >::operator[] ( int32 Index )

inline

◆ operator[]() [2/2]

template<typename InElementType , typename Allocator >

const ElementType & TSparseArray< InElementType, Allocator >::operator[] ( int32 Index ) const

inline

◆ PointerToIndex()

template<typename InElementType , typename Allocator >

int32 TSparseArray< InElementType, Allocator >::PointerToIndex ( const ElementType * Ptr ) const

inline

◆ RemoveAt()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::RemoveAt	(	int32	Index,
		int32	Count = `1`
	)

inline

Removes Count elements from the array, starting from Index.

◆ Reset()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::Reset ( )

inline

Empties the array, but keep its allocated memory as slack.

◆ Sort() [1/2]

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::Sort ( )

inline

Sorts the elements assuming < operator is defined for ElementType.

◆ Sort() [2/2]

template<typename InElementType , typename Allocator >

template<typename PREDICATE_CLASS >

void TSparseArray< InElementType, Allocator >::Sort ( const PREDICATE_CLASS & Predicate )

inline

Sorts the elements using the provided comparison class.

◆ StableSort() [1/2]

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::StableSort ( )

inline

Stable sorts the elements assuming < operator is defined for ElementType.

◆ StableSort() [2/2]

template<typename InElementType , typename Allocator >

template<typename PREDICATE_CLASS >

void TSparseArray< InElementType, Allocator >::StableSort ( const PREDICATE_CLASS & Predicate )

inline

Stable sorts the elements using the provided comparison class.

◆ WriteMemoryImage()

template<typename InElementType , typename Allocator >

void TSparseArray< InElementType, Allocator >::WriteMemoryImage ( FMemoryImageWriter & Writer ) const

inline

Friends And Related Symbol Documentation

◆ TScriptSparseArray

template<typename InElementType , typename Allocator >

template<typename , typename >

friend class TScriptSparseArray

friend

Member Data Documentation

◆ bHasIntrusiveUnsetOptionalState

template<typename InElementType , typename Allocator >

constexpr bool TSparseArray< InElementType, Allocator >::bHasIntrusiveUnsetOptionalState = true

staticconstexpr

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

Engine/Source/Runtime/Core/Public/Containers/SparseArray.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IntrusiveUnsetOptionalStateType

Constructor & Destructor Documentation

◆ ~TSparseArray()

◆ TSparseArray() [1/6]

◆ TSparseArray() [2/6]

◆ TSparseArray() [3/6]

◆ TSparseArray() [4/6]

◆ TSparseArray() [5/6]

◆ TSparseArray() [6/6]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AppendHash()

◆ begin() [1/2]

◆ begin() [2/2]

◆ CheckAddress()

◆ CompactStable()

◆ CopyUnfrozen()

◆ CountBytes()

◆ CreateConstIterator()

◆ CreateIterator()

◆ Emplace()

◆ EmplaceAt()

◆ EmplaceAtLowestFreeIndex()

◆ Empty()

◆ end() [1/2]

◆ end() [2/2]

◆ FindArbitraryElementIndex()

◆ GetAllocatedSize()

◆ IndexOfByPredicate()

◆ Insert()

◆ IsCompact()

◆ operator!=()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ PointerToIndex()

◆ RemoveAt()

◆ Reset()

◆ Sort() [1/2]

◆ Sort() [2/2]

◆ StableSort() [1/2]

◆ StableSort() [2/2]

◆ WriteMemoryImage()

Friends And Related Symbol Documentation

◆ TScriptSparseArray

Member Data Documentation

◆ bHasIntrusiveUnsetOptionalState