DGtal::IntegerSequenceIterator< TInteger > Class Template Reference

Aim: It is a simple class that mimics a (non mutable) iterator over integers. You can increment it, decrement it, displace it, compare it, etc. It is useful if you have a collection of consecutive integers, and you wish to create an iterator over it. It is used in the class TriangulatedSurface for example, since vertices are numbers from 0 to nbVertices - 1. More...

#include <DGtal/base/IntegerSequenceIterator.h>

Inheritance diagram for DGtal::IntegerSequenceIterator< TInteger >:

Public Types
typedef IntegerSequenceIterator< TInteger >	Self
typedef TInteger	Integer

Public Member Functions
	IntegerSequenceIterator (Integer n=Integer(0))
	~IntegerSequenceIterator ()=default
	IntegerSequenceIterator (const IntegerSequenceIterator &other)=default
	IntegerSequenceIterator (IntegerSequenceIterator &&other)=default
IntegerSequenceIterator &	operator= (const IntegerSequenceIterator &other)=default
IntegerSequenceIterator &	operator= (IntegerSequenceIterator &&other)=default

Protected Attributes
Integer	myNumber
	The current value of the interator.

Private Member Functions
void	increment ()
	Increments the iterator. Required by boost::iterator_facade.
void	decrement ()
	Decrements the iterator. Required by boost::iterator_facade.
void	advance (std::ptrdiff_t n)
std::ptrdiff_t	distance_to (IntegerSequenceIterator const &other)
bool	equal (IntegerSequenceIterator const &other) const
Integer const &	dereference () const

Friends
class	boost::iterator_core_access

Detailed Description

template<typename TInteger>
class DGtal::IntegerSequenceIterator< TInteger >

Aim: It is a simple class that mimics a (non mutable) iterator over integers. You can increment it, decrement it, displace it, compare it, etc. It is useful if you have a collection of consecutive integers, and you wish to create an iterator over it. It is used in the class TriangulatedSurface for example, since vertices are numbers from 0 to nbVertices - 1.

Description of template class 'IntegerSequenceIterator'

It is model of boost::RandomAccessIterator.

Definition at line 65 of file IntegerSequenceIterator.h.

Member Typedef Documentation

Integer

template<typename TInteger >

typedef TInteger DGtal::IntegerSequenceIterator< TInteger >::Integer

Definition at line 72 of file IntegerSequenceIterator.h.

Self

template<typename TInteger >

typedef IntegerSequenceIterator<TInteger> DGtal::IntegerSequenceIterator< TInteger >::Self

Definition at line 71 of file IntegerSequenceIterator.h.

Constructor & Destructor Documentation

IntegerSequenceIterator() [1/3]

template<typename TInteger >

DGtal::IntegerSequenceIterator< TInteger >::IntegerSequenceIterator ( Integer n = Integer( 0 ) )

inline

Constructor from Integer;

Parameters

n	any integer (default to zero).

Definition at line 81 of file IntegerSequenceIterator.h.

: myNumber( n ) {}

~IntegerSequenceIterator()

template<typename TInteger >

DGtal::IntegerSequenceIterator< TInteger >::~IntegerSequenceIterator ( )

default

Destructor.

IntegerSequenceIterator() [2/3]

template<typename TInteger >

DGtal::IntegerSequenceIterator< TInteger >::IntegerSequenceIterator ( const IntegerSequenceIterator< TInteger > & other )

default

Copy constructor.

Parameters

other

the object to clone.

IntegerSequenceIterator() [3/3]

template<typename TInteger >

DGtal::IntegerSequenceIterator< TInteger >::IntegerSequenceIterator ( IntegerSequenceIterator< TInteger > && other )

default

Move constructor.

Parameters

other

the object to move.

Member Function Documentation

advance()

template<typename TInteger >

void DGtal::IntegerSequenceIterator< TInteger >::advance ( std::ptrdiff_t n )

