DGtal  1.1.0
Public Types | Public Member Functions | Data Fields
DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator Struct Reference

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

Collaboration diagram for DGtal::OneBalancedWordComputer< TConstIterator, TInteger >::ConstPointIterator:
[legend]

Public Types

typedef BidirectionalCategory iterator_category
 
typedef Point value_type
 
typedef Index difference_type
 
typedef Pointpointer
 
typedef Pointreference
 

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
 
ConstPointIteratoroperator= (const ConstPointIterator &other)
 
Point operator* () const
 
ConstPointIteratoroperator++ ()
 
ConstPointIterator operator++ (int)
 
ConstPointIteratoroperator-- ()
 
ConstPointIterator operator-- (int)
 
void next ()
 
void prev ()
 
const OneBalancedWordComputergetDSS () const
 
Index getIndex () const
 

Data Fields

const OneBalancedWordComputermyDSS
 
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
dssOneBalancedWordComputer on which the iterator is defined.
indIndex of the first letter.
ptstarting point of the iterator.

Definition at line 273 of file OneBalancedWordComputer.h.

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

◆ ~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
otherthe object to copy.

Member Function Documentation

◆ getDSS()

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

◆ getIndex()

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

Definition at line 376 of file OneBalancedWordComputer.h.

377  {
378  return i;
379  }

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

◆ next()

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

◆ 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.

290  {
291  return i != other.i;
292  }

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.

318  {
319  return p;
320  }

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.

324  {
325  next();
326  return *this;
327  }

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.

331  {
332  ConstPointIterator it = *this;
333  next();
334  return it;
335  }

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.

295  {
296  return i - other.i;
297  }

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.

340  {
341  prev();
342  return *this;
343  }

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.

347  {
348  ConstPointIterator it = *this;
349  prev();
350  return it;
351  }

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
otherthe object to copy.

Definition at line 309 of file OneBalancedWordComputer.h.

310  {
311  i = other.i;
312  myDSS = other.myDSS;
313  p = other.p;
314  return *this;
315  }

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.

286  {
287  return i == other.i;
288  }

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

◆ prev()

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

Field Documentation

◆ i

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

◆ myDSS

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

◆ p

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

The documentation for this struct was generated from the following file:
DGtal::OneBalancedWordComputer::ConstPointIterator::next
void next()
Definition: OneBalancedWordComputer.h:354
DGtal::OneBalancedWordComputer::getCode
Code getCode(Index pos)
DGtal::OneBalancedWordComputer::ConstPointIterator::myDSS
const OneBalancedWordComputer * myDSS
Definition: OneBalancedWordComputer.h:257
DGtal::OneBalancedWordComputer::ConstPointIterator::p
Point p
Definition: OneBalancedWordComputer.h:259
DGtal::OneBalancedWordComputer::ConstPointIterator::prev
void prev()
Definition: OneBalancedWordComputer.h:361
DGtal::OneBalancedWordComputer::ConstPointIterator::i
Index i
Definition: OneBalancedWordComputer.h:258
DGtal::OneBalancedWordComputer::myDisplacements
Vector(* myDisplacements)(Code)
Definition: OneBalancedWordComputer.h:789
DGtal::OneBalancedWordComputer::ConstPointIterator::ConstPointIterator
ConstPointIterator()
Definition: OneBalancedWordComputer.h:264