Vertices are created and managed by Graphs. More...

#include <graph/graph/vertex.h>

Inheritance diagram for Vertex:

[legend]

Collaboration diagram for Vertex:

[legend]

Public Types
typedef ESet::value_type	value_type

typedef ESet::pointer	pointer
	pointer is absent from MS Visual C++ / Intel Win32

typedef ESet::reference	reference

typedef ESet::const_reference	const_reference

typedef ESet::iterator	iterator

typedef ESet::const_iterator	const_iterator

typedef ESet::reverse_iterator	reverse_iterator

typedef ESet::const_reverse_iterator	const_reverse_iterator

Public Types inherited from carto::SyntaxedObject< PropertySet >
typedef internal::SyntaxedObjectSwitch< T, SUPERSUBCLASS(Interface, T)>::ContentType	ContentType

Public Member Functions
Iterators iterate on the edges
iterator	begin ()
	Get the beginning of the edge collection.

iterator	end ()
	Get the end of the edge collection.

const_iterator	begin () const
	Get the beginning of the edge collection.

const_iterator	end () const
	Get the end of the edge collection.

reverse_iterator	rbegin ()
	Get the beginning of the reversed edge collection.

reverse_iterator	rend ()
	Get the end of the reversed edge collection.

const_reverse_iterator	rbegin () const
	Get the beginning of the reversed edge collection.

const_reverse_iterator	rend () const
	Get the end of the reversed edge collection.

Neighbours
std::set< Vertex * >	neighbours () const
	Same as outNeighbours.

std::set< Vertex * >	inNeighbours () const
	Find the vertices for which this vertex is the sink.

std::set< Vertex * >	outNeighbours () const
	Find the vertices for which this vertex is the source.

