DGtal: DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator Struct Reference

#include <DGtal/geometry/curves/OneBalancedWordComputer.h>

Public Types
typedef BidirectionalCategory	iterator_category

typedef Point	value_type

typedef Index	difference_type

typedef Point *	pointer

typedef Point &	reference

Public Member Functions
	ConstPointIterator ()

	ConstPointIterator (const OneBalancedWordComputer *dss, Index ind, Point pt)

	~ConstPointIterator ()

bool	operator== (const ConstPointIterator other) const

bool	operator!= (const ConstPointIterator other) const

Index	operator- (const ConstPointIterator other) const

	ConstPointIterator (const ConstPointIterator &other)=default

ConstPointIterator &	operator= (const ConstPointIterator &other)

Point	operator* () const

ConstPointIterator &	operator++ ()

ConstPointIterator	operator++ (int)

ConstPointIterator &	operator-- ()

ConstPointIterator	operator-- (int)

void	next ()

void	prev ()

const OneBalancedWordComputer *	getDSS () const

Index	getIndex () const

Data Fields
const OneBalancedWordComputer *	myDSS

Index	i

Point	p

Detailed Description

template<typename TConstIterator, typename TInteger>
struct DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator

Iterator on the points of the DSS

Definition at line 248 of file OneBalancedWordComputer.h.

Member Typedef Documentation

◆ difference_type

template<typename TConstIterator , typename TInteger >

typedef Index DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::difference_type

Definition at line 253 of file OneBalancedWordComputer.h.

◆ iterator_category

template<typename TConstIterator , typename TInteger >

typedef BidirectionalCategory DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::iterator_category

Definition at line 251 of file OneBalancedWordComputer.h.

◆ pointer

template<typename TConstIterator , typename TInteger >

typedef Point* DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::pointer

Definition at line 254 of file OneBalancedWordComputer.h.

◆ reference

template<typename TConstIterator , typename TInteger >

typedef Point& DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::reference

Definition at line 255 of file OneBalancedWordComputer.h.

◆ value_type

template<typename TConstIterator , typename TInteger >

typedef Point DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::value_type

Definition at line 252 of file OneBalancedWordComputer.h.

Constructor & Destructor Documentation

◆ ConstPointIterator() [1/3]

template<typename TConstIterator , typename TInteger >

DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::ConstPointIterator ( )

inline

Default constructor, does nothing

Definition at line 264 of file OneBalancedWordComputer.h.

265 {}

◆ ConstPointIterator() [2/3]

template<typename TConstIterator , typename TInteger >

DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::ConstPointIterator	(	const OneBalancedWordComputer *	dss,
		Index	ind,
		Point	pt
	)

inline

Initialization constructor.

Parameters

dss	OneBalancedWordComputer on which the iterator is defined.
ind	Index of the first letter.
pt	starting point of the iterator.

Definition at line 273 of file OneBalancedWordComputer.h.

                                                                                          :
             myDSS(dss), i(ind), p(pt) 
           {}

◆ ~ConstPointIterator()

template<typename TConstIterator , typename TInteger >

DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::~ConstPointIterator ( )

inline

Destructor. Does nothing.

Definition at line 280 of file OneBalancedWordComputer.h.

280 {}

◆ ConstPointIterator() [3/3]

template<typename TConstIterator , typename TInteger >

DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::ConstPointIterator ( const ConstPointIterator & other )

default

Default copy constructor.

Parameters

other the object to copy.

Member Function Documentation

◆ getDSS()

template<typename TConstIterator , typename TInteger >

const OneBalancedWordComputer* DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::getDSS ( ) const

inline

