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

#include <DGtal/graph/CUndirectedSimpleLocalGraph.h>

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

[legend]

Data Structures
struct	VertexMap

Public Types
typedef T::Vertex	Vertex

typedef T::Size	Size

typedef T::VertexSet	VertexSet

Public Member Functions
	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

Private Attributes
T	myX

Size	mySize

Vertex	myVertex

boost::output_iterator_archetype< Vertex >	myOutIt

CVertexPredicateArchetype< Vertex >	myVPred

Detailed Description

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

Refinement of

Associated types

Size: an integral type to count the number of vertices.
Vertex: the type for the vertices of the graph (a model of boost::DefaultConstructible, boost::Assignable, boost::CopyConstructible).
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 CUndirectedSimpleLocalGraph
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 semantics

Name	Expression	Return type	Semantics
Degree	x.degree(v)	Size	Returns the degree of vertex `v`
Capacity	x.bestCapacity()	Size	Returns the approximate number of neighbors to be expected. Useful to prepare data structures.
Neighbourhood	x.writeNeighbors<OutputIterator>( out, v )		Writes with the output iterator `out` the neighboring vertices of `v`.
Neighborhood	x.writeNeighbors<OutputIterator,VertexPredicate>( out, v, p )		Writes with the output iterator `out` the neighboring vertices of `v` that satisfy the predicate `p`.

Invariants

Models

Notes

Template Parameters

T	the type that should be a model of CUndirectedSimpleLocalGraph.

Definition at line 100 of file CUndirectedSimpleLocalGraph.h.

Member Typedef Documentation

◆ Size

template<typename T >

typedef T::Size DGtal::concepts::CUndirectedSimpleLocalGraph< T >::Size

Definition at line 106 of file CUndirectedSimpleLocalGraph.h.

◆ Vertex

template<typename T >

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

Definition at line 105 of file CUndirectedSimpleLocalGraph.h.

◆ VertexSet

template<typename T >

typedef T::VertexSet DGtal::concepts::CUndirectedSimpleLocalGraph< T >::VertexSet

Definition at line 107 of file CUndirectedSimpleLocalGraph.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/4]

template<typename T >

DGtal::concepts::CUndirectedSimpleLocalGraph< T >::BOOST_CONCEPT_ASSERT ( (boost::Assignable< Vertex >) )

◆ BOOST_CONCEPT_ASSERT() [2/4]

template<typename T >

DGtal::concepts::CUndirectedSimpleLocalGraph< T >::BOOST_CONCEPT_ASSERT ( (boost::CopyConstructible< Vertex >) )

◆ BOOST_CONCEPT_ASSERT() [3/4]

template<typename T >

DGtal::concepts::CUndirectedSimpleLocalGraph< T >::BOOST_CONCEPT_ASSERT ( (boost::DefaultConstructible< Vertex >) )

◆ BOOST_CONCEPT_ASSERT() [4/4]

template<typename T >

DGtal::concepts::CUndirectedSimpleLocalGraph< T >::BOOST_CONCEPT_ASSERT ( (CIntegralNumber< Size >) )

◆ BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 120 of file CUndirectedSimpleLocalGraph.h.

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

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

◆ checkConstConstraints()

template<typename T >

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

inline

Definition at line 125 of file CUndirectedSimpleLocalGraph.h.

       {
         ConceptUtils::sameType( mySize, myX.bestCapacity() );
         ConceptUtils::sameType( mySize, myX.degree( myVertex ) );
         myX.writeNeighbors( myOutIt, myVertex );
         myX.writeNeighbors( myOutIt, myVertex, myVPred );
       }