FbxSet< Type, Compare, Allocator > Class Template Reference

#include <fbxset.h>

Class Description

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

This class implements an efficient set based on value comparison, which stores values.

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

Definition at line 25 of file fbxset.h.

Classes
class	Value
	This class defines the value type used by the set. More...

Public Types
typedef Type	ValueType
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 values it holds. More...
FbxPair< RecordType *, bool >	Insert (const ValueType &pValue)
	Insert a value. More...
int	Remove (const ValueType &pValue)
	Delete a value. More...
void	Clear ()
	Clear the set. More...
bool	Empty () const
	Query whether the set is empty. More...
Iterator	Begin ()
	Retrieve the begin iterator of the set. More...
Iterator	End ()
	Retrieve the end iterator of the set. More...
ConstIterator	Begin () const
	Retrieve the begin iterator of the set. More...
ConstIterator	End () const
	Retrieve the end iterator of the set. More...
const RecordType *	Find (const ValueType &pValue) const
	Find a given value in the set. More...
RecordType *	Find (const ValueType &pValue)
	Find a given value in the set. More...
const RecordType *	Minimum () const
	Retrieve the minimum value in the set. More...
RecordType *	Minimum ()
	Retrieve the minimum value in the set. More...
const RecordType *	Maximum () const
	Retrieve the maximum value in the set. More...
RecordType *	Maximum ()
	Retrieve the maximum value in the set. More...
bool	operator== (const FbxSet< Type, Compare, Allocator > &pOther) const
	Equality operator. More...
bool	operator!= (const FbxSet< Type, Compare, Allocator > &pOther) const
	Inequality operator. More...
FbxSet	Intersect (const FbxSet &pOther) const
	Intersect with another set. More...
FbxSet	Union (const FbxSet &pOther) const
	Unite with another set. More...

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

Member Typedef Documentation

StorageType

typedef FbxRedBlackTree<Value, Compare, Allocator> StorageType

protected

Declaration of the storage type used by the set.

Definition at line 56 of file fbxset.h.

ValueType

typedef Type ValueType

Definition at line 59 of file fbxset.h.

RecordType

typedef StorageType::RecordType RecordType

Definition at line 60 of file fbxset.h.

Iterator

typedef StorageType::IteratorType Iterator

Definition at line 61 of file fbxset.h.

ConstIterator

typedef StorageType::ConstIteratorType ConstIterator

Definition at line 62 of file fbxset.h.

Member Function Documentation

Reserve()

void Reserve ( unsigned int  pRecordCount )

inline

Preallocate memory.

Parameters

pRecordCount

The number of elements.

Definition at line 67 of file fbxset.h.

    {
        mTree.Reserve(pRecordCount);
    }

GetSize()

int GetSize ( ) const

inline

Retrieve the number of values it holds.

Definition at line 73 of file fbxset.h.

    {
        return mTree.GetSize();
    }

Insert()

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

inline

Insert a value.

Parameters

pValue

The value.

Returns

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

Definition at line 81 of file fbxset.h.

    {
        return mTree.Insert(Value(pValue));
    }

Remove()

int Remove ( const ValueType &  pValue )

inline

Delete a value.

Parameters

pValue

The value.

Returns

true if success, false if value is not found.

Definition at line 89 of file fbxset.h.

    {
        return mTree.Remove(pValue);
    }

Clear()

void Clear ( )

inline

Clear the set.

Definition at line 95 of file fbxset.h.

    {
        mTree.Clear();
    }

Empty()

bool Empty ( ) const

inline

Query whether the set is empty.

Definition at line 101 of file fbxset.h.

    {
        return mTree.Empty();
    }

Begin() [1/2]

Iterator Begin ( )

inline

Retrieve the begin iterator of the set.

Definition at line 107 of file fbxset.h.

    {
        return Iterator(Minimum());
    }

End() [1/2]

Iterator End ( )

inline

Retrieve the end iterator of the set.

Definition at line 113 of file fbxset.h.

    {
        return Iterator();
    }

Begin() [2/2]

ConstIterator Begin ( ) const

inline

Retrieve the begin iterator of the set.

Definition at line 119 of file fbxset.h.

    {
        return ConstIterator(Minimum());
    }

End() [2/2]

ConstIterator End ( ) const

inline

Retrieve the end iterator of the set.

Definition at line 125 of file fbxset.h.

    {
        return ConstIterator();
    }

Find() [1/2]

const RecordType* Find ( const ValueType &  pValue ) const

inline

Find a given value in the set.

Parameters

pValue

The value to find.

Returns

The value in the set, or NULL if the value is not found in the set.

Definition at line 133 of file fbxset.h.

    {
        return mTree.Find(pValue);
    }

Find() [2/2]

RecordType* Find ( const ValueType &  pValue )

inline

Find a given value in the set.

Parameters

pValue

The value to find.

Returns

The value in the set, or NULL if the value is not found in the set.

Definition at line 141 of file fbxset.h.

    {
        return mTree.Find(pValue);
    }

Minimum() [1/2]

const RecordType* Minimum ( ) const

inline

Retrieve the minimum value in the set.

Definition at line 147 of file fbxset.h.

    {
        return mTree.Minimum();
    }

Minimum() [2/2]

RecordType* Minimum ( )

inline

Retrieve the minimum value in the set.

Definition at line 153 of file fbxset.h.

    {
        return mTree.Minimum();
    }

Maximum() [1/2]

const RecordType* Maximum ( ) const

inline

Retrieve the maximum value in the set.

Definition at line 159 of file fbxset.h.

    {
        return mTree.Maximum();
    }

Maximum() [2/2]

RecordType* Maximum ( )

inline

Retrieve the maximum value in the set.

Definition at line 165 of file fbxset.h.

    {
        return mTree.Maximum();
    }

operator==()

bool operator== ( const FbxSet< Type, Compare, Allocator > &  pOther ) const

inline

Equality operator.

Definition at line 171 of file fbxset.h.

    {
        return (this == &pOther) || (mTree == pOther.mTree);
    }

operator!=()

bool operator!= ( const FbxSet< Type, Compare, Allocator > &  pOther ) const

inline

Inequality operator.

Definition at line 177 of file fbxset.h.

    {
        return !(*this == pOther);
    }

Intersect()

FbxSet Intersect ( const FbxSet< Type, Compare, Allocator > &  pOther ) const

inline

Intersect with another set.

Parameters

pOther

The other set.

Returns

The intersection set of the two sets.

Definition at line 185 of file fbxset.h.

    {
        FbxSet lReturn;
        ConstIterator lBegin = Begin();
        for (; lBegin != End(); ++lBegin)
        {
            if (pOther.Find(lBegin->GetValue()) != NULL)
                lReturn.Insert(lBegin->GetValue());
        }
        return lReturn;
    }

Union()

FbxSet Union ( const FbxSet< Type, Compare, Allocator > &  pOther ) const

inline

Unite with another set.

Parameters

pOther

The other set.

Returns

The union set of the two sets (no duplicated items).

Definition at line 200 of file fbxset.h.

    {
        FbxSet lReturn(*this);
        ConstIterator lBegin = pOther.Begin();
        for (; lBegin != End(); ++lBegin)
        {
            if (Find(lBegin->GetValue()) == NULL)
                lReturn.Insert(lBegin->GetValue());
        }
        return lReturn;
    }

---

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

• fbxsdk/core/base/fbxset.h