#include <DGtal/kernel/domains/HyperRectDomain_Iterator.h>

Collaboration diagram for DGtal::HyperRectDomain_Iterator< TPoint >:

Public Types
typedef std::bidirectional_iterator_tag	iterator_category

typedef TPoint	value_type

typedef ptrdiff_t	difference_type

typedef TPoint *	pointer

typedef TPoint &	reference

typedef TPoint::Dimension	Dimension

Public Member Functions
	HyperRectDomain_Iterator (const TPoint &p, const TPoint &lower, const TPoint &upper)

const TPoint &	operator* () const

TPoint &	operator* ()

bool	operator== (const HyperRectDomain_Iterator< TPoint > &it) const

bool	operator!= (const HyperRectDomain_Iterator< TPoint > &aIt) const

void	nextLexicographicOrder ()

HyperRectDomain_Iterator< TPoint > &	operator++ ()

HyperRectDomain_Iterator< TPoint >	operator++ (int)

void	prevLexicographicOrder ()

HyperRectDomain_Iterator< TPoint > &	operator-- ()

HyperRectDomain_Iterator< TPoint >	operator-- (int)

Private Attributes
TPoint	myPoint

TPoint	mylower

TPoint	myupper

Detailed Description

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

Description of class 'HyperRectDomain_Iterator'

Aim:

Examples:: geometry/curves/exampleGridCurve2d.cpp, geometry/volumes/distance/distancetransform3D.cpp, images/exampleRigidtransformation2d.cpp, images/exampleRigidtransformation3d.cpp, io/viewDualSurface.cpp, io/viewers/viewer3D-7-planes.cpp, io/viewers/viewer3D-7-stdplane.cpp, io/viewers/viewer3D-7bis-planes.cpp, io/viewers/viewer3D-7bis-stdplane.cpp, io/viewers/viewer3D-9-3Dimages.cpp, topology/3dBorderExtraction.cpp, topology/3dKSSurfaceExtraction.cpp, topology/frontierAndBoundary.cpp, topology/generateSimplicityTables2D.cpp, topology/homotopicThinning3D.cpp, and tutorial-examples/volDTGranulo.cpp.

Definition at line 158 of file HyperRectDomain_Iterator.h.

Member Typedef Documentation

template<typename TPoint>

typedef ptrdiff_t DGtal::HyperRectDomain_Iterator< TPoint >::difference_type

Definition at line 163 of file HyperRectDomain_Iterator.h.

template<typename TPoint>

typedef TPoint::Dimension DGtal::HyperRectDomain_Iterator< TPoint >::Dimension

Definition at line 166 of file HyperRectDomain_Iterator.h.

template<typename TPoint>

typedef std::bidirectional_iterator_tag DGtal::HyperRectDomain_Iterator< TPoint >::iterator_category

Definition at line 161 of file HyperRectDomain_Iterator.h.

template<typename TPoint>

typedef TPoint* DGtal::HyperRectDomain_Iterator< TPoint >::pointer

Definition at line 164 of file HyperRectDomain_Iterator.h.

template<typename TPoint>

typedef TPoint& DGtal::HyperRectDomain_Iterator< TPoint >::reference

Definition at line 165 of file HyperRectDomain_Iterator.h.

template<typename TPoint>

typedef TPoint DGtal::HyperRectDomain_Iterator< TPoint >::value_type

Todo:: construct a RANDOM-ACCESS iterator

Definition at line 162 of file HyperRectDomain_Iterator.h.

Constructor & Destructor Documentation

template<typename TPoint>

DGtal::HyperRectDomain_Iterator< TPoint >::HyperRectDomain_Iterator	(	const TPoint &	p,
		const TPoint &	lower,
		const TPoint &	upper
	)

inline

Definition at line 169 of file HyperRectDomain_Iterator.h.

       : myPoint( p ), mylower( lower ), myupper( upper )
       {
         ASSERT_MSG( // For an empty domain, lower = upper + diag(1) so that begin() == end().
             lower.isLower(upper) || lower == upper + TPoint::diagonal(1),
             "The lower bound must be lower than the upper bound or, for an empty domain, be equal to the upper bound + diagonal(1)."
         );
 
         ASSERT_MSG( 
             ( lower.isLower(p) && p.isLower(upper) ) || p == lower || p == upper,
             "The point must be inside the domain or be equal to one of his bound."
         );
       }

Member Function Documentation

template<typename TPoint>

void DGtal::HyperRectDomain_Iterator< TPoint >::nextLexicographicOrder ( )

inline

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

