DGtal::CUndirectedSimpleGraph< T > Struct Template Reference

#include <CUndirectedSimpleGraph.h>

Inheritance diagram for DGtal::CUndirectedSimpleGraph< T >:

Collaboration diagram for DGtal::CUndirectedSimpleGraph< T >:

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

Public Member Functions
	BOOST_CONCEPT_USAGE (CUndirectedSimpleGraph)
void	checkConstConstraints () const
Public Member Functions inherited from DGtal::CUndirectedSimpleLocalGraph< T >
	BOOST_CONCEPT_ASSERT ((CInteger< Size >))
	BOOST_CONCEPT_USAGE (CUndirectedSimpleLocalGraph)
Public Member Functions inherited from DGtal::CConstSinglePassRange< T >
	BOOST_CONCEPT_ASSERT ((boost_concepts::SinglePassIteratorConcept< ConstIterator >))
	BOOST_CONCEPT_USAGE (CConstSinglePassRange)

Private Attributes
T	myX
Size	mySize

---

Detailed Description

template<typename T>
struct DGtal::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 :

- Edge: the type for the edges of the graph.

The following types are defined in CSinglePassConstRange

- ConstIterator: const iterator on Vertex

The following types are defined in CUndirectedSimpleLocalGraph

- Size: an integral type to count the number of vertices.
- Vertex: the type for the vertices of the graph.
- VertexSet: the type for storing a set of vertices.
- VertexMap: a rebinding structure to associate Value to vertices of model CVertexMap.

Notation

• X : A type that is a model of CUndirectedSimpleGraph
• x : object of type X
• v : object of type Vertex
• out : an output iterator of type OutputIterator (model of boost::OutputIterator).
• p : a predicate on vertex of type VertexPredicate (model of CVertexPredicate).

Definitions

Valid expressions and

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

Invariants

Models

- DigitalSurface, Object

Notes

Template Parameters:

T	the type that should be a model of CUndirectedSimpleGraph.

Definition at line 121 of file CUndirectedSimpleGraph.h.

---

Member Typedef Documentation

template<typename T >

typedef T::Edge DGtal::CUndirectedSimpleGraph< T >::Edge

Definition at line 132 of file CUndirectedSimpleGraph.h.

template<typename T >

typedef T::Size DGtal::CUndirectedSimpleGraph< T >::Size

Reimplemented from DGtal::CUndirectedSimpleLocalGraph< T >.

Definition at line 133 of file CUndirectedSimpleGraph.h.

---

Member Function Documentation

template<typename T >

DGtal::CUndirectedSimpleGraph< T >::BOOST_CONCEPT_USAGE ( CUndirectedSimpleGraph< T >  )

inline

Definition at line 136 of file CUndirectedSimpleGraph.h.

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

    {
      // check const methods.
      checkConstConstraints();
    }

template<typename T >

void DGtal::CUndirectedSimpleGraph< T >::checkConstConstraints ( ) const

inline

Reimplemented from DGtal::CUndirectedSimpleLocalGraph< T >.

Definition at line 141 of file CUndirectedSimpleGraph.h.

References DGtal::CUndirectedSimpleGraph< T >::mySize, DGtal::CUndirectedSimpleGraph< T >::myX, and DGtal::ConceptUtils::sameType().

Referenced by DGtal::CUndirectedSimpleGraph< T >::BOOST_CONCEPT_USAGE().

    {
      ConceptUtils::sameType( mySize, myX.size() );
    }

---

Field Documentation

template<typename T >

Size DGtal::CUndirectedSimpleGraph< T >::mySize

private

Reimplemented from DGtal::CUndirectedSimpleLocalGraph< T >.

Definition at line 149 of file CUndirectedSimpleGraph.h.

Referenced by DGtal::CUndirectedSimpleGraph< T >::checkConstConstraints().

template<typename T >

T DGtal::CUndirectedSimpleGraph< T >::myX

private

Reimplemented from DGtal::CUndirectedSimpleLocalGraph< T >.

Definition at line 148 of file CUndirectedSimpleGraph.h.

Referenced by DGtal::CUndirectedSimpleGraph< T >::checkConstConstraints().

---

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

• CUndirectedSimpleGraph.h