#include <fbxmap.h>

Class Description

template<typename Key, typename Type, typename Compare = FbxLessCompare<Key>, typename Allocator = FbxBaseAllocator>
class FbxMap< Key, Type, Compare, Allocator >

This class implements an efficient map based on key comparison, which stores key-value pairs.

It executes insertion, deletion and query operations in O(log(n)) time.

Definition at line 68 of file fbxmap.h.

Classes
class	KeyValuePair
	This class defines the key-value pairs used by the map. More...

Public Types
typedef Type	ValueType

typedef Key	KeyType

typedef StorageType::RecordType	RecordType

typedef StorageType::IteratorType	Iterator

typedef StorageType::ConstIteratorType	ConstIterator

Public Member Functions
void	Reserve (unsigned int pRecordCount)
	Preallocate memory. More...

int	GetSize () const
	Retrieve the number of key-value pairs it holds. More...

FbxPair< RecordType *, bool >	Insert (const KeyType &pKey, const ValueType &pValue)
	Insert a key-value pair. More...

bool	Remove (const KeyType &pKey)
	Delete a key-value pair. More...

void	Clear ()
	Clear the map. More...

bool	Empty () const
	Query whether the map is empty. More...

Iterator	Begin ()
	Retrieve the begin iterator of the map. More...

Iterator	End ()
	Retrieve the end iterator of the map. More...

ConstIterator	Begin () const
	Retrieve the begin iterator of the map. More...

ConstIterator	End () const
	Retrieve the end iterator of the map. More...

const RecordType *	Find (const KeyType &pKey) const
	Query a key. More...

RecordType *	Find (const KeyType &pKey)
	Query a key. More...

const RecordType *	UpperBound (const KeyType &pKey) const
	Find the key-value pair with the smallest key greater than a specified key. More...

RecordType *	UpperBound (const KeyType &pKey)
	Find the key-value pair with the smallest key greater than a specified key. More...

ValueType &	operator[] (const KeyType &pKey)
	Retrieve the reference of the value in the key-value pairs in map. More...

const RecordType *	Minimum () const
	Retrieve the key-value pair which is the minimum key in map. More...

RecordType *	Minimum ()
	Retrieve the key-value pair which is the minimum key in map. More...

const RecordType *	Maximum () const
	Retrieve the key-value pair which is the maximum key in map. More...

RecordType *	Maximum ()
	Retrieve the key-value pair which is the maximum key in map. More...

Protected Types
typedef FbxRedBlackTree< KeyValuePair, Compare, Allocator >	StorageType
	Declaration of the storage type used by the map. More...

Member Typedef Documentation

◆ StorageType

typedef FbxRedBlackTree<KeyValuePair, Compare, Allocator> StorageType

protected

Declaration of the storage type used by the map.

Definition at line 93 of file fbxmap.h.

◆ ValueType

typedef Type ValueType

Definition at line 96 of file fbxmap.h.

◆ KeyType

typedef Key KeyType

Definition at line 97 of file fbxmap.h.

◆ RecordType

typedef StorageType::RecordType RecordType

Definition at line 98 of file fbxmap.h.

◆ Iterator

typedef StorageType::IteratorType Iterator

Definition at line 99 of file fbxmap.h.

◆ ConstIterator

typedef StorageType::ConstIteratorType ConstIterator

Definition at line 100 of file fbxmap.h.

Member Function Documentation

◆ Reserve()

void Reserve ( unsigned int pRecordCount )

inline

Preallocate memory.

Parameters

pRecordCount The number of elements.

Definition at line 104 of file fbxmap.h.

     {
         mTree.Reserve(pRecordCount);
     }

◆ GetSize()

int GetSize ( ) const

inline

Retrieve the number of key-value pairs it holds.

Definition at line 110 of file fbxmap.h.

     {
         return mTree.GetSize();
     }

◆ Insert()

FbxPair<RecordType*, bool> Insert	(	const KeyType &	pKey,
		const ValueType &	pValue
	)

inline

Insert a key-value pair.

Parameters

pKey	The key.
pValue	The value.

Returns: If the key is already present in the map, returns the existing pair and false; else returns the pointer to the new key-value and true.

Definition at line 119 of file fbxmap.h.

     {
         return mTree.Insert(KeyValuePair(pKey, pValue));
     }

◆ Remove()

bool Remove ( const KeyType & pKey )

inline

Delete a key-value pair.

Parameters

pKey The key.

Returns: true if success, false if key is not found.

Definition at line 127 of file fbxmap.h.

     {
         return mTree.Remove(pKey);
     }

◆ Clear()

void Clear ( )

inline

Clear the map.

Definition at line 133 of file fbxmap.h.

     {
         mTree.Clear();
     }

◆ Empty()

bool Empty ( ) const

inline

Query whether the map is empty.

