Public Types | Public Member Functions | Private Attributes | Friends

DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator Class Reference

#include <ImageContainerBySTLVector.h>

Public Types

typedef
std::bidirectional_iterator_tag 
iterator_category
typedef ValueType value_type
typedef ptrdiff_t difference_type
typedef ValueTypepointer
typedef ValueTypereference

Public Member Functions

 SpanIterator (const Point &p, const Dimension aDim, ImageContainerBySTLVector< Domain, ValueType > *aMap)
const ValueTypeoperator* () const
bool operator== (const SpanIterator &it) const
bool operator!= (const SpanIterator &it) const
void next ()
void prev ()
SpanIteratoroperator++ ()
SpanIteratoroperator++ (int)
SpanIteratoroperator-- ()
SpanIteratoroperator-- (int)

Private Attributes

Size myPos
ImageContainerBySTLVector
< Domain, ValueType > * 
myMap
Dimension myDimension
Size myShift

Friends

class ImageContainerBySTLVector< Domain, ValueType >

Detailed Description

template<typename TDomain, typename TValueType>
class DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator

Specific SpanIterator on ImageContainerBySTLVector.

Template Parameters:
Domain the HyperRectDomain on which the iterator iterates.
ValueType 

Member Typedef Documentation

template<typename TDomain, typename TValueType>
typedef ptrdiff_t DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::difference_type
template<typename TDomain, typename TValueType>
typedef std::bidirectional_iterator_tag DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::iterator_category
template<typename TDomain, typename TValueType>
typedef ValueType* DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::pointer
template<typename TDomain, typename TValueType>
typedef ValueType& DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::reference
template<typename TDomain, typename TValueType>
typedef ValueType DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::value_type
Todo:
construct a RANDOM-ACCESS iterator

Constructor & Destructor Documentation

template<typename TDomain, typename TValueType>
DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::SpanIterator ( const Point p,
const Dimension  aDim,
ImageContainerBySTLVector< Domain, ValueType > *  aMap 
) [inline]

Member Function Documentation

template<typename TDomain, typename TValueType>
void DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::next (  )  [inline]
template<typename TDomain, typename TValueType>
bool DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator!= ( const SpanIterator it  )  const [inline]

Operator !=

Returns:
true if this and it are different.

References DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myPos.

template<typename TDomain, typename TValueType>
const ValueType& DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator* (  )  const [inline]

operator* on SpanIterators.

Returns:
the value associated to the current position.

References DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myMap, and DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myPos.

template<typename TDomain, typename TValueType>
SpanIterator& DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator++ ( int   )  [inline]

Operator ++ (it++)

template<typename TDomain, typename TValueType>
SpanIterator& DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator++ (  )  [inline]
template<typename TDomain, typename TValueType>
SpanIterator& DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator-- ( int   )  [inline]

Operator -- (it--)

template<typename TDomain, typename TValueType>
SpanIterator& DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator-- (  )  [inline]
template<typename TDomain, typename TValueType>
bool DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::operator== ( const SpanIterator it  )  const [inline]

Operator ==.

Returns:
true if this and it are equals.

References DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myPos.

template<typename TDomain, typename TValueType>
void DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::prev (  )  [inline]

Friends And Related Function Documentation

template<typename TDomain, typename TValueType>
friend class ImageContainerBySTLVector< Domain, ValueType > [friend]

Field Documentation

template<typename TDomain, typename TValueType>
Dimension DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myDimension [private]

Dimension on which the iterator must iterate.

Referenced by DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::SpanIterator().

template<typename TDomain, typename TValueType>
ImageContainerBySTLVector<Domain, ValueType>* DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myMap [private]
template<typename TDomain, typename TValueType>
Size DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myPos [private]
template<typename TDomain, typename TValueType>
Size DGtal::ImageContainerBySTLVector< TDomain, TValueType >::SpanIterator::myShift [private]

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