. Representation of a graph using adjacency lists. The underlying implementation uses Boost Graph library. This wrapper is introduced to simplify the creation and handling of the graph. More...

#include <boost_serial_graph.h>

Classes
struct	SerialGraphNode
	Class that represents the Node of a graph. More...

Public Types
typedef VertexData	vertex_data_t
	vertex_data_t The type of the vertex data

typedef EdgeData	edge_data_t
	edge_data_t The type of the edge data

typedef SerialGraphNode	vertex_t
	vertex_t The vertex type

typedef GenericLine< vertex_t, EdgeData >	edge_t
	edge_t The edge type

typedef graph_type::edge_iterator	edge_iterator
	edge_iterator Edge iterator

typedef graph_type::adjacency_iterator	adjacency_iterator
	adjacency_iterator Adjacency iterator

Public Member Functions
	BoostSerialGraph (uint_t nvs=0)
	Constructor.

vertex_t &	add_vertex (const VertexData &data)
	Add a vertex to the graph by providing the data.

edge_t &	add_edge (uint_t v1, uint_t v2)
	Add an edge formed by the two given vertices.

const vertex_t &	get_vertex (uint_t i) const
	Access the i-th vertex of the graph.

vertex_t &	get_vertex (uint_t i)
	Access the i-th vertex of the graph.

vertex_t &	get_vertex (adjacency_iterator itr)
	Access the vertex given the vertex descriptor This is needed when accessing the vertices using the adjacency_iterator.

const vertex_t &	get_vertex (adjacency_iterator itr) const
	Access the vertex given the vertex descriptor This is needed when accessing the vertices using the adjacency_iterator.

const edge_t &	get_edge (uint_t v1, uint_t v2) const
	Access the i-th edge of the graph with endpoints the given vertices.

edge_t &	get_edge (uint_t v1, uint_t v2)
	Access the i-th edge of the graph with endpoints the given vertices.

std::pair< edge_iterator, edge_iterator >	edges () const
	edges Access the edges of the tree

std::pair< adjacency_iterator, adjacency_iterator >	get_vertex_neighbors (uint_t id) const
	Returns the neighboring vertices for the given vertex id.

std::pair< adjacency_iterator, adjacency_iterator >	get_vertex_neighbors (const vertex_t &v) const
	Returns the neighboring vertices for the given vertex id.

std::vector< uint_t >	get_vertex_neighbors_ids (uint_t id) const
	get_vertex_neighbors_ids Returns the ids of the vertices connectected with this vertex

uint_t	n_vertices () const
	Returns the number of vertices.

uint_t	max_vertex_index () const noexcept
	Returns the maximum vertex index.

uint_t	n_edges () const
	Returns the number of edges.

uint_t	max_edge_index () const noexcept
	Returns the maximum edge index.

void	clear ()
	Clear the graph.

Detailed Description

template<typename VertexData, typename EdgeData>
class bitrl::utils::BoostSerialGraph< VertexData, EdgeData >

. Representation of a graph using adjacency lists. The underlying implementation uses Boost Graph library. This wrapper is introduced to simplify the creation and handling of the graph.

Member Typedef Documentation

◆ adjacency_iterator

template<typename VertexData , typename EdgeData >

typedef graph_type::adjacency_iterator bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::adjacency_iterator

adjacency_iterator Adjacency iterator

◆ edge_data_t

template<typename VertexData , typename EdgeData >

typedef EdgeData bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::edge_data_t

edge_data_t The type of the edge data

◆ edge_iterator

template<typename VertexData , typename EdgeData >

typedef graph_type::edge_iterator bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::edge_iterator

edge_iterator Edge iterator

◆ edge_t

template<typename VertexData , typename EdgeData >

typedef GenericLine<vertex_t, EdgeData> bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::edge_t

edge_t The edge type

◆ vertex_data_t

template<typename VertexData , typename EdgeData >

typedef VertexData bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::vertex_data_t

vertex_data_t The type of the vertex data

◆ vertex_t

template<typename VertexData , typename EdgeData >

typedef SerialGraphNode bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::vertex_t

vertex_t The vertex type

Constructor & Destructor Documentation

◆ BoostSerialGraph()

template<typename VertexData , typename EdgeData >

bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::BoostSerialGraph ( uint_t nvs = 0 )

explicit

Constructor.

Member Function Documentation

◆ add_edge()

template<typename VertexData , typename EdgeData >

BoostSerialGraph< VertexData, EdgeData >::edge_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::add_edge	(	uint_t	v1,
		uint_t	v2
	)

Add an edge formed by the two given vertices.

◆ add_vertex()

template<typename VertexData , typename EdgeData >

BoostSerialGraph< VertexData, EdgeData >::vertex_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::add_vertex ( const VertexData & data )

Add a vertex to the graph by providing the data.

◆ clear()

template<typename VertexData , typename EdgeData >

void bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::clear ( )

inline

Clear the graph.

◆ edges()

template<typename VertexData , typename EdgeData >

std::pair< typename BoostSerialGraph< VertexData, EdgeData >::edge_iterator, typename BoostSerialGraph< VertexData, EdgeData >::edge_iterator > bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::edges ( ) const

edges Access the edges of the tree

◆ get_edge() [1/2]

template<typename VertexData , typename EdgeData >

BoostSerialGraph< VertexData, EdgeData >::edge_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_edge	(	uint_t	v1,
		uint_t	v2
	)

Access the i-th edge of the graph with endpoints the given vertices.

◆ get_edge() [2/2]

template<typename VertexData , typename EdgeData >

const BoostSerialGraph< VertexData, EdgeData >::edge_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_edge	(	uint_t	v1,
		uint_t	v2
	)		const

Access the i-th edge of the graph with endpoints the given vertices.

◆ get_vertex() [1/4]

template<typename VertexData , typename EdgeData >

BoostSerialGraph< VertexData, EdgeData >::vertex_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex ( adjacency_iterator itr )

Access the vertex given the vertex descriptor This is needed when accessing the vertices using the adjacency_iterator.

◆ get_vertex() [2/4]

template<typename VertexData , typename EdgeData >

const BoostSerialGraph< VertexData, EdgeData >::vertex_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex ( adjacency_iterator itr ) const

Access the vertex given the vertex descriptor This is needed when accessing the vertices using the adjacency_iterator.

◆ get_vertex() [3/4]

template<typename VertexData , typename EdgeData >

BoostSerialGraph< VertexData, EdgeData >::vertex_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex ( uint_t i )

Access the i-th vertex of the graph.

◆ get_vertex() [4/4]

template<typename VertexData , typename EdgeData >

const BoostSerialGraph< VertexData, EdgeData >::vertex_t & bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex ( uint_t i ) const

Access the i-th vertex of the graph.

◆ get_vertex_neighbors() [1/2]

template<typename VertexData , typename EdgeData >

std::pair< adjacency_iterator, adjacency_iterator > bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex_neighbors ( const vertex_t & v ) const

Returns the neighboring vertices for the given vertex id.

◆ get_vertex_neighbors() [2/2]

template<typename VertexData , typename EdgeData >

std::pair< typename BoostSerialGraph< VertexData, EdgeData >::adjacency_iterator, typename BoostSerialGraph< VertexData, EdgeData >::adjacency_iterator > bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex_neighbors ( uint_t id ) const

Returns the neighboring vertices for the given vertex id.

◆ get_vertex_neighbors_ids()

template<typename VertexData , typename EdgeData >

std::vector< uint_t > bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::get_vertex_neighbors_ids ( uint_t id ) const

get_vertex_neighbors_ids Returns the ids of the vertices connectected with this vertex

◆ max_edge_index()

template<typename VertexData , typename EdgeData >

uint_t bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::max_edge_index ( ) const

inlinenoexcept

Returns the maximum edge index.

◆ max_vertex_index()

template<typename VertexData , typename EdgeData >

uint_t bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::max_vertex_index ( ) const

inlinenoexcept

Returns the maximum vertex index.

◆ n_edges()

template<typename VertexData , typename EdgeData >

uint_t bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::n_edges ( ) const

inline

Returns the number of edges.

◆ n_vertices()

template<typename VertexData , typename EdgeData >

uint_t bitrl::utils::BoostSerialGraph< VertexData, EdgeData >::n_vertices ( ) const

inline

Returns the number of vertices.

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

libs/bitrl/src/bitrl/utils/boost_serial_graph.h

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ adjacency_iterator

◆ edge_data_t

◆ edge_iterator

◆ edge_t

◆ vertex_data_t

◆ vertex_t

Constructor & Destructor Documentation

◆ BoostSerialGraph()

Member Function Documentation

◆ add_edge()

◆ add_vertex()

◆ clear()

◆ edges()

◆ get_edge() [1/2]

◆ get_edge() [2/2]

◆ get_vertex() [1/4]

◆ get_vertex() [2/4]

◆ get_vertex() [3/4]

◆ get_vertex() [4/4]

◆ get_vertex_neighbors() [1/2]

◆ get_vertex_neighbors() [2/2]

◆ get_vertex_neighbors_ids()

◆ max_edge_index()

◆ max_vertex_index()

◆ n_edges()

◆ n_vertices()