LatticeTester::CoordinateSets::Subsets::const_iterator Class Reference

An iterator class used internally by the Subsets class. More...

#include <latticetester/CoordinateSets.h>

Inheritance diagram for LatticeTester::CoordinateSets::Subsets::const_iterator:

Classes
struct	end_tag

Public Member Functions
	const_iterator (const Subsets &seq)
	Constructor for an iterator at the beginning of the list of sets that seq contains.
	const_iterator (const Subsets &seq, end_tag)
	Constructor for an iterator at the end of the list of sets that seq contains.
	const_iterator (const const_iterator &other)
	Copy constructor.
	const_iterator ()
	Default constructor.
const_iterator &	operator= (const const_iterator &other)
	Assignment operator that does the same as the copy constructor.
bool	operator== (const const_iterator &other)
	Compares this instance with other, returning true if they are associated with the same Subsets object and if they are at the same point in their enumeration cycle.
bool	operator!= (const const_iterator &other)
	Compares this instance with other, returning false if they are associated with the same Subsets object and if they are at the same point in their enumeration cycle.
const Coordinates &	operator* () const
	Dereference operator, when dereferencing this object, you get the set of coordinates this iterator points to.
const_iterator &	operator++ ()
	Prefix incrementation operator.
const_iterator	operator++ (int)
	Postfix incrementation operator.

Detailed Description

An iterator class used internally by the Subsets class.

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

Constructor & Destructor Documentation

const_iterator() [1/4]

LatticeTester::CoordinateSets::Subsets::const_iterator::const_iterator ( const Subsets & seq )

inlineexplicit

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

const_iterator() [2/4]

LatticeTester::CoordinateSets::Subsets::const_iterator::const_iterator ( const Subsets & seq, end_tag  )

inline

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

const_iterator() [3/4]

LatticeTester::CoordinateSets::Subsets::const_iterator::const_iterator ( const const_iterator & other )

inline

Copy constructor.

const_iterator() [4/4]

LatticeTester::CoordinateSets::Subsets::const_iterator::const_iterator ( )

inline

Default constructor.

Member Function Documentation

operator!=()

bool LatticeTester::CoordinateSets::Subsets::const_iterator::operator!= ( const const_iterator & other )

inline

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

operator*()

const Coordinates & LatticeTester::CoordinateSets::Subsets::const_iterator::operator* ( ) const

inline

Dereference operator, when dereferencing this object, you get the set of coordinates this iterator points to.

operator++() [1/2]

Subsets::const_iterator & LatticeTester::CoordinateSets::Subsets::const_iterator::operator++

(

)

Prefix incrementation operator.

Increments this iterator and returns the iterator in its new state.

operator++() [2/2]

Subsets::const_iterator LatticeTester::CoordinateSets::Subsets::const_iterator::operator++

(

int

)

Postfix incrementation operator.

Increments this iterator and returns a copy of the old object.

operator=()

const_iterator & LatticeTester::CoordinateSets::Subsets::const_iterator::operator= ( const const_iterator & other )

inline

Assignment operator that does the same as the copy constructor.

operator==()

bool LatticeTester::CoordinateSets::Subsets::const_iterator::operator== ( const const_iterator & other )

inline

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

---

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

• include/latticetester/CoordinateSets.h
• src/CoordinateSets.cc