Graph::EdgeAroundVertexCirculator Class Reference

This class circulates through all edges connected with a vertex. It also acts as a container-concept for C++11 range-based for loops. More...

#include <graph.h>

Public Member Functions
	EdgeAroundVertexCirculator (const Graph *g, Vertex v=Vertex())
	Default constructor.
bool	operator== (const EdgeAroundVertexCirculator &rhs) const
	Equality operator.
bool	operator!= (const EdgeAroundVertexCirculator &rhs) const
	Inequality operator.
EdgeAroundVertexCirculator &	operator++ ()
	Pre-increment circulator.
EdgeAroundVertexCirculator &	operator-- ()
	Pre-decrement circulator.
Edge	operator* () const
	Get the edge the circulator refers to.
	operator bool () const
	Cast to bool: true if vertex is not isolated.
Vertex	vertex () const
	Return current vertex.
EdgeAroundVertexCirculator &	begin ()
	Helper for C++11 range-based for-loops.
EdgeAroundVertexCirculator &	end ()
	Helper for C++11 range-based for-loops.

Detailed Description

This class circulates through all edges connected with a vertex. It also acts as a container-concept for C++11 range-based for loops.

See also

VertexAroundVertexCirculator, edges(Vertex)

Examples

Tutorial_109_Graph_Connectivity/main.cpp.

Constructor & Destructor Documentation

EdgeAroundVertexCirculator()

EdgeAroundVertexCirculator ( const Graph *  g, Vertex  v = Vertex()  )

inlineexplicit

Default constructor.

Parameters

g	The graph.
v	The vertex.

Member Function Documentation

operator bool()

operator bool ( ) const

inline

Cast to bool: true if vertex is not isolated.

Returns

True if vertex is not isolated, false otherwise.

operator!=()

bool operator!= ( const EdgeAroundVertexCirculator &  rhs ) const

inline

Inequality operator.

Parameters

rhs	The other circulator to compare with.

Returns

True if the circulators are different, false otherwise.

operator*()

Edge operator* ( ) const

inline

Get the edge the circulator refers to.

Returns

The edge.

operator++()

EdgeAroundVertexCirculator & operator++ ( )

inline

Pre-increment circulator.

Returns

A reference to the incremented circulator.

operator--()

EdgeAroundVertexCirculator & operator-- ( )

inline

Pre-decrement circulator.

Returns

A reference to the decremented circulator.

operator==()

bool operator== ( const EdgeAroundVertexCirculator &  rhs ) const

inline

Equality operator.

Parameters

rhs	The other circulator to compare with.

Returns

True if the circulators are equal, false otherwise.

vertex()

Vertex vertex ( ) const

inline

Return current vertex.

Returns

The vertex.

---

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

• easy3d/core/graph.h