G3D::Set< T, HashFunc, EqualsFunc > Class Template Reference

#include <Set.h>

Classes
class	Iterator

Public Member Functions
void	clearAndSetMemoryManager (const MemoryManager::Ref &m)
virtual	~Set ()
int	size () const
bool	contains (const T &member) const
bool	insert (const T &member)
bool	remove (const T &member)
bool	getRemove (const T &member, T &removed)
const T *	getPointer (const T &member) const
Array< T >	getMembers () const
void	getMembers (Array< T > &keyArray) const
void	clear ()
void	deleteAll ()
Iterator	begin () const
const Iterator	end () const

Private Attributes
Table< T, bool, HashFunc, EqualsFunc >	memberTable

Detailed Description

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>
class G3D::Set< T, HashFunc, EqualsFunc >

An unordered data structure that has at most one of each element. Provides O(1) time insert, remove, and member test (contains).

Set uses G3D::Table internally, which means that the template type T must define a hashCode and operator== function. See G3D::Table for a discussion of these functions.

Constructor & Destructor Documentation

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

virtual G3D::Set< T, HashFunc, EqualsFunc >::~Set ( )

inlinevirtual

{}

Here is the caller graph for this function:

Member Function Documentation

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

Iterator G3D::Set< T, HashFunc, EqualsFunc >::begin ( ) const

inline

C++ STL style iterator method. Returns the first member. Use preincrement (++entry) to get to the next element. Do not modify the set while iterating.

 {
 return Iterator(memberTable.begin());
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

void G3D::Set< T, HashFunc, EqualsFunc >::clear ( )

inline

 {
 memberTable.clear();
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

void G3D::Set< T, HashFunc, EqualsFunc >::clearAndSetMemoryManager ( const MemoryManager::Ref &  m )

inline

 {
 memberTable.clearAndSetMemoryManager(m);
 }

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

bool G3D::Set< T, HashFunc, EqualsFunc >::contains ( const T &  member ) const

inline

 {
 return memberTable.containsKey(member);
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

void G3D::Set< T, HashFunc, EqualsFunc >::deleteAll ( )

inline

 {
 getMembers().deleteAll();
 clear();
 }

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

const Iterator G3D::Set< T, HashFunc, EqualsFunc >::end ( ) const

inline

C++ STL style iterator method. Returns one after the last iterator element.

 {
 return Iterator(memberTable.end());
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

Array<T> G3D::Set< T, HashFunc, EqualsFunc >::getMembers ( ) const

inline

 {
 return memberTable.getKeys();
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

void G3D::Set< T, HashFunc, EqualsFunc >::getMembers ( Array< T > &  keyArray ) const

inline

 {
 memberTable.getKeys(keyArray);
 }

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

const T* G3D::Set< T, HashFunc, EqualsFunc >::getPointer ( const T &  member ) const

inline

If a value that is EqualsFunc to member is present, returns a pointer to the version stored in the data structure, otherwise returns NULL.

 {
 return memberTable.getKeyPointer(member);
 }

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

bool G3D::Set< T, HashFunc, EqualsFunc >::getRemove ( const T &  member, T &  removed  )

inline

If member is present, sets removed to the element being removed and returns true. Otherwise returns false and does not write to removed. This is useful when building efficient hashed data structures that wrap Set.

 {
 bool ignore;
 return memberTable.getRemove(member, removed, ignore);
 }

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

bool G3D::Set< T, HashFunc, EqualsFunc >::insert ( const T &  member )

inline

Inserts into the table if not already present. Returns true if this is the first time the element was added.

 {
 bool isNew = false;
 memberTable.getCreate(member, isNew) = true;
 return isNew;
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

bool G3D::Set< T, HashFunc, EqualsFunc >::remove ( const T &  member )

inline

Returns true if the element was present and removed. Returns false if the element was not present.

 {
 return memberTable.remove(member); 
 }

Here is the caller graph for this function:

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

int G3D::Set< T, HashFunc, EqualsFunc >::size ( ) const

inline

 {
 return (int)memberTable.size();
 }

Here is the caller graph for this function:

Member Data Documentation

template<class T, class HashFunc = HashTrait<T>, class EqualsFunc = EqualsTrait<T>>

Table<T, bool, HashFunc, EqualsFunc> G3D::Set< T, HashFunc, EqualsFunc >::memberTable

private

If an object is a member, it is contained in this table.

---

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

• dep/g3dlite/include/G3D/Set.h