#include <SortedMap.h>

Inheritance diagram for TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >:

Classes
class	TConstIterator

class	TConstKeyIterator

class	TConstReverseIterator

class	TIterator

class	TKeyIterator

class	TReverseIterator

Public Types
typedef InKeyType	KeyType

typedef InValueType	ValueType

typedef TTypeTraits< KeyType >::ConstPointerType	KeyConstPointerType

typedef TTypeTraits< KeyType >::ConstInitType	KeyInitType

typedef TTypeTraits< ValueType >::ConstInitType	ValueInitType

typedef TPair< KeyType, ValueType >	ElementType

using	IntrusiveUnsetOptionalStateType = TSortedMap

typedef ElementArrayType::RangedForIteratorType	RangedForIteratorType

typedef ElementArrayType::RangedForConstIteratorType	RangedForConstIteratorType

Public Member Functions
	TSortedMap ()=default

	TSortedMap (TSortedMap &&)=default

	TSortedMap (const TSortedMap &)=default

TSortedMap &	operator= (TSortedMap &&)=default

TSortedMap &	operator= (const TSortedMap &)=default

template<typename OtherArrayAllocator >
	TSortedMap (TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > &&Other)

template<typename OtherArrayAllocator >
	TSortedMap (const TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > &Other)

	TSortedMap (std::initializer_list< TPairInitializer< const KeyType &, const ValueType & > > InitList)

	TSortedMap (FIntrusiveUnsetOptionalState Tag)

bool	operator== (FIntrusiveUnsetOptionalState Tag) const

template<typename OtherArrayAllocator >
TSortedMap &	operator= (TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > &&Other)

template<typename OtherArrayAllocator >
TSortedMap &	operator= (const TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > &Other)

TSortedMap &	operator= (std::initializer_list< TPairInitializer< const KeyType &, const ValueType & > > InitList)

UE_FORCEINLINE_HINT bool	operator== (const TSortedMap &Other) const

UE_FORCEINLINE_HINT bool	operator!= (const TSortedMap &Other) const

UE_FORCEINLINE_HINT void	Empty (int32 ExpectedNumElements=0)

UE_FORCEINLINE_HINT void	Reset ()

UE_FORCEINLINE_HINT void	Shrink ()

UE_FORCEINLINE_HINT void	Reserve (int32 Number)

bool	IsEmpty () const

UE_FORCEINLINE_HINT int32	Num () const

UE_FORCEINLINE_HINT int32	Max () const

UE_FORCEINLINE_HINT SIZE_T	GetAllocatedSize () const

UE_FORCEINLINE_HINT void	CountBytes (FArchive &Ar) const

UE_FORCEINLINE_HINT ValueType &	Add (const KeyType &InKey, const ValueType &InValue)

UE_FORCEINLINE_HINT ValueType &	Add (const KeyType &InKey, ValueType &&InValue)

UE_FORCEINLINE_HINT ValueType &	Add (KeyType &&InKey, const ValueType &InValue)

UE_FORCEINLINE_HINT ValueType &	Add (KeyType &&InKey, ValueType &&InValue)

UE_FORCEINLINE_HINT ValueType &	Add (const KeyType &InKey)

UE_FORCEINLINE_HINT ValueType &	Add (KeyType &&InKey)

template<typename InitKeyType = KeyType, typename InitValueType = ValueType>
ValueType &	Emplace (InitKeyType &&InKey, InitValueType &&InValue)

template<typename InitKeyType = KeyType>
ValueType &	Emplace (InitKeyType &&InKey)

int32	Remove (KeyConstPointerType InKey)

const KeyType *	FindKey (ValueInitType Value) const

ValueType *	Find (KeyConstPointerType Key)

UE_FORCEINLINE_HINT const ValueType *	Find (KeyConstPointerType Key) const

UE_FORCEINLINE_HINT ValueType &	FindOrAdd (const KeyType &Key)

UE_FORCEINLINE_HINT ValueType &	FindOrAdd (KeyType &&Key)

ValueType &	FindChecked (KeyConstPointerType Key)

const ValueType &	FindChecked (KeyConstPointerType Key) const

ValueType	FindRef (KeyConstPointerType Key) const

ValueType	FindRef (KeyConstPointerType Key, ValueType DefaultValue) const

ElementType *	FindArbitraryElement ()

const ElementType *	FindArbitraryElement () const

bool	Contains (KeyConstPointerType Key) const

template<typename Allocator >
int32	GetKeys (TArray< KeyType, Allocator > &OutKeys) const

template<typename Allocator >
void	GenerateKeyArray (TArray< KeyType, Allocator > &OutArray) const

