Public Types | Public Member Functions | Private Attributes

DGtal::HyperRectDomain_SpanIterator< TPoint > Class Template Reference

#include <HyperRectDomain_SpanIterator.h>

Public Types

typedef
std::bidirectional_iterator_tag 
iterator_category
typedef TPoint value_type
typedef ptrdiff_t difference_type
typedef TPoint * pointer
typedef TPoint & reference

Public Member Functions

 HyperRectDomain_SpanIterator (const TPoint &p, const std::size_t aDim)
const TPoint & operator* () const
bool operator== (const HyperRectDomain_SpanIterator< TPoint > &it) const
bool operator!= (const HyperRectDomain_SpanIterator< TPoint > &aIt) const
void next ()
HyperRectDomain_SpanIterator
< TPoint > & 
operator++ ()
HyperRectDomain_SpanIterator
< TPoint > & 
operator++ (int)
void prev ()
HyperRectDomain_SpanIterator
< TPoint > & 
operator-- ()
HyperRectDomain_SpanIterator
< TPoint > & 
operator-- (int)

Private Attributes

TPoint myPoint
std::size_t myDimension

Detailed Description

template<typename TPoint>
class DGtal::HyperRectDomain_SpanIterator< TPoint >

Description of class 'HyperRectDomain_SpanIterator'

Aim:


Member Typedef Documentation

template<typename TPoint>
typedef ptrdiff_t DGtal::HyperRectDomain_SpanIterator< TPoint >::difference_type
template<typename TPoint>
typedef std::bidirectional_iterator_tag DGtal::HyperRectDomain_SpanIterator< TPoint >::iterator_category
template<typename TPoint>
typedef TPoint* DGtal::HyperRectDomain_SpanIterator< TPoint >::pointer
template<typename TPoint>
typedef TPoint& DGtal::HyperRectDomain_SpanIterator< TPoint >::reference
template<typename TPoint>
typedef TPoint DGtal::HyperRectDomain_SpanIterator< TPoint >::value_type
Todo:
construct a RANDOM-ACCESS iterator

Constructor & Destructor Documentation

template<typename TPoint>
DGtal::HyperRectDomain_SpanIterator< TPoint >::HyperRectDomain_SpanIterator ( const TPoint &  p,
const std::size_t  aDim 
) [inline]

Member Function Documentation

template<typename TPoint>
void DGtal::HyperRectDomain_SpanIterator< TPoint >::next (  )  [inline]

Implements the next() method to scan the domain points dimension by dimension (lexicographic order).

Todo:
check boundaries?

References DGtal::HyperRectDomain_SpanIterator< TPoint >::myDimension, and DGtal::HyperRectDomain_SpanIterator< TPoint >::myPoint.

Referenced by DGtal::HyperRectDomain_SpanIterator< TPoint >::operator++().

template<typename TPoint>
bool DGtal::HyperRectDomain_SpanIterator< TPoint >::operator!= ( const HyperRectDomain_SpanIterator< TPoint > &  aIt  )  const [inline]
template<typename TPoint>
const TPoint& DGtal::HyperRectDomain_SpanIterator< TPoint >::operator* (  )  const [inline]
template<typename TPoint>
HyperRectDomain_SpanIterator<TPoint>& DGtal::HyperRectDomain_SpanIterator< TPoint >::operator++ (  )  [inline]
template<typename TPoint>
HyperRectDomain_SpanIterator<TPoint>& DGtal::HyperRectDomain_SpanIterator< TPoint >::operator++ ( int   )  [inline]

Operator ++ (it++)

template<typename TPoint>
HyperRectDomain_SpanIterator<TPoint>& DGtal::HyperRectDomain_SpanIterator< TPoint >::operator-- ( int   )  [inline]

Operator ++ (it++)

template<typename TPoint>
HyperRectDomain_SpanIterator<TPoint>& DGtal::HyperRectDomain_SpanIterator< TPoint >::operator-- (  )  [inline]
template<typename TPoint>
bool DGtal::HyperRectDomain_SpanIterator< TPoint >::operator== ( const HyperRectDomain_SpanIterator< TPoint > &  it  )  const [inline]
template<typename TPoint>
void DGtal::HyperRectDomain_SpanIterator< TPoint >::prev (  )  [inline]

Field Documentation

template<typename TPoint>
std::size_t DGtal::HyperRectDomain_SpanIterator< TPoint >::myDimension [private]
template<typename TPoint>
TPoint DGtal::HyperRectDomain_SpanIterator< TPoint >::myPoint [private]

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