stapl::gpartition< GView > Class Template Reference

Class representing a graph partition. The class provides queries to retrieve the partitions and measure its quality. More...

Public Member Functions
	gpartition (partition_view_t const &hview)
	Constructor that takes a hierarchical graph view representing the partition.
partition_view_t	partition () const
	Returns the hierarchical view representing the partitions. More...
vertex_partition_domain	vertices (partition_id const &pid) const
	Returns the vertex domain of a specific partition. More...
edge_domain	out_cut_edges (partition_id const &pid) const
	Returns the outgoing cut-edges of a specific partition. More...
edge_domain	out_cut_edges (partition_id const &pid1, partition_id const &pid2) const
	Returns the outgoing cut-edges from one partition to another one. More...
edge_domain	cut_edges (partition_id const &pid) const
	Returns the cut-edges of a specific partition. More...
edge_domain	cut_edges (partition_id const &pid1, partition_id const &pid2) const
	Returns the cut-edges from one partition to another one. More...
size_t	vertex_size (partition_id const &pid) const
	Returns the size of a partition. More...
size_t	cut_edge_size (partition_id const &pid) const
	Returns the size of the cut-edges of a specific partition. More...
size_t	cut_edge_size (partition_id const &pid1, partition_id const &pid2) const
	Returns the size of cut-edges from one partition to another one. More...
size_t	size () const
	Returns the number of partitions.

Public Types
typedef GView	base_graph_view_t
typedef partition_view_type< GView >::type	partition_view_t
typedef partition_view_t::vertex_property::domain_type	vertex_partition_domain
typedef partition_view_t::edge_property	edge_domain
typedef partition_view_t::vertex_reference	vertex_reference
typedef partition_view_t::vertex_iterator	vertex_iterator
typedef partition_view_t::adj_edge_iterator	adj_edge_iterator
typedef size_t	partition_id

Detailed Description

template<class GView>
class stapl::gpartition< GView >

Class representing a graph partition. The class provides queries to retrieve the partitions and measure its quality.

Template Parameters

GView

graph view type of the partitioned graph.

Member Function Documentation

partition()

template<class GView >

partition_view_t stapl::gpartition< GView >::partition

(

)

const

Returns the hierarchical view representing the partitions.

Returns

hierarchical view

vertices()

template<class GView >

vertex_partition_domain stapl::gpartition< GView >::vertices

(

partition_id const &

pid

)

const

Returns the vertex domain of a specific partition.

Parameters

pid	partition id

Returns

vertex domain

out_cut_edges() [1/2]

template<class GView >

edge_domain stapl::gpartition< GView >::out_cut_edges

(

partition_id const &

pid

)

const

Returns the outgoing cut-edges of a specific partition.

Parameters

pid	partition id

Returns

edge domain

out_cut_edges() [2/2]

template<class GView >

edge_domain stapl::gpartition< GView >::out_cut_edges	(	partition_id const &	pid1,
		partition_id const &	pid2
	)		const

Returns the outgoing cut-edges from one partition to another one.

Parameters

pid1	partition id of the source partition
pid2	partition id of the target partition

Returns

edge domain

cut_edges() [1/2]

template<class GView >

edge_domain stapl::gpartition< GView >::cut_edges

(

partition_id const &

pid

)

const

Returns the cut-edges of a specific partition.

Parameters

pid	partition id

Returns

edge domain

cut_edges() [2/2]

template<class GView >

edge_domain stapl::gpartition< GView >::cut_edges	(	partition_id const &	pid1,
		partition_id const &	pid2
	)		const

Returns the cut-edges from one partition to another one.

Parameters

pid1	partition id of the source partition
pid2	partition id of the target partition

Returns

edge domain

vertex_size()

template<class GView >

size_t stapl::gpartition< GView >::vertex_size

(

partition_id const &

pid

)

const

Returns the size of a partition.

Parameters

pid	partition id

cut_edge_size() [1/2]

template<class GView >

size_t stapl::gpartition< GView >::cut_edge_size

(

partition_id const &

pid

)

const

Returns the size of the cut-edges of a specific partition.

Parameters

pid	partition id

cut_edge_size() [2/2]

template<class GView >

size_t stapl::gpartition< GView >::cut_edge_size	(	partition_id const &	pid1,
		partition_id const &	pid2
	)		const

Returns the size of cut-edges from one partition to another one.

Parameters

pid1	partition id of the source partition
pid2	partition id of the target partition

---

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

• gpartition.h