Vertex *	randomNeighbour () const
	Return a random neighbour (CAUTION!

virtual std::string	type () const CARTO_OVERRIDE

virtual	~GraphObject ()

Public Member Functions inherited from carto::SyntaxedObject< PropertySet >
	SyntaxedObject (const std::string &s)

	SyntaxedObject (const SyntaxedObject &x)

	SyntaxedObject (const SyntaxedObject< PropertySet > &x)

	SyntaxedObject (const std::string &s)

	SyntaxedObject (const SyntaxedObject &x)

	SyntaxedObject (const SyntaxedObject< PropertySet > &x)

Friends
Friends
class	Graph
	export addEdge and removeEdge

class	GraphFactory
	export the constructors

Constructors, destructor
virtual	~Vertex ()

	Vertex (std::string s)
	The programmer should not call the constructor.

	Vertex (const Vertex &x)
	The programmer should not call the copy constructor.

virtual Vertex *	cloneVertex () const
	The programmer should not clone.

Edge handling
size_t	size () const __attribute__((__deprecated__("use edgesSize() for " "the number of edges. In a future release

size_t	size () will return the " "number properties as it does in GenericObject")))

size_t	edgesSize () const
	The edgesSize of a vertex is the number of attached edges.

bool	hasEdge (const Edge *edge) const
	Is a given edge attached to this vertex?

std::set< Edge * >	edgesTo (const Vertex *vertex) const
	Returns the edges linking this vertex to a given vertex.

Additional Inherited Members
	GraphObject (const std::string &s)
	The programmer should not call the constructor of an abstract base class.

	GraphObject (const GraphObject &x)

Detailed Description

Vertices are created and managed by Graphs.

See Graph for vertex creation.

Definition at line 63 of file vertex.h.

Member Typedef Documentation

◆ const_iterator

typedef ESet::const_iterator Vertex::const_iterator

Definition at line 79 of file vertex.h.

◆ const_reference

typedef ESet::const_reference Vertex::const_reference

Definition at line 77 of file vertex.h.

◆ const_reverse_iterator

typedef ESet::const_reverse_iterator Vertex::const_reverse_iterator

Definition at line 81 of file vertex.h.

◆ iterator

typedef ESet::iterator Vertex::iterator

Definition at line 78 of file vertex.h.

◆ pointer

typedef ESet::pointer Vertex::pointer

pointer is absent from MS Visual C++ / Intel Win32

Definition at line 74 of file vertex.h.

◆ reference

typedef ESet::reference Vertex::reference

Definition at line 76 of file vertex.h.

◆ reverse_iterator

typedef ESet::reverse_iterator Vertex::reverse_iterator

Definition at line 80 of file vertex.h.

◆ value_type

typedef ESet::value_type Vertex::value_type

Definition at line 71 of file vertex.h.

Constructor & Destructor Documentation

◆ ~Vertex()

virtual Vertex::~Vertex ( )

virtual

◆ Vertex() [1/2]

Vertex::Vertex ( std::string s )

protected

The programmer should not call the constructor.

Parameters

s	syntactic attribute of the new vertex

See also: Graph for creating vertices

Referenced by cloneVertex(), edgesTo(), GraphFactory, randomNeighbour(), and Vertex().

◆ Vertex() [2/2]

Vertex::Vertex ( const Vertex & x )

protected

The programmer should not call the copy constructor.

Parameters

x	vertex to clone

See also: Graph for creating vertices

References Vertex().

Member Function Documentation

◆ begin() [1/2]

Vertex::iterator Vertex::begin ( )

inline

Get the beginning of the edge collection.

Returns: an iterator pointing to the beginning of the edge collection

Definition at line 297 of file vertex.h.

Referenced by edgesTo().

◆ begin() [2/2]

Vertex::const_iterator Vertex::begin ( ) const

inline

Get the beginning of the edge collection.

Returns: a const_iterator pointing to the beginning of the edge collection

Definition at line 313 of file vertex.h.

◆ cloneVertex()

virtual Vertex * Vertex::cloneVertex ( ) const

protectedvirtual

The programmer should not clone.

Returns: a copy of this vertex

See also: Graph for creating vertices

References Vertex().

◆ edgesSize()

size_t Vertex::edgesSize ( ) const

The edgesSize of a vertex is the number of attached edges.

Returns: the number of edges attached to the vertex

◆ edgesTo()

std::set< Edge * > Vertex::edgesTo ( const Vertex * vertex ) const

Returns the edges linking this vertex to a given vertex.

Parameters

vertex is the sink vertex

Returns: the set of vertices for which this vertex is the source and vertex is the sink

References begin(), end(), neighbours(), rbegin(), rend(), and Vertex().

◆ end() [1/2]

Vertex::iterator Vertex::end ( )

inline

Get the end of the edge collection.

Returns: an iterator pointing to the end of the edge collection

Definition at line 305 of file vertex.h.

Referenced by edgesTo().

◆ end() [2/2]

Vertex::const_iterator Vertex::end ( ) const

inline

Get the end of the edge collection.

Returns: a const_iterator pointing to the end of the edge collection

Definition at line 321 of file vertex.h.

◆ hasEdge()

bool Vertex::hasEdge ( const Edge * edge ) const

Is a given edge attached to this vertex?

Parameters

edge	tested edge

Returns: true if the edge is attached to this vertex

◆ inNeighbours()

std::set< Vertex * > Vertex::inNeighbours ( ) const

Find the vertices for which this vertex is the sink.

Returns: the set of vertices for which this vertex is the sink

◆ neighbours()

std::set< Vertex * > Vertex::neighbours ( ) const

inline

Same as outNeighbours.

Still don't know why it works with directed edges!

Definition at line 361 of file vertex.h.

References outNeighbours().

Referenced by edgesTo().

◆ outNeighbours()

std::set< Vertex * > Vertex::outNeighbours ( ) const

Find the vertices for which this vertex is the source.

Returns: the set of vertices for which this vertex is the source

Referenced by neighbours().

◆ randomNeighbour()

Vertex * Vertex::randomNeighbour ( ) const

Return a random neighbour (CAUTION!

not perfectly random)

Returns: a random neighbour

References Vertex().

◆ rbegin() [1/2]

Vertex::reverse_iterator Vertex::rbegin ( )

inline

Get the beginning of the reversed edge collection.

Returns: a reverse_iterator pointing to the beginning of the reversed edge collection

Definition at line 329 of file vertex.h.

Referenced by edgesTo().

◆ rbegin() [2/2]

Vertex::const_reverse_iterator Vertex::rbegin ( ) const

inline

Get the beginning of the reversed edge collection.

Returns: a const_reverse_iterator pointing to the end of the reversed edge collection

Definition at line 345 of file vertex.h.

◆ rend() [1/2]

Vertex::reverse_iterator Vertex::rend ( )

inline

Get the end of the reversed edge collection.

Returns: a reverse_iterator pointing to the end of the reversed edge collection

Definition at line 337 of file vertex.h.

Referenced by edgesTo().

◆ rend() [2/2]

Vertex::const_reverse_iterator Vertex::rend ( ) const

inline

Get the end of the reversed edge collection.

Returns: a const_reverse_iterator pointing to the end of the reversed edge collection

Definition at line 353 of file vertex.h.

◆ size() [1/2]

size_t Vertex::size ( ) const

Deprecated

◆ size() [2/2]

size_t Vertex::size ( )

◆ type()

virtual std::string Vertex::type ( ) const

inlinevirtual

Definition at line 210 of file vertex.h.

Friends And Related Symbol Documentation

◆ Graph

friend class Graph

friend

export addEdge and removeEdge

Definition at line 248 of file vertex.h.

References Graph.

Referenced by Graph.

◆ GraphFactory

friend class GraphFactory

friend

export the constructors

Definition at line 250 of file vertex.h.

References GraphFactory, and Vertex().

Referenced by GraphFactory.

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

graph/graph/vertex.h

Public Types

Public Member Functions

Friends

Constructors, destructor

Edge handling

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reference

◆ const_reverse_iterator

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ value_type

Constructor & Destructor Documentation

◆ ~Vertex()

◆ Vertex() [1/2]

◆ Vertex() [2/2]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ cloneVertex()

◆ edgesSize()

◆ edgesTo()

◆ end() [1/2]

◆ end() [2/2]

◆ hasEdge()

◆ inNeighbours()

◆ neighbours()

◆ outNeighbours()

◆ randomNeighbour()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ type()

Friends And Related Symbol Documentation

◆ Graph

◆ GraphFactory