#include <SimpleRandomAccessConstRangeFromPoint.h>

Collaboration diagram for DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >:

Public Types
typedef DistanceFunctor::Point	Point
typedef TConstIterator	ConstIterator
typedef std::reverse_iterator < ConstIterator >	ConstReverseIterator
typedef Circulator< ConstIterator >	ConstCirculator
typedef std::reverse_iterator < ConstCirculator >	ConstReverseCirculator

Public Member Functions
	SimpleRandomAccessConstRangeFromPoint (const TConstIterator &itb, const TConstIterator &ite, const DistanceFunctor &aDistance)
	SimpleRandomAccessConstRangeFromPoint (const SimpleRandomAccessConstRangeFromPoint &other)
SimpleRandomAccessConstRangeFromPoint &	operator= (const SimpleRandomAccessConstRangeFromPoint &other)
	~SimpleRandomAccessConstRangeFromPoint ()
bool	isValid () const
void	selfDisplay (std::ostream &out) const
std::string	className () 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
ConstCirculator	c () const
ConstReverseCirculator	rc () const

Private Member Functions
	BOOST_CONCEPT_ASSERT ((boost::RandomAccessIterator< TConstIterator >))
	BOOST_CONCEPT_ASSERT ((boost::UnaryFunction< DistanceFunctor, typename DistanceFunctor::Difference, typename DistanceFunctor::Point >))

Private Attributes
TConstIterator	myBegin
TConstIterator	myEnd
DistanceFunctor	myDistance

Detailed Description

template<typename TConstIterator, typename DistanceFunctor>
class DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >

Aim: model of CConstBidirectionalRangeFromPoint that adapts any range of elements bounded by two iterators [itb, ite) and provides services to (circularly)iterate over it (in a read-only manner).

Template Parameters:

TConstIterator	the type of the iterator to adapt (at least bidirectional)
DistanceFunctor	type of distance from point functor for random access container models. Models must have a Point and a Difference inner types. operator() returns a number of type Difference on instances of Point)

See also:: ConstRangeAdapter

Definition at line 73 of file SimpleRandomAccessConstRangeFromPoint.h.

Member Typedef Documentation

template<typename TConstIterator , typename DistanceFunctor >

typedef Circulator<ConstIterator> DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::ConstCirculator

Definition at line 89 of file SimpleRandomAccessConstRangeFromPoint.h.

template<typename TConstIterator , typename DistanceFunctor >

typedef TConstIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::ConstIterator

Definition at line 86 of file SimpleRandomAccessConstRangeFromPoint.h.

template<typename TConstIterator , typename DistanceFunctor >

typedef std::reverse_iterator<ConstCirculator> DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::ConstReverseCirculator

Definition at line 90 of file SimpleRandomAccessConstRangeFromPoint.h.

template<typename TConstIterator , typename DistanceFunctor >

typedef std::reverse_iterator<ConstIterator> DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::ConstReverseIterator

Definition at line 87 of file SimpleRandomAccessConstRangeFromPoint.h.

template<typename TConstIterator , typename DistanceFunctor >

typedef DistanceFunctor::Point DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::Point

Definition at line 84 of file SimpleRandomAccessConstRangeFromPoint.h.

Constructor & Destructor Documentation

template<typename TConstIterator , typename DistanceFunctor >

DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::SimpleRandomAccessConstRangeFromPoint	(	const TConstIterator &	itb,
		const TConstIterator &	ite,
		const DistanceFunctor &	aDistance
	)

inline

Standard constructor from two iterators and one functor.

Parameters:

itb	begin iterator.
ite	end iterator.
aFunctor	functor used to adapt on-the-fly the elements of the range

Definition at line 102 of file SimpleRandomAccessConstRangeFromPoint.h.

: myBegin ( itb ), myEnd ( ite ), myDistance ( aDistance ) {}

template<typename TConstIterator , typename DistanceFunctor >

DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::SimpleRandomAccessConstRangeFromPoint ( const SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor > & other )

inline

Copy constructor.

Parameters:

other the iterator to clone.

Definition at line 109 of file SimpleRandomAccessConstRangeFromPoint.h.

: myBegin ( other.myBegin ), myEnd ( other.myEnd ), myDistance ( other.myDistance ) {}

template<typename TConstIterator , typename DistanceFunctor >

DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::~SimpleRandomAccessConstRangeFromPoint ( )

inline

Destructor. Does nothing.

Definition at line 132 of file SimpleRandomAccessConstRangeFromPoint.h.

{}

Member Function Documentation

template<typename TConstIterator , typename DistanceFunctor >

ConstIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::begin ( ) const

inline

Iterator service.

Returns:: begin iterator

Definition at line 191 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myBegin.

