Lattice Tester Guide  1.0-9
Software Package For Testing The Uniformity Of Integral Lattices In The Real Space
LatticeTester::CoordinateSets::FromRanges::const_iterator Class Reference

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

#include <latticetester/CoordinateSets.h>

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

Public Member Functions

 const_iterator (const FromRanges &seq)
 Constructor for an iterator at the begining of the list of sets that seq contains. More...
 
 const_iterator (const FromRanges &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 ()
 Empty FromRange::const_iterator constructor. More...
 
const_iteratoroperator= (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 FromRange 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 FromRange object and if they are at the same point in their enumeration cycle. More...
 
const Coordinatesoperator * () const
 Dereference operator, when dereferencing this object, you get the set of coordinates this iterator points to. More...
 
const_iteratoroperator++ ()
 Prefix incrementation operator. More...
 
const_iterator operator++ (int)
 Postfix incrementation operator. More...
 

Detailed Description

An iterator class used internaly by the FromRange 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::FromRanges::const_iterator::const_iterator ( const FromRanges seq)
inlineexplicit

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

◆ const_iterator() [2/4]

LatticeTester::CoordinateSets::FromRanges::const_iterator::const_iterator ( const FromRanges 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::FromRanges::const_iterator::const_iterator ( const const_iterator other)
inline

Copy constructor.

◆ const_iterator() [4/4]

LatticeTester::CoordinateSets::FromRanges::const_iterator::const_iterator ( )
inline

Empty FromRange::const_iterator constructor.

Member Function Documentation

◆ operator *()

const Coordinates& LatticeTester::CoordinateSets::FromRanges::const_iterator::operator * ( ) const
inline

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

◆ operator!=()

bool LatticeTester::CoordinateSets::FromRanges::const_iterator::operator!= ( const const_iterator other)
inline

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

◆ operator++() [1/2]

FromRanges::const_iterator & LatticeTester::CoordinateSets::FromRanges::const_iterator::operator++ ( )

Prefix incrementation operator.

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

◆ operator++() [2/2]

FromRanges::const_iterator LatticeTester::CoordinateSets::FromRanges::const_iterator::operator++ ( int  )

Postfix incrementation operator.

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

◆ operator=()

const_iterator& LatticeTester::CoordinateSets::FromRanges::const_iterator::operator= ( const const_iterator other)
inline

Assignment operator.

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

◆ operator==()

bool LatticeTester::CoordinateSets::FromRanges::const_iterator::operator== ( const const_iterator other)
inline

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


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