#include <ConstRangeFromPointAdapter.h>

Public Types
typedef TRange::Point	Point
typedef ConstIteratorAdapter < typename TRange::ConstIterator, TFunctor, TReturnType >	ConstIterator
typedef std::reverse_iterator < ConstIterator >	ConstReverseIterator

Public Member Functions
	ConstRangeFromPointAdapter (const TRange &aRange, const TFunctor &aFunctor)
	ConstRangeFromPointAdapter (const ConstRangeFromPointAdapter &other)
ConstRangeFromPointAdapter &	operator= (const ConstRangeFromPointAdapter &other)
	~ConstRangeFromPointAdapter ()
bool	isValid () const
ConstIterator	begin () const
ConstIterator	begin (const Point &aPoint) const
ConstIterator	end () const
ConstReverseIterator	rbegin () const
ConstReverseIterator	rbegin (const Point &aPoint) const
ConstReverseIterator	rend () const

Private Member Functions
	BOOST_CONCEPT_ASSERT ((CConstBidirectionalRangeFromPoint< TRange >))

Private Attributes
const TRange *	myRangePtr
const TFunctor *	myFunctorPtr

Detailed Description

template<typename TRange, typename TFunctor, typename TReturnType>
class DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >

Aim: model of CConstBidirectionalRangeFromPoint that adapts any bidirectional range and provides services to iterate over it (in a read-only manner).

Template Parameters:

TRange a model of CConstBidirectionalRangeFromPoint

Moreover, the provided iterators are adapted with a functor f given at construction so that operator* calls f(<em>it), instead of calling directly operator of the iterator it.

Template Parameters:

TFunctor	the type of functor that transforms the pointed element into another one
TReturnType	the type of the element returned by the underlying functor.

NB: the underlying range and functor are stored as aliasing pointers in order to avoid copies. As a consequence the pointed object must exist and must not be deleted during the use of any instance of this class.

See also:: ConstIteratorAdapter BasicFunctors.h

Definition at line 85 of file ConstRangeFromPointAdapter.h.

Member Typedef Documentation

template<typename TRange , typename TFunctor , typename TReturnType >

typedef ConstIteratorAdapter<typename TRange::ConstIterator,TFunctor,TReturnType> DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::ConstIterator

Definition at line 94 of file ConstRangeFromPointAdapter.h.

template<typename TRange , typename TFunctor , typename TReturnType >

typedef std::reverse_iterator<ConstIterator> DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::ConstReverseIterator

Definition at line 95 of file ConstRangeFromPointAdapter.h.

template<typename TRange , typename TFunctor , typename TReturnType >

typedef TRange::Point DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::Point

Definition at line 93 of file ConstRangeFromPointAdapter.h.

Constructor & Destructor Documentation

template<typename TRange , typename TFunctor , typename TReturnType >

DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::ConstRangeFromPointAdapter	(	const TRange &	aRange,
		const TFunctor &	aFunctor
	)

inline

Standard constructor from one range and one functor.

Parameters:

aRange	the range to adapt.
aFunctor	functor used to adapt on-the-fly the elements of the range

Definition at line 105 of file ConstRangeFromPointAdapter.h.

: myRangePtr(&aRange), myFunctorPtr(&aFunctor) {}

template<typename TRange , typename TFunctor , typename TReturnType >

DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::ConstRangeFromPointAdapter ( const ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType > & other )

inline

Copy constructor.

Parameters:

other the iterator to clone.

Definition at line 113 of file ConstRangeFromPointAdapter.h.

: myRangePtr(other.myRangePtr), myFunctorPtr(other.myFunctorPtr) {}

template<typename TRange , typename TFunctor , typename TReturnType >

DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::~ConstRangeFromPointAdapter ( )

inline

Destructor. Does nothing.

Definition at line 134 of file ConstRangeFromPointAdapter.h.

{}

Member Function Documentation

template<typename TRange , typename TFunctor , typename TReturnType >

ConstIterator DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::begin ( ) const

inline

Iterator service.

Returns:: begin iterator

Definition at line 161 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myFunctorPtr, and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myRangePtr.

Referenced by DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rend().

                                {
      return ConstIterator( myRangePtr->begin(), *myFunctorPtr );
    }

template<typename TRange , typename TFunctor , typename TReturnType >

ConstIterator DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::begin ( const Point & aPoint ) const

inline

Iterator service.

Returns:: begin iterator from a point

Definition at line 169 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myFunctorPtr, and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myRangePtr.

                                                   {
      return ConstIterator( myRangePtr->begin(aPoint), *myFunctorPtr );
    }

template<typename TRange , typename TFunctor , typename TReturnType >

DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::BOOST_CONCEPT_ASSERT ( (CConstBidirectionalRangeFromPoint< TRange >) )

private

template<typename TRange , typename TFunctor , typename TReturnType >

ConstIterator DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::end ( ) const

inline

Iterator service.

Returns:: end iterator

Definition at line 177 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myFunctorPtr, and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myRangePtr.

Referenced by DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rbegin().

                              {
      return ConstIterator( myRangePtr->end(), *myFunctorPtr );
    }

template<typename TRange , typename TFunctor , typename TReturnType >

bool DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns:: 'true' if the object is valid, 'false' otherwise.

Definition at line 140 of file ConstRangeFromPointAdapter.h.

{ return true; }

template<typename TRange , typename TFunctor , typename TReturnType >

ConstRangeFromPointAdapter& DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::operator= ( const ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType > & other )

inline

Assignment.

Parameters:

other the iterator to copy.

Returns:: a reference on 'this'.

Definition at line 121 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myFunctorPtr, and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myRangePtr.

    {  
      if ( this != &other )
        {
          myRangePtr = other.myRangePtr;
          myFunctorPtr = other.myFunctorPtr;
        }
      return *this;
    }

template<typename TRange , typename TFunctor , typename TReturnType >

ConstReverseIterator DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rbegin ( ) const

inline

Iterator service.

Returns:: rbegin iterator

Definition at line 185 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::end().

                                        {
      return ConstReverseIterator(this->end());
    }

template<typename TRange , typename TFunctor , typename TReturnType >

ConstReverseIterator DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rbegin ( const Point & aPoint ) const

inline

Iterator service.

Returns:: rbegin iterator from a point

Definition at line 193 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::end(), DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myFunctorPtr, and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myRangePtr.

                                                           {
      ConstIterator it( myRangePtr->begin(aPoint), *myFunctorPtr ); 
      if ( it != this->end() ) ++it; 
      return ConstReverseIterator( it );
    }

template<typename TRange , typename TFunctor , typename TReturnType >

ConstReverseIterator DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rend ( ) const

inline

Iterator service.

Returns:: rend iterator

Definition at line 203 of file ConstRangeFromPointAdapter.h.

References DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::begin().

                                      {
      return ConstReverseIterator(this->begin());
    }

Field Documentation

template<typename TRange , typename TFunctor , typename TReturnType >

const TFunctor* DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myFunctorPtr

private

Aliasing pointer on the underlying functor

Definition at line 152 of file ConstRangeFromPointAdapter.h.

Referenced by DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::begin(), DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::end(), DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::operator=(), and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rbegin().

template<typename TRange , typename TFunctor , typename TReturnType >

const TRange* DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::myRangePtr

private

Aliasing pointer on the range

Definition at line 148 of file ConstRangeFromPointAdapter.h.

Referenced by DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::begin(), DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::end(), DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::operator=(), and DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::rbegin().

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

ConstRangeFromPointAdapter.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename TRange, typename TFunctor, typename TReturnType> class DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<typename TRange, typename TFunctor, typename TReturnType>
class DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >