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

Aim: models of CVertexMap concept implement mapping between graph vertices and values. More...

#include <DGtal/graph/CVertexMap.h>

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

Public Types
typedef T::Vertex	Vertex
typedef T::Value	Value

Public Member Functions
	BOOST_CONCEPT_USAGE (CVertexMap)

Private Attributes
T	myX
Vertex	myVertex
Value	myValue

Detailed Description

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

Aim: models of CVertexMap concept implement mapping between graph vertices and values.

Description of concept 'CVertexMap'

This concept is associated with concepts related to graph in DGtal (CUndirectedSimpleLocalGraph and CUndirectedSimpleGraph). Associates a value to each vertex of a graph.

Associated types

• Vertex : specifies the type for an element of the domain (inner type).
• Value : specifies the type for a value (inner type).

Notation

• X : A type that is a model of CVertexMap
• x : Object of type X
• v : Object of type Vertex
• val : Object of type Value

Definitions

Valid expressions and

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Set value	x.setValue(vertex, val)	vertex of type Vertex and val of type Value	void		set a given value val to a given vertex v
Accessor	x(vertex)	vertex of type Vertex	Value		Access to the value at vertex

Invariants

Models

• ImageContainerBySTLVector, ImageContainerBySTLMap, ImageContainerByITKImage, ImageContainerByHashTree
• Any adapted type from STLMapToVertexMapAdapter
  

Notes

Definition at line 96 of file CVertexMap.h.

Member Typedef Documentation

Value

template<typename T >

typedef T::Value DGtal::concepts::CVertexMap< T >::Value

Definition at line 103 of file CVertexMap.h.

Vertex

template<typename T >

typedef T::Vertex DGtal::concepts::CVertexMap< T >::Vertex

Definition at line 102 of file CVertexMap.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 106 of file CVertexMap.h.

    {
      ConceptUtils::sameType( myValue, myX.operator()(myVertex) );
      myX.setValue(myVertex, myValue);
    }

References DGtal::concepts::CVertexMap< T >::myValue, DGtal::concepts::CVertexMap< T >::myVertex, DGtal::concepts::CVertexMap< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

myValue

template<typename T >

Value DGtal::concepts::CVertexMap< T >::myValue

private

Definition at line 116 of file CVertexMap.h.

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

myVertex

template<typename T >

Vertex DGtal::concepts::CVertexMap< T >::myVertex

private

Definition at line 115 of file CVertexMap.h.

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

myX

template<typename T >

T DGtal::concepts::CVertexMap< T >::myX

private

Definition at line 114 of file CVertexMap.h.

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

---

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

• CVertexMap.h