Definition at line 225 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::mylower, DGtal::HyperRectDomain_Iterator< TPoint >::myPoint, and DGtal::HyperRectDomain_Iterator< TPoint >::myupper.

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

       {
         ++myPoint[0];
         if (( TPoint::dimension > 1 ) &&
             ( myPoint[0] > myupper[0] ) )
           {
             Dimension current_pos = 0;
             do
               {
                 myPoint[current_pos] = mylower[current_pos];
                 current_pos++;
                 if ( current_pos < TPoint::dimension )
                   ++myPoint[current_pos];
               }
             while (( current_pos + 1 < TPoint::dimension ) &&
                 ( myPoint[ current_pos ]  >  myupper[ current_pos ] ) );
           }
       }

template<typename TPoint>

bool DGtal::HyperRectDomain_Iterator< TPoint >::operator!= ( const HyperRectDomain_Iterator< TPoint > & aIt ) const

inline

Operator !=

Definition at line 216 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::myPoint.

       {
         return ( myPoint!=aIt.myPoint );
       }

template<typename TPoint>

const TPoint& DGtal::HyperRectDomain_Iterator< TPoint >::operator* ( ) const

inline

Definition at line 183 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::mylower, DGtal::HyperRectDomain_Iterator< TPoint >::myPoint, and DGtal::HyperRectDomain_Iterator< TPoint >::myupper.

       {
         ASSERT_MSG( // we must be between [begin,end]
             mylower.isLower(myPoint) && myPoint.isLower(myupper),
             "The iterator points outside the domain." 
         );
 
         return myPoint;
       }

template<typename TPoint>

TPoint& DGtal::HyperRectDomain_Iterator< TPoint >::operator* ( )

inline

Definition at line 193 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::mylower, DGtal::HyperRectDomain_Iterator< TPoint >::myPoint, and DGtal::HyperRectDomain_Iterator< TPoint >::myupper.

       {
         ASSERT_MSG( // we must be between [begin,end]
             mylower.isLower(myPoint) && myPoint.isLower(myupper), 
             "The iterator points outside the domain."
         );
         
         return myPoint;
       }

template<typename TPoint>

HyperRectDomain_Iterator<TPoint>& DGtal::HyperRectDomain_Iterator< TPoint >::operator++ ( )

inline

Operator ++ (++it)

Definition at line 247 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::nextLexicographicOrder().

       {
         nextLexicographicOrder();
         return *this;
       }

template<typename TPoint>

HyperRectDomain_Iterator<TPoint> DGtal::HyperRectDomain_Iterator< TPoint >::operator++ ( int )

inline

Operator ++ (it++)

Definition at line 257 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::nextLexicographicOrder().

       {
         HyperRectDomain_Iterator<TPoint> tmp = *this;
         nextLexicographicOrder();
         return tmp;
       }

template<typename TPoint>

HyperRectDomain_Iterator<TPoint>& DGtal::HyperRectDomain_Iterator< TPoint >::operator-- ( )

inline

Operator – (–it)

Definition at line 291 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::prevLexicographicOrder().

       {
         prevLexicographicOrder();
         return *this;
       }

template<typename TPoint>

HyperRectDomain_Iterator<TPoint> DGtal::HyperRectDomain_Iterator< TPoint >::operator-- ( int )

inline

Operator – (it–)

Definition at line 300 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::prevLexicographicOrder().

       {
         HyperRectDomain_Iterator<TPoint> tmp = *this;
         prevLexicographicOrder();
         return tmp;
       }

template<typename TPoint>

bool DGtal::HyperRectDomain_Iterator< TPoint >::operator== ( const HyperRectDomain_Iterator< TPoint > & it ) const

inline

Operator ==

Definition at line 207 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::myPoint.

       {
         return ( myPoint==it.myPoint );
       }

template<typename TPoint>

void DGtal::HyperRectDomain_Iterator< TPoint >::prevLexicographicOrder ( )

inline

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

Definition at line 268 of file HyperRectDomain_Iterator.h.

References DGtal::HyperRectDomain_Iterator< TPoint >::mylower, DGtal::HyperRectDomain_Iterator< TPoint >::myPoint, and DGtal::HyperRectDomain_Iterator< TPoint >::myupper.

Referenced by DGtal::HyperRectDomain_Iterator< TPoint >::operator--().

       {
         --myPoint[0];
         if (( TPoint::dimension > 1 ) &&
             ( myPoint[0]  <  mylower[0] ) )
           {
             Dimension current_pos = 0;
             do
               {
                 myPoint[ current_pos ] = myupper[ current_pos ];
                 ++current_pos;
                 if ( current_pos < TPoint::dimension )
                   --myPoint[ current_pos ];
               }
             while (( current_pos + 1 < TPoint::dimension ) &&
                 ( myPoint[ current_pos ]  <  mylower[ current_pos ] ) );
           }
       }