ThunderEgg::Orthant< D >::Range::Iterator Class Reference

Input iterator for Orthant values. More...

#include <Orthant.h>

Inheritance diagram for ThunderEgg::Orthant< D >::Range::Iterator:

Collaboration diagram for ThunderEgg::Orthant< D >::Range::Iterator:

Public Member Functions
	Iterator (Orthant< D > o_in)
	Construct a new Iterator object with the given Orthant value. More...
const Orthant< D > &	operator++ ()
	Increment the Orthant value. More...
const Orthant< D > &	operator* () const
	Get a reference to the Orthant object. More...
const Orthant< D > *	operator-> () const
	Get a pointer to the Orthant object. More...
bool	operator== (const Iterator &b) const
	Check the iterators reference the same value. More...
bool	operator!= (const Iterator &b) const
	Check the iterators don't reference the same value. More...

Detailed Description

template<int D>
class ThunderEgg::Orthant< D >::Range::Iterator

Input iterator for Orthant values.

Constructor & Destructor Documentation

Iterator()

template<int D>

ThunderEgg::Orthant< D >::Range::Iterator::Iterator ( Orthant< D >  o_in )

inlineexplicit

Construct a new Iterator object with the given Orthant value.

Parameters

o_in	the orthant

Member Function Documentation

operator!=()

template<int D>

bool ThunderEgg::Orthant< D >::Range::Iterator::operator!= ( const Iterator &  b ) const

inline

Check the iterators don't reference the same value.

Parameters

b	the other iterator

Returns

true if different

false if the same

operator*()

template<int D>

const Orthant<D>& ThunderEgg::Orthant< D >::Range::Iterator::operator* ( ) const

inline

Get a reference to the Orthant object.

Returns

const Orthant<D>& the reference

operator++()

template<int D>

const Orthant<D>& ThunderEgg::Orthant< D >::Range::Iterator::operator++ ( )

inline

Increment the Orthant value.

Returns

const Orthant<D>& the resulting value

operator->()

template<int D>

const Orthant<D>* ThunderEgg::Orthant< D >::Range::Iterator::operator-> ( ) const

inline

Get a pointer to the Orthant object.

Returns

const Orthant<D>* the pointer

operator==()

template<int D>

bool ThunderEgg::Orthant< D >::Range::Iterator::operator== ( const Iterator &  b ) const

inline

Check the iterators reference the same value.

Parameters

b	the other iterator

Returns

true if the same

false if different

---

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

• src/ThunderEgg/Orthant.h