就业培训     下载中心     Wiki     联络 登录   注册

---

1. 首页
2. C4D R23.110 C++ SDK

Classes | Public Types | 公共成员函数 | Protected Member Functions | Protected Attributes | 私有成员函数 | 所有成员列表

HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD > Class Template Reference Data Structures

#include <hybridmap.h>

Inheritance diagram for HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >:

[ legend ]

详细描述

template<typename K, typename V, typename SMALL, typename LARGE, Int THRESHOLD, Int REVERSE_THRESHOLD>
class maxon::HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >

A HybridMap allows to take advantage of two different map implementations. For example, in a typical setting an ArrayMap may perform better with a low number of entries, while a BurstTrieMap gets better when the number of entries increases. If you cannot predict that the number of entries will always be small (to use an ArrayMap ) or large (to use a BurstTrieMap ), you can use the HybridMap which automatically switches between two implementations based on the number of entries:

HybridMap<UInt, String, ArrayMapSelector<>, BurstTrieMapSelector<> , 64, 16> map;

见 HashMap for more examples on how to use maps in general.

Template Parameters

K	Type of keys.
V	Type of values.
SMALL	A map selector template to choose the map implementation to use for a small number of entries.
LARGE	A map selector template to choose the map implementation to use for a large number of entries.
THRESHOLD	When the number of entries reaches THRESHOLD, HybridMap switches to the LARGE implementation.
REVERSE_THRESHOLD	When the number of entries falls below REVERSE_THRESHOLD, HybridMap switches back to the SMALL implementation. If this is negative, this will never happen.

另请参阅

$ref maps

Public Types
using	SmallType = typename SMALL::template Type< K, V >
using	LargeType = typename LARGE::template Type< K, V >
using	IsHybridMap = std::true_type
using	Iterator = IteratorTemplate < false, EntryIteratorBase >
using	ConstIterator = IteratorTemplate < true, EntryIteratorBase >
using	KeyIterator = IteratorTemplate < false, KeyIteratorBase >
using	ConstKeyIterator = IteratorTemplate < true, KeyIteratorBase >
using	ValueIterator = IteratorTemplate < false, ValueIteratorBase >
using	ConstValueIterator = IteratorTemplate < true, ValueIteratorBase >
Public Types inherited from MapBase0< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, K, V, EmptyClass, DefaultCompare >
using	MapType = HybridMap < K, V, SMALL , LARGE, THRESHOLD, REVERSE_THRESHOLD >
using	Super = BaseCollection < HybridMap < K, V, SMALL , LARGE, THRESHOLD, REVERSE_THRESHOLD >, EmptyClass >
using	KeyType = K
using	ValueType = V
Public Types inherited from BaseCollection< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, EmptyClass >
using	IsCollection = std::true_type

公共成员函数
Iterator	Begin ()
Iterator	End ()
ConstIterator	Begin () const
ConstIterator	End () const
KeyIterator	GetKeys ()
ConstKeyIterator	GetKeys () const
ValueIterator	GetValues ()
ConstValueIterator	GetValues () const
	HybridMap ()
	~HybridMap ()
	HybridMap ( HybridMap && src )
	MAXON_OPERATOR_MOVE_ASSIGNMENT ( HybridMap )