Definition at line 139 of file fbxmap.h.

     {
         return mTree.Empty();
     }

◆ Begin() [1/2]

Iterator Begin ( )

inline

Retrieve the begin iterator of the map.

Definition at line 145 of file fbxmap.h.

     {
         return Iterator(Minimum());
     }

◆ End() [1/2]

Iterator End ( )

inline

Retrieve the end iterator of the map.

Definition at line 151 of file fbxmap.h.

     {
         return Iterator();
     }

◆ Begin() [2/2]

ConstIterator Begin ( ) const

inline

Retrieve the begin iterator of the map.

Definition at line 157 of file fbxmap.h.

     {
         return ConstIterator(Minimum());
     }

◆ End() [2/2]

ConstIterator End ( ) const

inline

Retrieve the end iterator of the map.

Definition at line 163 of file fbxmap.h.

     {
         return ConstIterator();
     }

◆ Find() [1/2]

const RecordType* Find ( const KeyType & pKey ) const

inline

Query a key.

Parameters

pKey The key.

Returns: A key-value pair if success, NULL if the key is not found.

Definition at line 171 of file fbxmap.h.

     {
         return mTree.Find(pKey);
     }

◆ Find() [2/2]

RecordType* Find ( const KeyType & pKey )

inline

Query a key.

Parameters

pKey The key.

Returns: A key-value pair if success, NULL if it's not found.

Definition at line 179 of file fbxmap.h.

     {
         return mTree.Find(pKey);
     }

◆ UpperBound() [1/2]

const RecordType* UpperBound ( const KeyType & pKey ) const

inline

Find the key-value pair with the smallest key greater than a specified key.

Parameters

pKey The key.

Returns: The found key-value pair.

Definition at line 187 of file fbxmap.h.

     {
         return mTree.UpperBound(pKey);
     }

◆ UpperBound() [2/2]

RecordType* UpperBound ( const KeyType & pKey )

inline

Find the key-value pair with the smallest key greater than a specified key.

Parameters

pKey The key.

Returns: The found key-value pair.

Definition at line 195 of file fbxmap.h.

     {
         return mTree.UpperBound(pKey);
     }

◆ operator[]()

ValueType& operator[] ( const KeyType & pKey )

inline

Retrieve the reference of the value in the key-value pairs in map.

Parameters

pKey The key.

Returns: The reference of the value.

Remarks: If the key is not found, a new key-value pair will be inserted.

Definition at line 204 of file fbxmap.h.

     {
         RecordType* lRecord = Find(pKey);
 
         if( !lRecord )
         {
             lRecord = Insert(pKey, ValueType()).mFirst;
         }
 
         return lRecord->GetValue();
     }

◆ Minimum() [1/2]

const RecordType* Minimum ( ) const

inline

Retrieve the key-value pair which is the minimum key in map.

Definition at line 217 of file fbxmap.h.

     {
         return mTree.Minimum();
     }

◆ Minimum() [2/2]

RecordType* Minimum ( )

inline

Retrieve the key-value pair which is the minimum key in map.

Definition at line 223 of file fbxmap.h.

     {
         return mTree.Minimum();
     }

◆ Maximum() [1/2]

const RecordType* Maximum ( ) const

inline

Retrieve the key-value pair which is the maximum key in map.

Definition at line 229 of file fbxmap.h.

     {
         return mTree.Maximum();
     }

◆ Maximum() [2/2]

RecordType* Maximum ( )

inline

Retrieve the key-value pair which is the maximum key in map.

Definition at line 235 of file fbxmap.h.

     {
         return mTree.Maximum();
     }

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

fbxsdk/core/base/fbxmap.h

Class Description

template<typename Key, typename Type, typename Compare = FbxLessCompare<Key>, typename Allocator = FbxBaseAllocator> class FbxMap< Key, Type, Compare, Allocator >

Classes

Public Types

Public Member Functions

Protected Types

Member Typedef Documentation

◆ StorageType

◆ ValueType

◆ KeyType

◆ RecordType

◆ Iterator

◆ ConstIterator

Member Function Documentation

◆ Reserve()

◆ GetSize()

◆ Insert()

◆ Remove()

◆ Clear()

◆ Empty()

◆ Begin() [1/2]

◆ End() [1/2]

◆ Begin() [2/2]

◆ End() [2/2]

◆ Find() [1/2]

◆ Find() [2/2]

◆ UpperBound() [1/2]

◆ UpperBound() [2/2]

◆ operator[]()

◆ Minimum() [1/2]

◆ Minimum() [2/2]

◆ Maximum() [1/2]

◆ Maximum() [2/2]

template<typename Key, typename Type, typename Compare = FbxLessCompare<Key>, typename Allocator = FbxBaseAllocator>
class FbxMap< Key, Type, Compare, Allocator >