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

#include <DGtal/graph/CUndirectedSimpleGraph.h>

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

Public Types

typedef T::Edge Edge
 
typedef T::Size Size
 
- Public Types inherited from DGtal::concepts::CUndirectedSimpleLocalGraph< T >
typedef T::Vertex Vertex
 
typedef T::Size Size
 
typedef T::VertexSet VertexSet
 
- Public Types inherited from DGtal::concepts::CConstSinglePassRange< T >
typedef T::ConstIterator ConstIterator
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CUndirectedSimpleGraph)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CUndirectedSimpleLocalGraph< T >
 BOOST_CONCEPT_ASSERT ((CIntegralNumber< Size >))
 
 BOOST_CONCEPT_ASSERT ((boost::DefaultConstructible< Vertex >))
 
 BOOST_CONCEPT_ASSERT ((boost::Assignable< Vertex >))
 
 BOOST_CONCEPT_ASSERT ((boost::CopyConstructible< Vertex >))
 
 BOOST_CONCEPT_USAGE (CUndirectedSimpleLocalGraph)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CConstSinglePassRange< T >
 BOOST_CONCEPT_ASSERT ((boost_concepts::SinglePassIteratorConcept< ConstIterator >))
 
 BOOST_CONCEPT_USAGE (CConstSinglePassRange)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
Size mySize
 

Detailed Description

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

Aim: Represents the concept of local graph: each vertex has neighboring vertices, but we do not necessarily know all the vertices.

Description of concept 'CUndirectedSimpleGraph'

Refinement of

CUndirectedSimpleLocalGraph, CSinglePassConstRange

Associated types :

The following types are defined in CSinglePassConstRange

The following types are defined in CUndirectedSimpleLocalGraph

Notation

Definitions

Valid expressions and

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Size x.size() Size Returns the number of vertices of this graph

Invariants

Models

DigitalSurface, Object

Notes

Template Parameters
Tthe type that should be a model of CUndirectedSimpleGraph.
Examples:
graph/graphTraversal.cpp.

Definition at line 102 of file CUndirectedSimpleGraph.h.

Member Typedef Documentation

template<typename T >
typedef T::Edge DGtal::concepts::CUndirectedSimpleGraph< T >::Edge

Definition at line 109 of file CUndirectedSimpleGraph.h.

template<typename T >
typedef T::Size DGtal::concepts::CUndirectedSimpleGraph< T >::Size

Definition at line 110 of file CUndirectedSimpleGraph.h.

Member Function Documentation

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

Definition at line 113 of file CUndirectedSimpleGraph.h.

References DGtal::concepts::CUndirectedSimpleGraph< T >::checkConstConstraints().

114  {
115  // check const methods.
117  }
template<typename T >
void DGtal::concepts::CUndirectedSimpleGraph< T >::checkConstConstraints ( ) const
inline

Field Documentation

template<typename T >
Size DGtal::concepts::CUndirectedSimpleGraph< T >::mySize
private
template<typename T >
T DGtal::concepts::CUndirectedSimpleGraph< T >::myX
private

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