G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator Class Reference

#include <PointHashGrid.h>

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

Private Member Functions
	Iterator ()
	Iterator (const ThisType *grid)
const Value &	value () const

Private Attributes
bool	m_isEnd
const ThisType *	m_grid
CellTable::Iterator	m_tableIterator
int	m_arrayIndex
const int	m_epoch

Friends
class	ThisType

Constructor & Destructor Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::Iterator ( )

inlineprivate

End iterator. Note that the m_tableIterator is initialized to the end iterator of a temporary value! This is ok because we'll never look at the value of the m_tableIterator, since we're initializing the "end" Iterator.

 : m_isEnd(true), m_grid(NULL), m_tableIterator(CellTable().end()), 
 m_arrayIndex(0), m_epoch(0) {}

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::Iterator ( const ThisType *  grid )

inlineprivate

 : 
 m_isEnd(grid->size() == 0),
 m_grid(grid),
 m_tableIterator( grid->m_data.begin() ),
 m_arrayIndex(0),
 m_epoch(grid->m_epoch) { }

Member Function Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::hasMore ( ) const

inline

Deprecated:

Use isValid

 {
 return ! m_isEnd;
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::isValid ( ) const

inline

 {
 return ! m_isEnd;
 }

Here is the caller graph for this function:

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator Value * ( ) const

inline

{ return &value(); }

Here is the call graph for this function:

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator!= ( const Iterator &  other ) const

inline

 {
 if (other.m_isEnd && m_isEnd) {
 return false;
 } else {
 return (m_isEnd != other.m_isEnd) ||
 (m_tableIterator != other.m_tableIterator) || 
 (m_arrayIndex != other.m_arrayIndex);
 }
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const Value& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator* ( ) const

inline

{ return value(); }

Here is the call graph for this function:

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

Iterator& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator++ ( )

inline

Preincrement

 {
 debugAssert(! m_isEnd);
 debugAssertM(m_epoch == m_grid->m_epoch, 
 "It is illegal to mutate the HashGrid "
 "while iterating through it.");

 ++m_arrayIndex;

 if (m_arrayIndex >= m_tableIterator->value.size()) {
 // Move on to the next cell
 ++m_tableIterator;
 m_arrayIndex = 0;

 // Check to see if we're at the end
 m_isEnd = (m_tableIterator == m_grid->m_data.end());
 }

 return *this;
 }

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

Iterator G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator++ ( int  )

inline

Post increment (slower)

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

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const Value* G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator-> ( ) const

inline

{ return &value(); }

Here is the call graph for this function:

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::operator== ( const Iterator &  other ) const

inline

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

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const Value& G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::value ( ) const

inlineprivate

 {
 debugAssert(! m_isEnd);
 debugAssertM(m_tableIterator->value.size() > m_arrayIndex, 
 "No more elements");
 return m_tableIterator->value[m_arrayIndex].value;
 }

Here is the caller graph for this function:

Friends And Related Function Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

friend class ThisType

friend

Member Data Documentation

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

int G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::m_arrayIndex

private

Index within m_tableIterator->value of the current value.

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const int G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::m_epoch

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

const ThisType* G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::m_grid

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

bool G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::m_isEnd

private

template<class Value, class PosFunc = PositionTrait<Value>, class EqualsFunc = EqualsTrait<Value>>

CellTable::Iterator G3D::PointHashGrid< Value, PosFunc, EqualsFunc >::Iterator::m_tableIterator

private

---

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

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