Definition at line 369 of file OneBalancedWordComputer.h.

             {
               return myDSS;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::myDSS.

◆ getIndex()

template<typename TConstIterator , typename TInteger >

Index DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::getIndex ( ) const

inline

Definition at line 376 of file OneBalancedWordComputer.h.

             {
               return i;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i.

◆ next()

template<typename TConstIterator , typename TInteger >

void DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::next ( )

inline

Definition at line 354 of file OneBalancedWordComputer.h.

             {
               p += myDSS->myDisplacements( myDSS->getCode( i ) );
               ++i;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::getCode(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i, DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::myDisplacements, and DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::myDSS.

Referenced by DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator++().

◆ operator!=()

template<typename TConstIterator , typename TInteger >

bool DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator!= ( const ConstPointIterator other ) const

inline

Definition at line 289 of file OneBalancedWordComputer.h.

             {
               return i != other.i;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i.

◆ operator*()

template<typename TConstIterator , typename TInteger >

Point DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator* ( ) const

inline

Definition at line 317 of file OneBalancedWordComputer.h.

             {
               return p;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::p.

◆ operator++() [1/2]

template<typename TConstIterator , typename TInteger >

ConstPointIterator& DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator++ ( )

inline

Definition at line 323 of file OneBalancedWordComputer.h.

             {
               next();
               return *this;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::next().

◆ operator++() [2/2]

template<typename TConstIterator , typename TInteger >

ConstPointIterator DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator++ ( int )

inline

Definition at line 330 of file OneBalancedWordComputer.h.

             {
               ConstPointIterator it = *this;
               next();
               return it;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::next().

◆ operator-()

template<typename TConstIterator , typename TInteger >

Index DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator- ( const ConstPointIterator other ) const

inline

Definition at line 294 of file OneBalancedWordComputer.h.

             {
               return i - other.i;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i.

◆ operator--() [1/2]

template<typename TConstIterator , typename TInteger >

ConstPointIterator& DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator-- ( )

inline

Definition at line 339 of file OneBalancedWordComputer.h.

             {
               prev();
               return *this;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::prev().

◆ operator--() [2/2]

template<typename TConstIterator , typename TInteger >

ConstPointIterator DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator-- ( int )

inline

Definition at line 346 of file OneBalancedWordComputer.h.

             {
               ConstPointIterator it = *this;
               prev();
               return it;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::prev().

◆ operator=()

template<typename TConstIterator , typename TInteger >

ConstPointIterator& DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator= ( const ConstPointIterator & other )

inline

Assignment operator.

Parameters

other the object to copy.

Definition at line 309 of file OneBalancedWordComputer.h.

             {
               i = other.i;
               myDSS = other.myDSS;
               p = other.p;
               return *this;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i, DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::myDSS, and DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::p.

◆ operator==()

template<typename TConstIterator , typename TInteger >

bool DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator== ( const ConstPointIterator other ) const

inline

Comparaison operators.

Definition at line 285 of file OneBalancedWordComputer.h.

             {
               return i == other.i;
             }

References DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i.

◆ prev()

template<typename TConstIterator , typename TInteger >

void DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::prev ( )

inline

Definition at line 361 of file OneBalancedWordComputer.h.

             {
               --i;
               p -= myDSS->myDisplacements( myDSS->getCode( i ) );
             }

Referenced by DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator--().

Field Documentation

◆ i

template<typename TConstIterator , typename TInteger >

Index DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::i

Definition at line 258 of file OneBalancedWordComputer.h.

Referenced by DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::getIndex(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::next(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator!=(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator-(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator=(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator==(), and DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::prev().

◆ myDSS

template<typename TConstIterator , typename TInteger >

const OneBalancedWordComputer* DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::myDSS

Definition at line 257 of file OneBalancedWordComputer.h.

Referenced by DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::getDSS(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::next(), DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator=(), and DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::prev().

◆ p

template<typename TConstIterator , typename TInteger >

Point DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::p

Definition at line 259 of file OneBalancedWordComputer.h.

Referenced by DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator*(), and DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator::operator=().

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

OneBalancedWordComputer.h

Public Types

Public Member Functions

Data Fields

Detailed Description

template<typename TConstIterator, typename TInteger> struct DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ ConstPointIterator() [1/3]

◆ ConstPointIterator() [2/3]

◆ ~ConstPointIterator()

◆ ConstPointIterator() [3/3]

Member Function Documentation

◆ getDSS()

◆ getIndex()

◆ next()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator=()

◆ operator==()

◆ prev()

Field Documentation

◆ i

◆ myDSS

◆ p

template<typename TConstIterator, typename TInteger>
struct DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator