DGtal: 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). More...

#include <DGtal/base/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 (ConstAlias< TRange > aRange, ConstAlias< 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(*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 86 of file ConstRangeFromPointAdapter.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TRange , typename TFunctor , typename TReturnType >

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

Definition at line 95 of file ConstRangeFromPointAdapter.h.

◆ ConstReverseIterator

template<typename TRange , typename TFunctor , typename TReturnType >

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

Definition at line 96 of file ConstRangeFromPointAdapter.h.

◆ Point

template<typename TRange , typename TFunctor , typename TReturnType >

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

Definition at line 94 of file ConstRangeFromPointAdapter.h.

Constructor & Destructor Documentation

◆ ConstRangeFromPointAdapter() [1/2]

template<typename TRange , typename TFunctor , typename TReturnType >

DGtal::ConstRangeFromPointAdapter< TRange, TFunctor, TReturnType >::ConstRangeFromPointAdapter	(	ConstAlias< TRange >	aRange,
		ConstAlias< 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 106 of file ConstRangeFromPointAdapter.h.

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

DGtal::ConstRangeFromPointAdapter::myFunctorPtr

const TFunctor * myFunctorPtr

Definition: ConstRangeFromPointAdapter.h:153

DGtal::ConstRangeFromPointAdapter::myRangePtr

const TRange * myRangePtr

Definition: ConstRangeFromPointAdapter.h:149

◆ ConstRangeFromPointAdapter() [2/2]

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 114 of file ConstRangeFromPointAdapter.h.

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

◆ ~ConstRangeFromPointAdapter()

template<typename TRange , typename TFunctor , typename TReturnType >

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

inline

Destructor. Does nothing.

Definition at line 135 of file ConstRangeFromPointAdapter.h.

135 {}

Member Function Documentation

◆ begin() [1/2]

template<typename TRange , typename TFunctor , typename TReturnType >

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

inline

Iterator service.

Returns: begin iterator

Definition at line 162 of file ConstRangeFromPointAdapter.h.

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

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

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

◆ begin() [2/2]

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 170 of file ConstRangeFromPointAdapter.h.

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

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

◆ BOOST_CONCEPT_ASSERT()

template<typename TRange , typename TFunctor , typename TReturnType >

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

private

◆ end()

template<typename TRange , typename TFunctor , typename TReturnType >

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

inline

Iterator service.

Returns: end iterator

Definition at line 178 of file ConstRangeFromPointAdapter.h.

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

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

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

◆ isValid()

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 141 of file ConstRangeFromPointAdapter.h.

141 { return true; }

◆ operator=()

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 122 of file ConstRangeFromPointAdapter.h.

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

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

◆ rbegin() [1/2]

template<typename TRange , typename TFunctor , typename TReturnType >

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

inline

Iterator service.

Returns: rbegin iterator

Definition at line 186 of file ConstRangeFromPointAdapter.h.

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

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

◆ rbegin() [2/2]

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 194 of file ConstRangeFromPointAdapter.h.

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

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

◆ rend()

template<typename TRange , typename TFunctor , typename TReturnType >

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

inline

Iterator service.

Returns: rend iterator

Definition at line 204 of file ConstRangeFromPointAdapter.h.

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

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

Field Documentation

◆ myFunctorPtr

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 153 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().

◆ myRangePtr

template<typename TRange , typename TFunctor , typename TReturnType >

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

private

Aliasing pointer on the range

Definition at line 149 of file ConstRangeFromPointAdapter.h.

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

◆ ConstIterator

◆ ConstReverseIterator

◆ Point

Constructor & Destructor Documentation

◆ ConstRangeFromPointAdapter() [1/2]

◆ ConstRangeFromPointAdapter() [2/2]

◆ ~ConstRangeFromPointAdapter()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ BOOST_CONCEPT_ASSERT()

◆ end()

◆ isValid()

◆ operator=()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend()

Field Documentation

◆ myFunctorPtr

◆ myRangePtr

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