DGtal  1.5.beta
DGtal::concepts::CConstSinglePassRange< T > Struct Template Reference

Aim: Defines the concept describing a const single pass range. More...

#include <DGtal/base/CConstSinglePassRange.h>

Inheritance diagram for DGtal::concepts::CConstSinglePassRange< T >:
[legend]

Public Types

typedef T::ConstIterator ConstIterator
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((boost_concepts::SinglePassIteratorConcept< ConstIterator >))
 
 BOOST_CONCEPT_USAGE (CConstSinglePassRange)
 
void checkConstConstraints () const
 

Private Attributes

i
 
ConstIterator it
 

Detailed Description

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

Aim: Defines the concept describing a const single pass range.

Description of concept 'CConstSinglePassRange'

Template Parameters
Tthe type that should be a model of CConstSinglePassRange.

Refinement of

Associated types

Notation

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
begin of range x.begin() ConstIterator returns a forward iterator on the beginning of the range
end of range x.end() ConstIterator returns a forward iterator after the end of the range

Invariants

  • Valid range. For any Range x, [x.begin(), x.end()) is a valid range, that is, x.end() is reachable from x.begin() in a finite number of increments.
  • Completeness. An algorithm that iterates through the range [x.begin(), x.end()) will pass through every element of x.

Models

Definition at line 92 of file CConstSinglePassRange.h.

Member Typedef Documentation

◆ ConstIterator

template<typename T >
typedef T::ConstIterator DGtal::concepts::CConstSinglePassRange< T >::ConstIterator

Definition at line 96 of file CConstSinglePassRange.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename T >
DGtal::concepts::CConstSinglePassRange< T >::BOOST_CONCEPT_ASSERT ( (boost_concepts::SinglePassIteratorConcept< ConstIterator >)  )

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CConstSinglePassRange< T >::BOOST_CONCEPT_USAGE ( CConstSinglePassRange< T >  )
inline

◆ checkConstConstraints()

Field Documentation

◆ i

template<typename T >
T DGtal::concepts::CConstSinglePassRange< T >::i
private

◆ it


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