template<typename Allocator >
void	GenerateValueArray (TArray< ValueType, Allocator > &OutArray) const

void	Dump (FOutputDevice &Ar)

bool	RemoveAndCopyValue (KeyInitType Key, ValueType &OutRemovedValue)

ValueType	FindAndRemoveChecked (KeyConstPointerType Key)

template<typename OtherArrayAllocator , typename OtherSortPredicate >
void	Append (TSortedMap< KeyType, ValueType, OtherArrayAllocator, OtherSortPredicate > &&OtherMap)

template<typename OtherArrayAllocator , typename OtherSortPredicate >
void	Append (const TSortedMap< KeyType, ValueType, OtherArrayAllocator, OtherSortPredicate > &OtherMap)

UE_FORCEINLINE_HINT ValueType &	operator[] (KeyConstPointerType Key)

UE_FORCEINLINE_HINT const ValueType &	operator[] (KeyConstPointerType Key) const

	UE_DEPRECATED (5.7 until 5.9, "GetMaxIndex() should be replaced with Num() - 1.") UE_FORCEINLINE_HINT int32 GetMaxIndex() const

UE_FORCEINLINE_HINT bool	IsValidId (FSetElementId Id) const

UE_FORCEINLINE_HINT ElementType &	Get (FSetElementId Id)

UE_FORCEINLINE_HINT const ElementType &	Get (FSetElementId Id) const

UE_FORCEINLINE_HINT TIterator	CreateIterator ()

UE_FORCEINLINE_HINT TConstIterator	CreateConstIterator () const

UE_FORCEINLINE_HINT TKeyIterator	CreateKeyIterator (KeyInitType InKey)

UE_FORCEINLINE_HINT TConstKeyIterator	CreateConstKeyIterator (KeyInitType InKey) const

UE_FORCEINLINE_HINT RangedForIteratorType	begin ()

UE_FORCEINLINE_HINT RangedForConstIteratorType	begin () const

UE_FORCEINLINE_HINT RangedForIteratorType	end ()

UE_FORCEINLINE_HINT RangedForConstIteratorType	end () const

Static Public Attributes
static constexpr bool	bHasIntrusiveUnsetOptionalState = true

Friends
template<typename OtherKeyType , typename OtherValueType , typename OtherArrayAllocator , typename OtherSortPredicate >
class	TSortedMap

struct	TSortedMapPrivateFriend

Detailed Description

template<typename InKeyType, typename InValueType, typename ArrayAllocator, typename SortPredicate>
class TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >

A Map of keys to value, implemented as a sorted TArray of TPairs.

It has a mostly identical interface to TMap and is designed as a drop in replacement. Keys must be unique, there is no equivalent sorted version of TMultiMap. It uses half as much memory as TMap, but adding and removing elements is O(n), and finding is O(Log n). In practice it is faster than TMap for low element counts, and slower as n increases, This map is always kept sorted by the key type so cannot be sorted manually.

Member Typedef Documentation

◆ ElementType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef TPair<KeyType, ValueType> TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::ElementType

◆ IntrusiveUnsetOptionalStateType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

using TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::IntrusiveUnsetOptionalStateType = TSortedMap

◆ KeyConstPointerType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef TTypeTraits<KeyType>::ConstPointerType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::KeyConstPointerType

◆ KeyInitType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef TTypeTraits<KeyType>::ConstInitType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::KeyInitType

◆ KeyType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef InKeyType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::KeyType

◆ RangedForConstIteratorType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef ElementArrayType::RangedForConstIteratorType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::RangedForConstIteratorType

◆ RangedForIteratorType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef ElementArrayType::RangedForIteratorType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::RangedForIteratorType

Ranged For iterators. Unlike normal TMap these are not the same as the normal iterator for performance reasons

◆ ValueInitType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef TTypeTraits<ValueType>::ConstInitType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::ValueInitType

◆ ValueType

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

typedef InValueType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::ValueType

Constructor & Destructor Documentation

