DGtal::concepts::CSinglePassRangeFromPoint< T > Struct Template Reference

Aim: refined concept of single pass range with a begin() method from a point. More...

#include <DGtal/base/CSinglePassRangeFromPoint.h>

Inheritance diagram for DGtal::concepts::CSinglePassRangeFromPoint< T >:

Public Types
typedef T::Point	Point
Public Types inherited from DGtal::concepts::CSinglePassRange< T >
typedef T::Iterator	Iterator
Public Types inherited from DGtal::concepts::CConstSinglePassRange< T >
typedef T::ConstIterator	ConstIterator
Public Types inherited from DGtal::concepts::CConstSinglePassRangeFromPoint< T >
typedef T::Point	Point

Public Member Functions
	BOOST_CONCEPT_USAGE (CSinglePassRangeFromPoint)
Public Member Functions inherited from DGtal::concepts::CSinglePassRange< T >
	BOOST_CONCEPT_ASSERT ((boost_concepts::SinglePassIteratorConcept< Iterator >))
	BOOST_CONCEPT_USAGE (CSinglePassRange)
Public Member Functions inherited from DGtal::concepts::CConstSinglePassRange< T >
	BOOST_CONCEPT_ASSERT ((boost_concepts::SinglePassIteratorConcept< ConstIterator >))
	BOOST_CONCEPT_USAGE (CConstSinglePassRange)
void	checkConstConstraints () const
Public Member Functions inherited from DGtal::concepts::CConstSinglePassRangeFromPoint< T >
	BOOST_CONCEPT_USAGE (CConstSinglePassRangeFromPoint)
void	checkConstConstraints () const

Private Attributes
T	myX
Point	myPoint
Iterartor	myIt

Detailed Description

template<typename T>
struct DGtal::concepts::CSinglePassRangeFromPoint< T >

Aim: refined concept of single pass range with a begin() method from a point.

Description of concept 'CSinglePassRangeFromPoint'

Refinement of CSinglePassRange and CConstSinglePassRangeFromPoint

Associated types

Notation

• X : A type that is a model of CSinglePassRangeFromPoint
• x, y : object of type X
• Point: A type of Point

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
begin	begin(const Point &aPoint)	aPoint of type Point	Iterator		Returns an iterator on the range first element

Invariants

Models

• ImageContainerBySTLVector::Range

Notes

Template Parameters

T	the type that should be a model of CSinglePassRangeFromPoint.

Definition at line 88 of file CSinglePassRangeFromPoint.h.

Member Typedef Documentation

Point

template<typename T >

typedef T::Point DGtal::concepts::CSinglePassRangeFromPoint< T >::Point

Definition at line 95 of file CSinglePassRangeFromPoint.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CSinglePassRangeFromPoint< T >::BOOST_CONCEPT_USAGE ( CSinglePassRangeFromPoint< T > )

inline

Definition at line 98 of file CSinglePassRangeFromPoint.h.

      {
        ConceptUtils::sameType( myIt, myX.begin( myPoint ) );
      }

References DGtal::concepts::CSinglePassRangeFromPoint< T >::myIt, DGtal::concepts::CSinglePassRangeFromPoint< T >::myPoint, DGtal::concepts::CSinglePassRangeFromPoint< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

myIt

template<typename T >

Iterartor DGtal::concepts::CSinglePassRangeFromPoint< T >::myIt

private

Definition at line 107 of file CSinglePassRangeFromPoint.h.

Referenced by DGtal::concepts::CSinglePassRangeFromPoint< T >::BOOST_CONCEPT_USAGE().

myPoint

template<typename T >

Point DGtal::concepts::CSinglePassRangeFromPoint< T >::myPoint

private

Definition at line 106 of file CSinglePassRangeFromPoint.h.

Referenced by DGtal::concepts::CSinglePassRangeFromPoint< T >::BOOST_CONCEPT_USAGE().

myX

template<typename T >

T DGtal::concepts::CSinglePassRangeFromPoint< T >::myX

private

Definition at line 105 of file CSinglePassRangeFromPoint.h.

Referenced by DGtal::concepts::CSinglePassRangeFromPoint< T >::BOOST_CONCEPT_USAGE().

---

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

• CSinglePassRangeFromPoint.h