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

Aim: Represents types for which a std::back_insert_iterator can be constructed with std::back_inserter. Back Insertion Sequence are refinements of CBackInsertable. They require more services than CBackInsertable, for instance read services or erase services. More...

#include <DGtal/base/CBackInsertable.h>

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

Public Types
typedef T::value_type	value_type

Public Member Functions
	BOOST_CONCEPT_USAGE (CBackInsertable)
void	checkConstConstraints () const

Private Attributes
T	myX
value_type	myV

Detailed Description

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

Aim: Represents types for which a std::back_insert_iterator can be constructed with std::back_inserter. Back Insertion Sequence are refinements of CBackInsertable. They require more services than CBackInsertable, for instance read services or erase services.

Description of concept 'CBackInsertable'

Refinement of

Associated types

• value_type: the type of object that can be inserted at the back.

Notation

• X : A type that is a model of CBackInsertable
• x : object of type X
• e : object of type value_type

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Add to back	x.push_back( e )				adds the element e at the end of object x

Invariants

Models

• Most standard linear containers: std::vector, std::list, std::deque
• CPositiveIrreducibleFraction is a refinement of CBackInsertable
• hence fractions: SternBrocot::Fraction, LighterSternBrocot::Fraction, LightSternBrocot::Fraction

Notes

Template Parameters

T	the type that should be a model of CBackInsertable.

Definition at line 94 of file CBackInsertable.h.

Member Typedef Documentation

value_type

template<typename T >

typedef T::value_type DGtal::concepts::CBackInsertable< T >::value_type

Definition at line 98 of file CBackInsertable.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 99 of file CBackInsertable.h.

      {
        myX.push_back( myV );
        checkConstConstraints();
      }

References DGtal::concepts::CBackInsertable< T >::checkConstConstraints(), DGtal::concepts::CBackInsertable< T >::myV, and DGtal::concepts::CBackInsertable< T >::myX.

checkConstConstraints()

template<typename T >

void DGtal::concepts::CBackInsertable< T >::checkConstConstraints ( ) const

inline

Definition at line 104 of file CBackInsertable.h.

      {
      }

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

Field Documentation

myV

template<typename T >

value_type DGtal::concepts::CBackInsertable< T >::myV

private

Definition at line 110 of file CBackInsertable.h.

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

myX

template<typename T >

T DGtal::concepts::CBackInsertable< T >::myX

private

Definition at line 109 of file CBackInsertable.h.

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

---

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

• CBackInsertable.h