◆ TSortedMap() [1/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( )

default

◆ TSortedMap() [2/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate > && )

default

◆ TSortedMap() [3/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( const TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate > & )

default

◆ TSortedMap() [4/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherArrayAllocator >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > && Other )

inline

Constructor for moving elements from a TSortedMap with a different ArrayAllocator.

◆ TSortedMap() [5/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherArrayAllocator >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( const TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > & Other )

inline

Constructor for copying elements from a TSortedMap with a different ArrayAllocator.

◆ TSortedMap() [6/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( std::initializer_list< TPairInitializer< const KeyType &, const ValueType & > > InitList )

inline

Constructor which gets its elements from a native initializer list

◆ TSortedMap() [7/7]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::TSortedMap ( FIntrusiveUnsetOptionalState Tag )

inlineexplicit

Member Function Documentation

◆ Add() [1/6]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Add ( const KeyType & InKey )

inline

Sets a default value associated with a key.

Parameters

InKey The key to associate the value with.

Returns: A reference to the value as stored in the map. The reference is only valid until the next change to any key in the map.

◆ Add() [2/6]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Add	(	const KeyType &	InKey,
		const ValueType &	InValue
	)

inline

Sets the value associated with a key.

Parameters

InKey	The key to associate the value with.
InValue	The value to associate with the key.

Returns: A reference to the value as stored in the map (only valid until the next change to any key in the map).

◆ Add() [3/6]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Add	(	const KeyType &	InKey,
		ValueType &&	InValue
	)

inline

◆ Add() [4/6]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Add ( KeyType && InKey )

inline

◆ Add() [5/6]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Add	(	KeyType &&	InKey,
		const ValueType &	InValue
	)

inline

◆ Add() [6/6]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Add	(	KeyType &&	InKey,
		ValueType &&	InValue
	)

inline

◆ Append() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherArrayAllocator , typename OtherSortPredicate >

void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Append ( const TSortedMap< KeyType, ValueType, OtherArrayAllocator, OtherSortPredicate > & OtherMap )

inline

Add all items from another map to our map (if any keys are in both, the value from the other map wins).

Parameters

OtherMap The other map of items to add.

◆ Append() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherArrayAllocator , typename OtherSortPredicate >

void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Append ( TSortedMap< KeyType, ValueType, OtherArrayAllocator, OtherSortPredicate > && OtherMap )

inline

Move all items from another map into our map (if any keys are in both, the value from the other map wins) and empty the other map.

Parameters

OtherMap The other map of items to move the elements from.

◆ begin() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT RangedForIteratorType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::begin ( )

inline

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

◆ begin() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT RangedForConstIteratorType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::begin ( ) const

inline

◆ Contains()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Contains ( KeyConstPointerType Key ) const

inline

Checks if map contains the specified key.

Parameters

Key	The key to check for.

Returns: true if the map contains the key.

◆ CountBytes()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::CountBytes ( FArchive & Ar ) const

inline

Tracks the container's memory use through an archive.

◆ CreateConstIterator()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT TConstIterator TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::CreateConstIterator ( ) const

inline

Creates a const iterator over all the pairs in this map

◆ CreateConstKeyIterator()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT TConstKeyIterator TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::CreateConstKeyIterator ( KeyInitType InKey ) const

inline

Creates a const iterator over the values associated with a specified key in a map. This will be at most one value because keys must be unique

◆ CreateIterator()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT TIterator TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::CreateIterator ( )

inline

Creates an iterator over all the pairs in this map

◆ CreateKeyIterator()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT TKeyIterator TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::CreateKeyIterator ( KeyInitType InKey )

inline

Creates an iterator over the values associated with a specified key in a map. This will be at most one value because keys must be unique

◆ Dump()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Dump ( FOutputDevice & Ar )

inline

Describes the map's contents through an output device.

Parameters

Ar	The output device to describe the map's contents through.

◆ Emplace() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename InitKeyType = KeyType>

ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Emplace ( InitKeyType && InKey )

inline

Sets a default value associated with a key.

Parameters

InKey The key to associate the value with.

Returns: A reference to the value as stored in the map (only valid until the next change to any key in the map).

◆ Emplace() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename InitKeyType = KeyType, typename InitValueType = ValueType>

ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Emplace	(	InitKeyType &&	InKey,
		InitValueType &&	InValue
	)

inline

Sets the value associated with a key.

Parameters

InKey	- The key to associate the value with.
InValue	- The value to associate with the key.

Returns: A reference to the value as stored in the map (only valid until the next change to any key in the map).

◆ Empty()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Empty ( int32 ExpectedNumElements = 0 )

inline

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

Parameters

ExpectedNumElements The number of elements about to be added to the set.

◆ end() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT RangedForIteratorType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::end ( )

inline

◆ end() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT RangedForConstIteratorType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::end ( ) const

inline

◆ Find() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

ValueType * TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Find ( KeyConstPointerType Key )

inline

Returns the value associated with a specified key.

Parameters

Key	The key to search for.

Returns: A pointer to the value associated with the specified key, or nullptr if the key isn't contained in this map. The pointer (only valid until the next change to any key in the map).

◆ Find() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT const ValueType * TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Find ( KeyConstPointerType Key ) const

inline

◆ FindAndRemoveChecked()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

ValueType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindAndRemoveChecked ( KeyConstPointerType Key )

inline

Finds a pair with the specified key, removes it from the map, and returns the value part of the pair. If no pair was found, an exception is thrown.

Parameters

Key	The key to search for

Returns: Whether or not the key was found

◆ FindArbitraryElement() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

ElementType * TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindArbitraryElement ( )

inline

Finds any pair in the map and returns a pointer to it. Callers should not depend on particular patterns in the behaviour of this function.

Returns: A pointer to an arbitrary pair, or nullptr if the container is empty.

◆ FindArbitraryElement() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

const ElementType * TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindArbitraryElement ( ) const

inline

◆ FindChecked() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindChecked ( KeyConstPointerType Key )

inline

Returns a reference to the value associated with a specified key.

Parameters

Key	The key to search for.

Returns: The value associated with the specified key, or triggers an assertion if the key does not exist.

◆ FindChecked() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

const ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindChecked ( KeyConstPointerType Key ) const

inline

◆ FindKey()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

const KeyType * TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindKey ( ValueInitType Value ) const

inline

Returns the key associated with the specified value. The time taken is O(N) in the number of pairs.

Parameters

Value The value to search for.

Returns: A pointer to the key associated with the specified value, or nullptr if the value isn't contained in this map (only valid until the next change to any key in the map).

◆ FindOrAdd() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindOrAdd ( const KeyType & Key )

inline

Returns the value associated with a specified key, or if none exists, adds a value using the default constructor.

Parameters

Key	The key to search for.

Returns: A reference to the value associated with the specified key.

◆ FindOrAdd() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindOrAdd ( KeyType && Key )

inline

◆ FindRef() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

ValueType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindRef ( KeyConstPointerType Key ) const

inline

Returns the value associated with a specified key.

Parameters

Key	The key to search for.

Returns: The value associated with the specified key, or the default value for the ValueType if the key isn't contained in this map.

◆ FindRef() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

ValueType TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::FindRef	(	KeyConstPointerType	Key,
		ValueType	DefaultValue
	)		const

inline

Returns the value associated with a specified key.

Parameters

Key	The key to search for.
DefaultValue	The fallback value if the key is not found.

Returns: The value associated with the specified key, or DefaultValue if the key isn't contained in this map.

◆ GenerateKeyArray()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename Allocator >

void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::GenerateKeyArray ( TArray< KeyType, Allocator > & OutArray ) const

inline

Generates an array from the keys in this map.

◆ GenerateValueArray()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename Allocator >

void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::GenerateValueArray ( TArray< ValueType, Allocator > & OutArray ) const

inline

Generates an array from the values in this map.

◆ Get() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ElementType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Get ( FSetElementId Id )

inline

Return a mapped pair by internal identifier. Element must be valid (see @IsValidId).

◆ Get() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT const ElementType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Get ( FSetElementId Id ) const

inline

Return a mapped pair by internal identifier. Element must be valid (see @IsValidId).

◆ GetAllocatedSize()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT SIZE_T TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::GetAllocatedSize ( ) 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.

◆ GetKeys()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename Allocator >

int32 TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::GetKeys ( TArray< KeyType, Allocator > & OutKeys ) const

inline

Returns the unique keys contained within this map.

Parameters

OutKeys Upon return, contains the set of unique keys in this map.

Returns: The number of unique keys in the map.

◆ IsEmpty()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::IsEmpty ( ) const

inline

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

Returns: True if the map is empty.

See also: Num

◆ IsValidId()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::IsValidId ( FSetElementId Id ) const

inline

Checks whether an element id is valid.

Parameters

Id	- The element id to check.

Returns: true if the element identifier refers to a valid element in this map.

◆ Max()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT int32 TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Max ( ) const

inline

Returns: The number of elements the map can hold before reallocation.

◆ Num()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT int32 TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Num ( ) const

inline

Returns: The number of elements in the map.

◆ operator!=()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator!= ( const TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate > & Other ) const

inline

Inequality operator. This is efficient because pairs are always sorted.

◆ operator=() [1/5]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator= ( const TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate > & )

default

◆ operator=() [2/5]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherArrayAllocator >

TSortedMap & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator= ( const TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > & Other )

inline

Assignment operator for copying elements from a TSortedMap with a different ArrayAllocator.

◆ operator=() [3/5]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator= ( std::initializer_list< TPairInitializer< const KeyType &, const ValueType & > > InitList )

inline

Assignment operator which gets its elements from a native initializer list

◆ operator=() [4/5]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator= ( TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate > && )

default

◆ operator=() [5/5]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherArrayAllocator >

TSortedMap & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator= ( TSortedMap< KeyType, ValueType, OtherArrayAllocator, SortPredicate > && Other )

inline

Assignment operator for moving elements from a TSortedMap with a different ArrayAllocator.

◆ operator==() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator== ( const TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate > & Other ) const

inline

Equality operator. This is efficient because pairs are always sorted.

◆ operator==() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator== ( FIntrusiveUnsetOptionalState Tag ) const

inline

◆ operator[]() [1/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator[] ( KeyConstPointerType Key )

inline

◆ operator[]() [2/2]

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT const ValueType & TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::operator[] ( KeyConstPointerType Key ) const

inline

◆ Remove()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

int32 TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Remove ( KeyConstPointerType InKey )

inline

Removes all value associations for a key.

Parameters

InKey The key to remove associated values for.

Returns: The number of values that were associated with the key.

◆ RemoveAndCopyValue()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::RemoveAndCopyValue	(	KeyInitType	Key,
		ValueType &	OutRemovedValue
	)

inline

Removes the pair with the specified key and copies the value that was removed to the ref parameter.

Parameters

Key	The key to search for
OutRemovedValue	If found, the value that was removed (not modified if the key was not found)

Returns: Whether or not the key was found

◆ Reserve()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Reserve ( int32 Number )

inline

Preallocates enough memory to contain Number elements.

◆ Reset()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Reset ( )

inline

Efficiently empties out the map but preserves all allocations and capacities.

◆ Shrink()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

UE_FORCEINLINE_HINT void TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::Shrink ( )

inline

Shrinks the pair set to avoid slack.

◆ UE_DEPRECATED()

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::UE_DEPRECATED	(	5.7 until 5.	9,
		"GetMaxIndex() should be replaced with Num() - 1."
	)		const

inline

Returns: The non-inclusive maximum index of elements in the map (was: the max valid index of the elements in the sparse storage).

Friends And Related Symbol Documentation

◆ TSortedMap

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

template<typename OtherKeyType , typename OtherValueType , typename OtherArrayAllocator , typename OtherSortPredicate >

friend class TSortedMap

friend

◆ TSortedMapPrivateFriend

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

friend struct TSortedMapPrivateFriend

friend

Member Data Documentation

◆ bHasIntrusiveUnsetOptionalState

template<typename InKeyType , typename InValueType , typename ArrayAllocator , typename SortPredicate >

constexpr bool TSortedMap< InKeyType, InValueType, ArrayAllocator, SortPredicate >::bHasIntrusiveUnsetOptionalState = true

staticconstexpr

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

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ElementType

◆ IntrusiveUnsetOptionalStateType

◆ KeyConstPointerType

◆ KeyInitType

◆ KeyType

◆ RangedForConstIteratorType

◆ RangedForIteratorType

◆ ValueInitType

◆ ValueType

Constructor & Destructor Documentation

◆ TSortedMap() [1/7]

◆ TSortedMap() [2/7]

◆ TSortedMap() [3/7]

◆ TSortedMap() [4/7]

◆ TSortedMap() [5/7]

◆ TSortedMap() [6/7]

◆ TSortedMap() [7/7]

Member Function Documentation

◆ Add() [1/6]

◆ Add() [2/6]

◆ Add() [3/6]

◆ Add() [4/6]

◆ Add() [5/6]

◆ Add() [6/6]

◆ Append() [1/2]

◆ Append() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ Contains()

◆ CountBytes()

◆ CreateConstIterator()

◆ CreateConstKeyIterator()

◆ CreateIterator()

◆ CreateKeyIterator()

◆ Dump()

◆ Emplace() [1/2]

◆ Emplace() [2/2]

◆ Empty()

◆ end() [1/2]

◆ end() [2/2]

◆ Find() [1/2]

◆ Find() [2/2]

◆ FindAndRemoveChecked()

◆ FindArbitraryElement() [1/2]

◆ FindArbitraryElement() [2/2]

◆ FindChecked() [1/2]

◆ FindChecked() [2/2]

◆ FindKey()

◆ FindOrAdd() [1/2]

◆ FindOrAdd() [2/2]

◆ FindRef() [1/2]

◆ FindRef() [2/2]

◆ GenerateKeyArray()

◆ GenerateValueArray()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAllocatedSize()

◆ GetKeys()

◆ IsEmpty()

◆ IsValidId()

◆ Max()

◆ Num()

◆ operator!=()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Remove()