LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator Class Reference

An iterator class used internaly by the AddCoordinate class. More...

#include <latticetester/CoordinateSets.h>

Inherits iterator< std::forward_iterator_tag, const Coordinates >.

Public Member Functions
	const_iterator (const AddCoordinate &seq)
	Constructor for an iterator at the beginning of the list of sets that seq contains. More...
	const_iterator (const AddCoordinate &seq, end_tag)
	Constructor for an iterator at the end of the list of sets that seq contains. More...
	const_iterator (const const_iterator &other)
	Copy constructor. More...
	const_iterator ()
	Default constructor. More...
const_iterator &	operator= (const const_iterator &other)
	Assignment operator. More...
bool	operator== (const const_iterator &other)
	Compares this instance with other, returning true if they are associated with the same AddCoordinate object and if they are at the same point in their enumeration cycle. More...
bool	operator!= (const const_iterator &other)
	Compares this instance with other, returning false if they are associated with the same AddCoordinate object and if they are at the same point in their enumeration cycle. More...
const_iterator &	operator++ ()
	Prefix increment operator. More...
const_iterator	operator++ (int)
	Postfix increment operator. More...
const Coordinates &	operator * () const
	Dereference operator that returns the Coordinates this iterator is at. More...

Detailed Description

template<typename BASE>
class LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator

An iterator class used internaly by the AddCoordinate class.

Given an object of this class, it is possible to cycle through the element it contains with the increment (++) operator.

Since this iterator is built upon another object, it internally keeps an iterator that cycles through the sets generated by the CoordinateSets implementation the associated to the AddCoordinate object used for construction.

Constructor & Destructor Documentation

const_iterator() [1/4]

template<typename BASE >

LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::const_iterator ( const AddCoordinate &  seq )

inlineexplicit

Constructor for an iterator at the beginning of the list of sets that seq contains.

const_iterator() [2/4]

template<typename BASE >

LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::const_iterator ( const AddCoordinate &  seq, end_tag    )

inline

Constructor for an iterator at the end of the list of sets that seq contains.

const_iterator() [3/4]

template<typename BASE >

LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::const_iterator ( const const_iterator &  other )

inline

Copy constructor.

const_iterator() [4/4]

template<typename BASE >

LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::const_iterator ( )

inline

Default constructor.

Does nothing.

Member Function Documentation

operator *()

template<typename BASE >

const Coordinates& LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::operator * ( ) const

inline

Dereference operator that returns the Coordinates this iterator is at.

operator!=()

template<typename BASE >

bool LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::operator!= ( const const_iterator &  other )

inline

Compares this instance with other, returning false if they are associated with the same AddCoordinate object and if they are at the same point in their enumeration cycle.

operator++() [1/2]

template<typename BASE >

const_iterator& LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::operator++ ( )

inline

Prefix increment operator.

This increments the underlying subset and updates m_value.

operator++() [2/2]

template<typename BASE >

const_iterator LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::operator++ ( int  )

inline

Postfix increment operator.

This increments the underlying subset and updates m_value.

operator=()

template<typename BASE >

const_iterator& LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::operator= ( const const_iterator &  other )

inline

Assignment operator.

This copies the left hand side object in the right hand side object.

operator==()

template<typename BASE >

bool LatticeTester::CoordinateSets::AddCoordinate< BASE >::const_iterator::operator== ( const const_iterator &  other )

inline

Compares this instance with other, returning true if they are associated with the same AddCoordinate object and if they are at the same point in their enumeration cycle.

---

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

• include/latticetester/CoordinateSets.h