1. Epic GamesDeveloper
  3. TMultiMap

TMultiMap

A [TMapBase](API\Runtime\Core\TMapBase) specialization that allows multiple values to be associated with each key.

API > API/Runtime > API/Runtime/Core

A TMapBase specialization that allows multiple values to be associated with each key.

   
Name TMultiMap
Type class
Header File /Engine/Source/Runtime/Core/Public/Containers/Map.h
Include Path #include "Containers/Map.h"

Syntax

template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs>  
class TMultiMap : public TSortableMapBase< KeyType, ValueType, SetAllocator, KeyFuncs >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

 Constructor which gets its elements from a native initializer list Containers/Map.h  
  Containers/Map.h  
  Containers/Map.h  

TMultiMap ( const TMultiMap&
)

   Containers/Map.h  

TMultiMap ( TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other
)

 Constructor for moving elements from a TMap with a different SetAllocator Containers/Map.h  

TMultiMap ( const TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other
)

 Constructor for copying elements from a TMap with a different SetAllocator Containers/Map.h  
  Containers/Map.h  

Typedefs

Name Type Remarks Include Path
IntrusiveUnsetOptionalStateType TMultiMap   Containers/Map.h
KeyConstPointerType Super::KeyConstPointerType   Containers/Map.h
KeyInitType Super::KeyInitType   Containers/Map.h
Super TSortableMapBase< KeyType, ValueType, SetAllocator, KeyFuncs >   Containers/Map.h
ValueInitType Super::ValueInitType   Containers/Map.h

Constants

Name Type Remarks Include Path
bHasIntrusiveUnsetOptionalState bool Start - intrusive TOptional state //. Containers/Map.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

ValueType & AddUnique ( const KeyType& InKey,
const ValueType& InValue
)

 Add a key-value association to the map. Containers/Map.h  

ValueType & AddUnique ( const KeyType& InKey,
ValueType&& InValue
)

   Containers/Map.h  

ValueType & AddUnique ( KeyType&& InKey,
const ValueType& InValue
)

   Containers/Map.h  

ValueType & AddUnique ( KeyType&& InKey,
ValueType&& InValue
)

   Containers/Map.h  

void Append ( TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& OtherMultiMap
)

 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. Containers/Map.h  

void Append ( const TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& OtherMultiMap
)

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

ValueType & EmplaceUnique ( InitKeyType&& InKey,
InitValueType&& InValue
)

 Add a key-value association to the map. Containers/Map.h  

const ValueType * FindPair ( KeyInitType Key,
ValueInitType Value
) const

 Find an association between a specified key and value. (const) Containers/Map.h  

ValueType * FindPair ( KeyInitType Key,
ValueInitType Value
)

 Find an association between a specified key and value. Containers/Map.h  

void MultiFind ( KeyInitType Key,
TArray< ValueType, Allocator >& OutValues,
bool bMaintainOrder
) const

 Finds all values associated with the specified key. Containers/Map.h  

void MultiFindPointer ( KeyInitType Key,
TArray< ValueType*, Allocator >& OutValues,
bool bMaintainOrder
)

   Containers/Map.h  

void MultiFindPointer ( KeyInitType Key,
TArray< const ValueType*, Allocator >& OutValues,
bool bMaintainOrder
) const

 Finds all values associated with the specified key. Containers/Map.h  

int32 Num ( KeyInitType Key
) const

 Returns the number of values within this map associated with the specified key Containers/Map.h  

int32 Num ()

 Since we implement an overloaded Num() function in TMultiMap, we need to reimplement TMapBase::Num to make it visible. Containers/Map.h  

int32 Remove ( KeyConstPointerType InKey
)

 Remove all value associations for a key. Containers/Map.h  

int32 Remove ( KeyInitType InKey,
ValueInitType InValue
)

 Remove associations between the specified key and value from the map. Containers/Map.h  

int32 RemoveSingle ( KeyInitType InKey,
ValueInitType InValue
)

 Remove the first association between the specified key and value from the map. Containers/Map.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Containers/Map.h  
  Containers/Map.h  

TMultiMap & operator= ( TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other
)

 End - intrusive TOptional state //. Containers/Map.h  

TMultiMap & operator= ( const TMultiMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other
)

 Assignment operator for copying elements from a TMap with a different SetAllocator Containers/Map.h  

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

 Assignment operator which gets its elements from a native initializer list Containers/Map.h  

bool operator== ( FIntrusiveUnsetOptionalState Tag
) const

   Containers/Map.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page