G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator Class Reference

#include <Table.h>

Public Member Functions
bool	operator!= (const Iterator &other) const
bool	operator== (const Iterator &other) const
Iterator &	operator++ ()
Iterator	operator++ (int)
const Entry &	operator* () const
const Value &	value () const
const Key &	key () const
Entry *	operator-> () const
	operator Entry * () const
bool	isValid () const
bool	hasMore () const

Private Member Functions
	Iterator ()
	Iterator (size_t numBuckets, Node **m_bucket)
void	findNext ()

Private Attributes
size_t	index
Node *	node
size_t	m_numBuckets
Node **	m_bucket
bool	isDone

Friends
class	Table< Key, Value, HashFunc, EqualsFunc >

Detailed Description

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>
class G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator

C++ STL style iterator variable. See begin().

Constructor & Destructor Documentation

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::Iterator ( )

inlineprivate

Creates the end iterator.

 : index(0), node(NULL), m_bucket(NULL) {
 isDone = true;
 }

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::Iterator ( size_t  numBuckets, Node **  m_bucket  )

inlineprivate

 :
 index(0), 
 node(NULL),
 m_numBuckets(numBuckets),
 m_bucket(m_bucket) {
 
 if (m_numBuckets == 0) {
 // Empty table
 isDone = true;
 return;
 }

# ifdef G3D_DEBUG
 for (unsigned int i = 0; i < m_numBuckets; ++i) {
 debugAssert((m_bucket[i] == NULL) || isValidHeapPointer(m_bucket[i]));
 }
# endif

 index = 0;
 node = m_bucket[index];
 debugAssert((node == NULL) || isValidHeapPointer(node));
 isDone = false;
 findNext();
 debugAssert((node == NULL) || isValidHeapPointer(node));
 }

Here is the call graph for this function:

Member Function Documentation

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

void G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::findNext ( )

inlineprivate

If node is NULL, then finds the next element by searching through the bucket array. Sets isDone if no more nodes are available.

 {
 while (node == NULL) {
 ++index;
 if (index >= m_numBuckets) {
 m_bucket = NULL;
 index = 0;
 isDone = true;
 return;
 } else {
 node = m_bucket[index];
 debugAssert((node == NULL) || isValidHeapPointer(node));
 }
 }
 debugAssert(isValidHeapPointer(node));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

bool G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::hasMore ( ) const

inline

Deprecated:

Use isValid

 {
 return ! isDone;
 }

Here is the caller graph for this function:

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

bool G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::isValid ( ) const

inline

 {
 return ! isDone;
 }

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

const Key& G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::key ( ) const

inline

 {
 return node->entry.key;
 }

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator Entry * ( ) const

inline

 {
 debugAssert(isValidHeapPointer(node));
 return &(node->entry);
 }

Here is the call graph for this function:

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

bool G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator!= ( const Iterator &  other ) const

inline

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

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

const Entry& G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator* ( ) const

inline

 {
 return node->entry;
 }

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

Iterator& G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator++ ( )

inline

Pre increment.

 {
 debugAssert(! isDone);
 debugAssert(node != NULL);
 debugAssert(isValidHeapPointer(node));
 debugAssert((node->next == NULL) || isValidHeapPointer(node->next));
 node = node->next;
 findNext();
 debugAssert(isDone || isValidHeapPointer(node));
 return *this;
 }

Here is the call graph for this function:

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

Iterator G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator++ ( int  )

inline

Post increment (slower than preincrement).

 {
 Iterator old = *this;
 ++(*this);
 return old;
 }

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

Entry* G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator-> ( ) const

inline

 {
 debugAssert(isValidHeapPointer(node));
 return &(node->entry);
 }

Here is the call graph for this function:

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

bool G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::operator== ( const Iterator &  other ) const

inline

 {
 if (other.isDone || isDone) {
 // Common case; check against isDone.
 return (isDone == other.isDone);
 } else {
 return (node == other.node) && (index == other.index);
 }
 }

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

const Value& G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::value ( ) const

inline

 {
 return node->entry.value;
 }

Friends And Related Function Documentation

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

friend class Table< Key, Value, HashFunc, EqualsFunc >

friend

Member Data Documentation

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

size_t G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::index

private

Bucket index.

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

bool G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::isDone

private

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

Node** G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::m_bucket

private

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

size_t G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::m_numBuckets

private

template<class Key, class Value, class HashFunc = HashTrait<Key>, class EqualsFunc = EqualsTrait<Key>>

Node* G3D::Table< Key, Value, HashFunc, EqualsFunc >::Iterator::node

private

Linked list node.

---

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

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