DGtal  0.9.3beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CVertexMap< T > Struct Template Reference

#include <DGtal/graph/CVertexMap.h>

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

Public Types

typedef T::Vertex Vertex
 
typedef T::Value Value
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CVertexMap)
 

Private Attributes

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 :

Notation

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

Notes

Definition at line 96 of file CVertexMap.h.

Member Typedef Documentation

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

Definition at line 103 of file CVertexMap.h.

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

Definition at line 102 of file CVertexMap.h.

Member Function Documentation

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

Field Documentation

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().

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().

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: