sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor Class Reference

#include <Graph_boost.hh>

Inheritance diagram for sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor:

Public Member Functions
virtual EdgeDescriptor *	clone () const
	EdgeDescriptor (const typename GRAPH::out_edge_iterator &cur_edge, const typename GRAPH::out_edge_iterator &neigh_end, const Graph_boost &parent)
virtual const std::string &	getEdgeLabel (void) const
const Graph_Interface::IndexType &	getFromIndex (void) const
const Graph_Interface::IndexType &	getToIndex (void) const
virtual bool	operator!= (const EdgeDescriptor &ed) const
virtual bool	operator!= (const Graph_Interface::EdgeDescriptor &ed) const
virtual EdgeDescriptor &	operator++ ()
virtual bool	operator== (const EdgeDescriptor &ed) const
virtual bool	operator== (const EdgeDescriptor &ed) const
virtual	~EdgeDescriptor ()
	Destruction. More...

Protected Attributes
GRAPH::out_edge_iterator	cur_edge
Graph_Interface::IndexType	from
	the source of the edge described More...
GRAPH::out_edge_iterator	list_end
const Graph_boost &	parent
	access to the parent instance for fast graph access More...
Graph_Interface::IndexType	to
	the target of the edge described More...

Detailed Description

template<class GRAPH, typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>
class sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor

Special edge descriptor to enable the iteration over the edges contained in the internally used boost graph instance.

Definition at line 105 of file Graph_boost.hh.

Constructor & Destructor Documentation

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::EdgeDescriptor	(	const typename GRAPH::out_edge_iterator &	cur_edge,
		const typename GRAPH::out_edge_iterator &	neigh_end,
		const Graph_boost &	parent
	)

Construction of a new edge descriptor given the our edge iterators

Parameters

cur_edge	the current boost edge iterator
neigh_end	the end of the edge iteration
parent	access to the parent instance for graph access

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::~EdgeDescriptor ( )

virtual

Reimplemented from sgm::Graph_Interface::EdgeDescriptor.

Member Function Documentation

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual EdgeDescriptor* sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::clone ( ) const

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

Implements sgm::Graph_Interface::EdgeDescriptor.

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual const std::string& sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::getEdgeLabel ( void  ) const

virtual

Access to the label of the edge.

Returns

the edge label

Implements sgm::Graph_Interface::EdgeDescriptor.

const Graph_Interface::IndexType& sgm::Graph_Interface::EdgeDescriptor::getFromIndex ( void  ) const

inherited

Access to the source of the edge.

Returns

the global source node index

const Graph_Interface::IndexType& sgm::Graph_Interface::EdgeDescriptor::getToIndex ( void  ) const

inherited

Access to the target of the edge.

Returns

the global target node index

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual bool sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::operator!= ( const EdgeDescriptor &  ed ) const

virtual

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual bool sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::operator!= ( const Graph_Interface::EdgeDescriptor &  ed ) const

virtual

Inequality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe different edges

Implements sgm::Graph_Interface::EdgeDescriptor.

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual EdgeDescriptor& sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::operator++ ( )

virtual

Iterator support

Returns

the next EdgeDescriptor in the adjacency

Implements sgm::Graph_Interface::EdgeDescriptor.

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

virtualinherited

Equality comparison

Parameters

ed	the edge to compare to

Returns

true if both descriptors describe the same edge

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

virtual bool sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::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

Field Documentation

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

GRAPH::out_edge_iterator sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::cur_edge

protected

the out edge iterator of the current target node within the local adjacency list

Definition at line 113 of file Graph_boost.hh.

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

protectedinherited

Definition at line 53 of file Graph_Interface.hh.

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

GRAPH::out_edge_iterator sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::list_end

protected

the edge iterator that marks the end of the local adjacency list

Definition at line 116 of file Graph_boost.hh.

template<class GRAPH , typename NODE_LABEL_PROPERTY = boost::vertex_name_t, typename EDGE_LABEL_PROPERTY = boost::edge_name_t, typename NODE_INDEX_PROPERTY = boost::vertex_index_t>

const Graph_boost& sgm::Graph_boost< GRAPH, NODE_LABEL_PROPERTY, EDGE_LABEL_PROPERTY, NODE_INDEX_PROPERTY >::EdgeDescriptor::parent

protected

Definition at line 119 of file Graph_boost.hh.

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

protectedinherited

Definition at line 55 of file Graph_Interface.hh.

---

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

• src/sgm/Graph_boost.hh