sgm::Graph_Interface::EdgeDescriptor Class Reference

#include <Graph_Interface.hh>

Inheritance diagram for sgm::Graph_Interface::EdgeDescriptor:

Public Member Functions
virtual EdgeDescriptor *	clone () const =0
	EdgeDescriptor ()
	Default Construction. More...
	EdgeDescriptor (const Graph_Interface::IndexType &from, const Graph_Interface::IndexType &to)
virtual const std::string &	getEdgeLabel (void) const =0
const Graph_Interface::IndexType &	getFromIndex (void) const
const Graph_Interface::IndexType &	getToIndex (void) const
virtual bool	operator!= (const EdgeDescriptor &ed) const =0
virtual EdgeDescriptor &	operator++ ()=0
virtual bool	operator== (const EdgeDescriptor &ed) const
virtual	~EdgeDescriptor ()
	Destruction. More...

Protected Attributes
Graph_Interface::IndexType	from
	the source of the edge described More...
Graph_Interface::IndexType	to
	the target of the edge described More...

Friends
class	Edge_iterator
class	OutEdge_iterator

Detailed Description

Container that stores the global edge information, i.e. from, to, and the label of the edge.

Definition at line 30 of file Graph_Interface.hh.

Constructor & Destructor Documentation

sgm::Graph_Interface::EdgeDescriptor::EdgeDescriptor

(

)

sgm::Graph_Interface::EdgeDescriptor::EdgeDescriptor	(	const Graph_Interface::IndexType &	from,
		const Graph_Interface::IndexType &	to
	)

Construction

Parameters

from	the source of the edge
to	the target of the edge

virtual sgm::Graph_Interface::EdgeDescriptor::~EdgeDescriptor ( )

virtual

Reimplemented in sgm::Graph_boostV_p< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, and sgm::SubGraph::EdgeDescriptor.

Member Function Documentation

virtual EdgeDescriptor* sgm::Graph_Interface::EdgeDescriptor::clone ( ) const

pure virtual

Create a heap copy of this object. NOTE: this has to be removed by the calling function.

Returns

a new heap copy of this object

Implemented in sgm::Graph_boostV_p< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, and sgm::SubGraph::EdgeDescriptor.

virtual const std::string& sgm::Graph_Interface::EdgeDescriptor::getEdgeLabel ( void  ) const

pure virtual

Access to the label of the edge.

Returns

the edge label

Implemented in sgm::Graph_boostV_p< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, and sgm::SubGraph::EdgeDescriptor.

const Graph_Interface::IndexType& sgm::Graph_Interface::EdgeDescriptor::getFromIndex

(

void

)

const

Access to the source of the edge.

Returns

the global source node index

const Graph_Interface::IndexType& sgm::Graph_Interface::EdgeDescriptor::getToIndex

(

void

)

const

Access to the target of the edge.

Returns

the global target node index

virtual bool sgm::Graph_Interface::EdgeDescriptor::operator!= ( const EdgeDescriptor &  ed ) const

pure virtual

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

Implemented in sgm::Graph_boostV_p< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, and sgm::SubGraph::EdgeDescriptor.

virtual EdgeDescriptor& sgm::Graph_Interface::EdgeDescriptor::operator++ ( )

pure virtual

Iterator support

Returns

the next EdgeDescriptor in the adjacency

Implemented in sgm::Graph_boostV_p< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor, and sgm::SubGraph::EdgeDescriptor.

virtual bool sgm::Graph_Interface::EdgeDescriptor::operator== ( const EdgeDescriptor &  ed ) const

virtual

Equality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe the same edge

Friends And Related Function Documentation

friend class Edge_iterator

friend

Definition at line 48 of file Graph_Interface.hh.

friend class OutEdge_iterator

friend

Definition at line 50 of file Graph_Interface.hh.

Field Documentation

Graph_Interface::IndexType sgm::Graph_Interface::EdgeDescriptor::from

protected

Definition at line 53 of file Graph_Interface.hh.

Graph_Interface::IndexType sgm::Graph_Interface::EdgeDescriptor::to

protected

Definition at line 55 of file Graph_Interface.hh.

---

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

• src/sgm/Graph_Interface.hh