Referenced by DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::c(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rend().

      {
        return ConstIterator ( myBegin );
      }

template<typename TConstIterator , typename DistanceFunctor >

ConstIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::begin ( const Point & aPoint ) const

inline

Iterator service.

Returns:: begin iterator

Definition at line 201 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myBegin, and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myDistance.

      {
        return ConstIterator ( myBegin ) + myDistance ( aPoint );
      }

template<typename TConstIterator , typename DistanceFunctor >

DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::BOOST_CONCEPT_ASSERT ( (boost::RandomAccessIterator< TConstIterator >) )

private

template<typename TConstIterator , typename DistanceFunctor >

DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::BOOST_CONCEPT_ASSERT ( (boost::UnaryFunction< DistanceFunctor, typename DistanceFunctor::Difference, typename DistanceFunctor::Point >) )

private

template<typename TConstIterator , typename DistanceFunctor >

ConstCirculator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::c ( ) const

inline

Circulator service.

Returns:: a circulator

Definition at line 247 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::begin(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::end().

Referenced by DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rc().

      {
        return ConstCirculator ( this->begin(), this->begin(), this->end() );
      }

template<typename TConstIterator , typename DistanceFunctor >

std::string DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::className ( ) const

inline

Returns:: the style name used for drawing this object.

Definition at line 160 of file SimpleRandomAccessConstRangeFromPoint.h.

      {
        return "SimpleRandomAccessConstRangeFromPoint";
      }

template<typename TConstIterator , typename DistanceFunctor >

ConstIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::end ( ) const

inline

Iterator service.

Returns:: end iterator

Definition at line 210 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myEnd.

Referenced by DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::c(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rbegin().

      {
        return ConstIterator ( myEnd );
      }

template<typename TConstIterator , typename DistanceFunctor >

bool DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::isValid ( ) const

inline

Checks the validity/consistency of the object.

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

Definition at line 138 of file SimpleRandomAccessConstRangeFromPoint.h.

      {
        return true;
      }

template<typename TConstIterator , typename DistanceFunctor >

SimpleRandomAccessConstRangeFromPoint& DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::operator= ( const SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor > & other )

inline

Assignment.

Parameters:

other the iterator to copy.

Returns:: a reference on 'this'.

Definition at line 117 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myBegin, DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myDistance, and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myEnd.

      {
        if ( this != &other )
        {
          myBegin = other.myBegin;
          myEnd = other.myEnd;
          myDistance = other.myDistance;
        }
        return *this;
      }

template<typename TConstIterator , typename DistanceFunctor >

ConstReverseIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rbegin ( ) const

inline

Iterator service.

Returns:: rbegin iterator

Definition at line 219 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::end().

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

template<typename TConstIterator , typename DistanceFunctor >

ConstReverseIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rbegin ( const Point & aPoint ) const

inline

Iterator service.

Returns:: rbegin iterator

Definition at line 228 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::end(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myDistance.

      {
        return ConstReverseIterator ( this->end() + myDistance ( aPoint ) );
      }

template<typename TConstIterator , typename DistanceFunctor >

ConstReverseCirculator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rc ( ) const

inline

Circulator service.

Returns:: a reverse circulator

Definition at line 256 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::c().

      {
        return ConstReverseCirculator ( this->c() );
      }

template<typename TConstIterator , typename DistanceFunctor >

ConstReverseIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rend ( ) const

inline

Iterator service.

Returns:: rend iterator

Definition at line 238 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::begin().

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

template<typename TConstIterator , typename DistanceFunctor >

void DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::selfDisplay ( std::ostream & out ) const

inline

Writes/Displays the object on an output stream.

Parameters:

out	the output stream where the object is written.

Definition at line 148 of file SimpleRandomAccessConstRangeFromPoint.h.

References DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myBegin, and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myEnd.

      {
        typedef typename IteratorCirculatorTraits<ConstIterator>::Value Value;
        out << "[SimpleRandomAccessConstRangeFromPoint]" << std::endl;
        out << "\t";
        std::copy ( myBegin, myEnd, ostream_iterator<Value> ( out, ", " ) );
        out << std::endl;
      }

Field Documentation

template<typename TConstIterator , typename DistanceFunctor >

TConstIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myBegin

private

Begin underlying iterator

Definition at line 172 of file SimpleRandomAccessConstRangeFromPoint.h.

Referenced by DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::begin(), DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::operator=(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::selfDisplay().

template<typename TConstIterator , typename DistanceFunctor >

DistanceFunctor DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myDistance

private

Underlying distance function

Definition at line 181 of file SimpleRandomAccessConstRangeFromPoint.h.

Referenced by DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::begin(), DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::operator=(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::rbegin().

template<typename TConstIterator , typename DistanceFunctor >

TConstIterator DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::myEnd

private

End underlying iterator

Definition at line 176 of file SimpleRandomAccessConstRangeFromPoint.h.

Referenced by DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::end(), DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::operator=(), and DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >::selfDisplay().

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

SimpleRandomAccessConstRangeFromPoint.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename TConstIterator, typename DistanceFunctor> class DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<typename TConstIterator, typename DistanceFunctor>
class DGtal::SimpleRandomAccessConstRangeFromPoint< TConstIterator, DistanceFunctor >