template<typename MAP >
Result < void >	CopyFromImpl (MAP && src , COLLECTION_RESIZE_FLAGS resizeFlags, OverloadRank0 )
template<typename MAP >
SFINAEHelper < Result < void >, typename std::remove_reference< MAP >::type::IsHybridMap >::type	CopyFromImpl (MAP && src , COLLECTION_RESIZE_FLAGS resizeFlags, OverloadRank1 )
void	Flush ()
void	重置 ()
Int	GetCount () const
Int	GetOperationCountForSearch () const
Int	GetMemorySize () const
ResultMem	SetCapacityHint ( Int capacity, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
ResultRef < V >	InsertKey (const K &key, Bool &created= BoolLValue ())
ResultRef < V >	InsertKey (K &&key, Bool &created= BoolLValue ())
ResultMemT < Iterator >	InsertEntry (const K &key, Bool &created= BoolLValue ())
ResultMemT < Iterator >	InsertEntry (K &&key, Bool &created= BoolLValue ())
ResultMemT < Iterator >	Insert (const K &key, const V &value, Bool &created= BoolLValue ())
ResultMemT < Iterator >	Insert (K &&key, const V &value, Bool &created= BoolLValue ())
ResultMemT < Iterator >	Insert (const K &key, V &&value, Bool &created= BoolLValue ())
ResultMemT < Iterator >	Insert (K &&key, V &&value, Bool &created= BoolLValue ())
const V *	FindValue (const K &key) const
V *	FindValue (const K &key)
Iterator	Find (const K &key)
ConstIterator	Find (const K &key) const
Iterator	FindFloor (const K &key)
ConstIterator	FindFloor (const K &key) const
Result < Bool >	Erase (const K &key)
template<template< Bool > class SUPER>
IteratorTemplate < false, SUPER >	Erase (const IteratorTemplate < false, SUPER > &position)
Result < void >	UseLargeMap ()
Result < void >	UseSmallMap ()
Public Member Functions inherited from MapBase< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, K, V, EmptyClass, DefaultCompare >
MAXON_ATTRIBUTE_FORCE_INLINE	MapBase (ARGS &&... args)
MapImpl < HybridMap < K, V, SMALL , LARGE, THRESHOLD, REVERSE_THRESHOLD > & >	ToMap ()
MapImpl < const HybridMap < K, V, SMALL , LARGE, THRESHOLD, REVERSE_THRESHOLD > & >	ToMap () const
MAXON_ATTRIBUTE_FORCE_INLINE	operator MapImpl< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD > & > ()
MAXON_ATTRIBUTE_FORCE_INLINE	operator MapImpl< const HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD > & > () const
Public Member Functions inherited from MapBase0< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, K, V, EmptyClass, DefaultCompare >
MAXON_ATTRIBUTE_FORCE_INLINE	MapBase0 (ARGS &&... args)
MAXON_ATTRIBUTE_FORCE_INLINE Bool	Contains (typename ByValueParam < K >::type key) const
MAXON_ATTRIBUTE_FORCE_INLINE SFINAEHelper < Bool , typename PAIR::KeyType >::type	Contains (const PAIR &pair) const
ResultRef < V >	Append (const K &key)
SFINAEHelper < ResultRef < V >, typename PAIR::KeyType >::type	Append (const PAIR &pair)
Result < void >	添加 (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
Result < void >	AppendAll (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
Result < void >	AppendAllInverse (COLLECTION2 &&other)
Bool	ContainsAllImpl (COLLECTION2 &&other, OverloadRank0 ) const
Result < void >	SubtractImpl (COLLECTION2 &&other, OverloadRank0 )
Bool	IsEqualImpl (const COLLECTION2 &other, COMPARE &&cmp, OverloadRank0 ) const
HashInt	GetHashCode () const
Public Member Functions inherited from BaseCollection< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, EmptyClass >
MAXON_ATTRIBUTE_FORCE_INLINE	BaseCollection (ARGS &&... args)
MAXON_ATTRIBUTE_FORCE_INLINE std::enable_if< maxon::IsCollection< COLLECTION2 >::value, Bool >::type	operator== (const COLLECTION2 &other) const
MAXON_ATTRIBUTE_FORCE_INLINE std::enable_if< maxon::IsCollection< COLLECTION2 >::value, Bool >::type	operator!= (const COLLECTION2 &other) const
MAXON_ATTRIBUTE_FORCE_INLINE std::enable_if< maxon::IsCollection< COLLECTION2 >::value &&! STD_IS_REPLACEMENT (same, typename std::decay< COMPARE >::type, EQUALITY ), Bool >::type	IsEqual (const COLLECTION2 &other, COMPARE &&cmp=COMPARE()) const
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	AppendAll (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::ON_GROW_RESERVE_CAPACITY )
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	CopyFrom (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags= COLLECTION_RESIZE_FLAGS::FIT_TO_SIZE )
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	Subtract (COLLECTION2 &&other)
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	Intersect (const COLLECTION2 &other)
Bool	Intersects (const COLLECTION2 &other) const
MAXON_ATTRIBUTE_FORCE_INLINE Result < void >	CopyFromImpl (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags, OverloadRank0 )
Result < void >	AppendAllImpl (COLLECTION2 &&other, COLLECTION_RESIZE_FLAGS resizeFlags, Bool overwrite, OverloadRank0 )
Result < void >	IntersectImpl (COLLECTION2 &&other, OverloadRank0 )
MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsEmpty () const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	IsPopulated () const
String	ToString (const FormatStatement *formatStatement=nullptr) const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	ContainsAll (COLLECTION2 &&other) const
Bool	ContainsAllImpl (COLLECTION2 &&other, OverloadRank0 ) const

Additional Inherited Members
Static Public Member Functions inherited from MapBase0< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, K, V, EmptyClass, DefaultCompare >
static const K &	GetMapKey (const K &key)
static const K &	GetMapKey (const PAIR &pair)
Static Public Attributes inherited from MapBase0< HybridMap< K, V, SMALL, LARGE, THRESHOLD, REVERSE_THRESHOLD >, K, V, EmptyClass, DefaultCompare >
static const COLLECTION_KIND	KIND

Member Typedef Documentation

◆  SmallType

◆  LargeType

◆  IsHybridMap

◆  Iterator

◆  ConstIterator

◆  KeyIterator

◆  ConstKeyIterator

◆  ValueIterator

◆  ConstValueIterator

构造函数 & 析构函数文档编制

◆  HybridMap() [1/2]

◆  ~HybridMap()

◆  HybridMap() [2/2]

成员函数文档编制

◆  Begin() [1/2]

Returns an iterator pointing to the first entry of this map.

返回

Iterator for this map pointing to the first element.

◆  End() [1/2]

Returns an iterator pointing just behind the last entry of this map.

返回

Iterator for this map pointing behind the last element.

◆  Begin() [2/2]

Returns an iterator pointing to the first entry of this map.

返回

Iterator for this map pointing to the first element.

◆  End() [2/2]

Returns an iterator pointing just behind the last entry of this map.

返回

Iterator for this map pointing behind the last element.

◆  GetKeys() [1/2]

Returns a foreach iterator to iterate over all keys of this map.

返回

Foreach iterator over all keys.

◆  GetKeys() [2/2]

Returns a foreach iterator to iterate over all keys of this map.

返回

Foreach iterator over all keys.

◆  GetValues() [1/2]

Returns a foreach iterator to iterate over all values of this map.

返回

Foreach iterator over all values.

◆  GetValues() [2/2]

Returns a foreach iterator to iterate over all values of this map.

返回

Foreach iterator over all values.

◆  MAXON_OPERATOR_MOVE_ASSIGNMENT()

◆  CopyFromImpl() [1/2]

◆  CopyFromImpl() [2/2]

◆  Flush()

Flushes the map so that it is empty afterwards. Depending on the underlying implementations, memory may still be held for re-use. If REVERSE_THRESHOLD is non-negative, Flush() will also switch back to the SMALL implementation.

◆  Reset()

Resets the map. This destructs all entries and frees any memory held by the map. The map will also switch to the SMALL implementation if necessary, so it will be in a state as if it had been newly constructed.

◆  GetCount()

Returns the number of entries in this map.

返回

Number of entries.

◆  GetOperationCountForSearch()

Returns an estimate of the number of operations needed to locate a given key in this map. This is used when two collections are compared: The iteration goes over the collection which would require more operations for search, and each entry is searched in the other collection.

返回

Estimate for the number of operations.

◆  GetMemorySize()

Returns the memory usage of this map.

返回

Memory size in bytes.

◆  SetCapacityHint()

Increases the internal capacity of the map so that it is prepared to hold at least the given number of elements. This is forwarded to the currently used underlying map implementation.

参数

[in]	capacity	The desired capacity.
[in]	resizeFlags	If ON_GROW_FIT_TO_SIZE is set, the collection will use only as much memory as needed to hold the data.

返回

False if allocation failed.

◆  InsertKey() [1/2]

Finds the value associated with the given key, or creates a corresponding entry if it doesn't exist yet. The value of a new entry has to be initialized afterwards (but its default constructor has already been invoked).

参数

[in]	key	Key of the value to find or create.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Pointer to value for the given key, or nullptr if an entry didn't exist and allocation of a new entry failed.

◆  InsertKey() [2/2]

Finds the value associated with the given key, or creates a corresponding entry if it doesn't exist yet. The value of a new entry has to be initialized afterwards (but its default constructor has already been invoked).

参数

[in]	key	Key of the value to find or create. If a new entry is created, its key will be constructed by move-semantics if possible.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Pointer to value for the given key, or nullptr if an entry didn't exist and allocation of a new entry failed.

◆  InsertEntry() [1/2]

Finds the entry with the given key, or creates such an entry if it doesn't exist yet, and returns an iterator pointing to the entry. The value of a new entry has to be initialized afterwards (but its default constructor has already been invoked).

参数

[in]	key	Key of the entry to find or create.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Iterator to the entry for the given key or OutOfMemoryError if the allocation failed.

◆  InsertEntry() [2/2]

Finds the entry with the given key, or creates such an entry if it doesn't exist yet, and returns an iterator pointing to the entry. The value of a new entry has to be initialized afterwards (but its default constructor has already been invoked).

参数

[in]	key	Key of the entry to find or create. If a new entry is created, its key will be constructed by move-semantics if possible.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Iterator to the entry for the given key or OutOfMemoryError if the allocation failed.

◆  Insert() [1/4]

Finds the entry with the given key, or creates such an entry if it doesn't exist yet, and returns an iterator pointing to the entry. The value of the entry will be set to value in any case.

参数

[in]	key	Key of the entry to find or create.
[in]	value	This will be copied to the value of the entry.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Iterator to the entry for the given key or OutOfMemoryError if the allocation failed.

◆  Insert() [2/4]

Finds the entry with the given key, or creates such an entry if it doesn't exist yet, and returns an iterator pointing to the entry. The value of the entry will be set to value in any case.

参数

[in]	key	Key of the entry to find or create. If a new entry is created, its key will be constructed by move-semantics if possible.
[in]	value	This will be copied to the value of the entry.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Iterator to the entry for the given key or OutOfMemoryError if the allocation failed.

◆  Insert() [3/4]

Finds the entry with the given key, or creates such an entry if it doesn't exist yet, and returns an iterator pointing to the entry. The value of the entry will be set to value in any case.

参数

[in]	key	Key of the entry to find or create.
[in]	value	This will be moved to the value of the entry.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Iterator to the entry for the given key or OutOfMemoryError if the allocation failed.

◆  Insert() [4/4]

Finds the entry with the given key, or creates such an entry if it doesn't exist yet, and returns an iterator pointing to the entry. The value of the entry will be set to value in any case.

参数

[in]	key	Key of the entry to find or create. If a new entry is created, its key will be constructed by move-semantics if possible.
[in]	value	This will be moved to the value of the entry.
[out]	created	This will be set to true if a new entry has been created successfully, otherwise it will be set to false.

返回

Iterator to the entry for the given key or OutOfMemoryError if the allocation failed.

◆  FindValue() [1/2]

Finds the value associated with the given key in this map.

参数

[in]

key

Key to search for.

返回

Pointer to value for the given key, or nullptr if no entry exists for the key.

◆  FindValue() [2/2]

Finds the value associated with the given key in this map.

参数

[in]

key

Key to search for.

返回

Pointer to value for the given key, or nullptr if no entry exists for the key.

◆  Find() [1/2]

Finds the entry for the given key in this map.

参数

[in]

key

Key to search for.

返回

Iterator pointing to the entry with the given key , or an invalid iterator if this doesn't exist.

◆  Find() [2/2]

Finds the entry for the given key in this map.

参数

[in]

key

Key to search for.

返回

Iterator pointing to the entry with the given key , or an invalid iterator if this doesn't exist.

◆  FindFloor() [1/2]

Finds the entry with the greatest key less than or equal to the given key . If no such entry exists, the returned iterator will be invalid (its operator Bool will return false). This function is only supported if both underlying implementations support it.

参数

[in]

key

Key to search for.

返回

Iterator pointing to the entry with greatest key less than or equal to the given key , or an invalid iterator if this doesn't exist.

◆  FindFloor() [2/2]

Finds the entry with the greatest key less than or equal to the given key . If no such entry exists, the returned iterator will be invalid (its operator Bool will return false). This function is only supported if both underlying implementations support it.

参数

[in]

key

Key to search for.

返回

Iterator pointing to the entry with greatest key less than or equal to the given key , or an invalid iterator if this doesn't exist.

◆  Erase() [1/2]

Removes an entry with the given key from this map (if possible).

参数

[in]

key

Key of the map entry to be be removed.

返回

True if an entry was found and removed for #key, otherwise false or an error if a memory allocation failed.

◆  Erase() [2/2]

Removes the element at position from this map. The returned iterator will point to the element behind the last removed element.

参数

[in]

position

Iterator pointing to the element to be removed.

返回

Iterator pointing to the element behind the removed element.

◆  UseLargeMap()

Switches to the LARGE implementation.

返回

False if some memory allocation failed. In this case the map content may be invalid.

◆  UseSmallMap()

Switches to the SMALL implementation.

返回

False if some memory allocation failed. In this case the map content may be invalid.

◆  GetSmall() [1/2]

◆  GetLarge() [1/2]

◆  GetSmall() [2/2]

◆  GetLarge() [2/2]

◆  MAXON_DISALLOW_COPY_AND_ASSIGN()

Member Data Documentation

◆  _small

◆  _union

• maxon
• HybridMap