inlineprivate

Advances the iterator. Required by boost::iterator_facade.

Parameters

n	the number of forward steps performed by the iterator.

Definition at line 124 of file IntegerSequenceIterator.h.

{ myNumber += n; }

References DGtal::IntegerSequenceIterator< TInteger >::myNumber.

decrement()

template<typename TInteger >

void DGtal::IntegerSequenceIterator< TInteger >::decrement ( )

inlineprivate

Decrements the iterator. Required by boost::iterator_facade.

Definition at line 121 of file IntegerSequenceIterator.h.

{ myNumber--; }

References DGtal::IntegerSequenceIterator< TInteger >::myNumber.

dereference()

template<typename TInteger >

Integer const & DGtal::IntegerSequenceIterator< TInteger >::dereference ( ) const

inlineprivate

Returns

the integer value corresponding to the position of this iterator. Required by boost::iterator_facade.

Definition at line 135 of file IntegerSequenceIterator.h.

{ return myNumber; }

References DGtal::IntegerSequenceIterator< TInteger >::myNumber.

distance_to()

template<typename TInteger >

std::ptrdiff_t DGtal::IntegerSequenceIterator< TInteger >::distance_to ( IntegerSequenceIterator< TInteger > const & other )

inlineprivate

Distance to given iterator. Required by boost::iterator_facade.

Parameters

other

any iterator on the same sequence.

Definition at line 127 of file IntegerSequenceIterator.h.

    { return other.myNumber - myNumber; }

References DGtal::IntegerSequenceIterator< TInteger >::myNumber.

equal()

template<typename TInteger >

bool DGtal::IntegerSequenceIterator< TInteger >::equal ( IntegerSequenceIterator< TInteger > const & other ) const

inlineprivate

Equality comparison with another iterator. Required by boost::iterator_facade.

Parameters

other

any iterator on the same sequence.

Definition at line 131 of file IntegerSequenceIterator.h.

    { return this->myNumber == other.myNumber; }

References DGtal::IntegerSequenceIterator< TInteger >::myNumber.

increment()

template<typename TInteger >

void DGtal::IntegerSequenceIterator< TInteger >::increment ( )

inlineprivate

Increments the iterator. Required by boost::iterator_facade.

Definition at line 119 of file IntegerSequenceIterator.h.

{ myNumber++; }

References DGtal::IntegerSequenceIterator< TInteger >::myNumber.

operator=() [1/2]

template<typename TInteger >

IntegerSequenceIterator & DGtal::IntegerSequenceIterator< TInteger >::operator= ( const IntegerSequenceIterator< TInteger > & other )

default

Copy assignment operator.

Parameters

other

the object to copy.

Returns

a reference on 'this'.

operator=() [2/2]

template<typename TInteger >

IntegerSequenceIterator & DGtal::IntegerSequenceIterator< TInteger >::operator= ( IntegerSequenceIterator< TInteger > && other )

default

Move assignment operator.

Parameters

other

the object to move.

Returns

a reference on 'this'.

Friends And Related Symbol Documentation

boost::iterator_core_access

template<typename TInteger >

friend class boost::iterator_core_access

friend

Definition at line 116 of file IntegerSequenceIterator.h.

Field Documentation

myNumber

template<typename TInteger >

Integer DGtal::IntegerSequenceIterator< TInteger >::myNumber

protected

The current value of the interator.

Definition at line 143 of file IntegerSequenceIterator.h.

Referenced by DGtal::IntegerSequenceIterator< TInteger >::advance(), DGtal::IntegerSequenceIterator< TInteger >::decrement(), DGtal::IntegerSequenceIterator< TInteger >::dereference(), DGtal::IntegerSequenceIterator< TInteger >::distance_to(), DGtal::IntegerSequenceIterator< TInteger >::equal(), and DGtal::IntegerSequenceIterator< TInteger >::increment().

---

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

• IntegerSequenceIterator.h