#include <WeakConnectivity.h>

Inheritance diagram for WeakConnectivity:

Collaboration diagram for WeakConnectivity:

Public Member Functions
virtual	~WeakConnectivity ()
	Destructor.
virtual void	AddEdgeType (sparksee::gdb::type_t type)
	Allows connectivity through edges of the given type.
virtual void	AddAllEdgeTypes ()
	Allows connectivity through all edge types of the graph.
virtual void	AddNodeType (sparksee::gdb::type_t t)
	Allows connectivity through nodes of the given type.
virtual void	AddAllNodeTypes ()
	Allows connectivity through all node types of the graph.
virtual void	ExcludeNodes (sparksee::gdb::Objects &nodes)
	Set which nodes can't be used.
virtual void	ExcludeEdges (sparksee::gdb::Objects &edges)
	Set which edges can't be used.
ConnectedComponents *	GetConnectedComponents ()
	Returns the results generated by the execution of the algorithm.
virtual void	Run ()=0
	Runs the algorithm in order to find the connected components.
void	SetMaterializedAttribute (const std::wstring &attributeName)
	Creates a new common attribute type for all node types in the graph in order to store, persistently, the results related to the connected components found while executing this algorithm.

Protected Types
typedef std::map< sparksee::gdb::type_t, sparksee::gdb::EdgesDirection >	EdgeTypes_t
	A type definition to store allowed edge types.
typedef std::vector< sparksee::gdb::type_t >	NodeTypes_t
	A type definition to store allowed node types.

Protected Member Functions
	WeakConnectivity (sparksee::gdb::Session &s)
	Creates a new instance of `WeakConnectivity`.
void	AddEdgeType (sparksee::gdb::type_t t, sparksee::gdb::EdgesDirection d)
	Allows connectivity through edges of the given type.
void	AddAllEdgeTypes (sparksee::gdb::EdgesDirection d)
	Allows connectivity through all edge types of the graph.
void	AssertAddedEdges ()
	Check that edges had been added.
void	AssertAddedNodes ()
	Check that nodes had been added.
void	AssertNotComputed ()
	Check that the connectivity had not been calculated yet.
void	SetConnectedComponent (sparksee::gdb::oid_t idNode)
	Assigns the current component to the given node.
void	SetNodesNotVisited ()
	Set all the selected nodes in nodesNotVisited.
void	AssertNotComponentAttribute (const std::wstring &attributeName)
	Check that the given attribute name is not already in use.
void	AssertComputed ()
	Check that the connectivity had been calculated.
void	AssertEdgeType (sparksee::gdb::type_t edgetype)
	Check that the given edge type is valid.
void	AssertNodeType (sparksee::gdb::type_t nodetype)
	Check that the given node type is valid.
void	CreateGlobalPersistentAttribute (const std::wstring &attributeName)
	Set a new persistent global attribute to store the connectivity information.
void	CreateGlobalTransientAttribute ()
	Set a new temporary global attribute to store the connectivity information.
void	RemoveGlobalAttribute ()
	Removes the global attribute where the connectivity information is stored.
sparksee::gdb::bool_t	IsNodeTypeAllowed (sparksee::gdb::oid_t nodeId)
	Check if the given node has an allowed type.
sparksee::gdb::bool_t	IsNodeExcluded (sparksee::gdb::oid_t node)
	Check if the given node is forbidden.
sparksee::gdb::bool_t	IsEdgeExcluded (sparksee::gdb::oid_t edge)
	Check if the given edge is forbidden.

Protected Attributes
sparksee::gdb::Session *	sess
	Session.
sparksee::gdb::Graph *	graph
	Graph.
EdgeTypes_t	edgeTypes
	Allowed edge types.
std::vector< sparksee::gdb::type_t >	nodeTypes
	Allowed node types.
sparksee::gdb::attr_t	attrComponent
	common attribute where the connected component information is stored.
std::wstring	attrComponentName
	name of the common attribute where the connected component information is stored.
sparksee::gdb::int64_t	actualComponent
	Current component identifier.
sparksee::gdb::Objects *	nodesNotVisited
	Identifiers of the nodes not visited.
sparksee::gdb::bool_t	matResults
	Materialized results.
sparksee::gdb::bool_t	computed
	True if the connectivity has been calculated.
sparksee::gdb::Objects *	excludedNodes
	The set of excluded nodes.
sparksee::gdb::Objects *	excludedEdges
	The set of excluded edges.
ConnectedComponents *	ccs
	The calculated connectivity information.

Detailed Description

WeakConnectivity class.

Any class implementing this abstract class can be used to solve the problem of finding weakly connected components in an undirected graph or in a directed graph which will be considered as an undirected one.

It consists in finding components where every pair (u,v) of nodes contained in it has a path from u to v and from v to u.

It is possible to set some restrictions after constructing a new instance of this class and before running it in order to limit the results.

After the execution, we can retrieve the results stored in an instance of the ConnectedComponents class using the getConnectedComponents method.

Check out the 'Algorithms' section in the SPARKSEE User Manual for more details on this.

Author: Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

◆ WeakConnectivity()

WeakConnectivity::WeakConnectivity ( sparksee::gdb::Session & s )

protected

Creates a new instance of WeakConnectivity.

Parameters

s	[in] Session to get the graph from and calculate the connectivity

References WeakConnectivity().

Referenced by WeakConnectivity().

Member Function Documentation

◆ AddAllEdgeTypes() [1/2]

void Connectivity::AddAllEdgeTypes ( sparksee::gdb::EdgesDirection d )

protectedinherited

Allows connectivity through all edge types of the graph.

Parameters

d	[in] Edge direction.

◆ AddAllEdgeTypes() [2/2]

virtual void WeakConnectivity::AddAllEdgeTypes ( )

virtual

Allows connectivity through all edge types of the graph.

In a weak connectivity the edges can be used in Any direction.

◆ AddEdgeType() [1/2]

void Connectivity::AddEdgeType	(	sparksee::gdb::type_t	t,
		sparksee::gdb::EdgesDirection	d )

protectedinherited

Allows connectivity through edges of the given type.

Parameters

t	[in] Edge type.
d	[in] Edge direction.

◆ AddEdgeType() [2/2]

virtual void WeakConnectivity::AddEdgeType ( sparksee::gdb::type_t type )

virtual

Allows connectivity through edges of the given type.

In a weak connectivity the edges can be used in Any direction.

Parameters

type	[in] Edge type.

◆ ExcludeEdges()

virtual void Connectivity::ExcludeEdges ( sparksee::gdb::Objects & edges )

virtualinherited

Set which edges can't be used.

This will replace any previously specified set of excluded edges. Should only be used to exclude the usage of specific edges from allowed edge types because it's less efficient than not allowing an edge type.

Parameters

edges [in] A set of edge identifiers that must be kept intact until the destruction of the class.

◆ ExcludeNodes()

virtual void Connectivity::ExcludeNodes ( sparksee::gdb::Objects & nodes )

virtualinherited

Set which nodes can't be used.

This will replace any previously specified set of excluded nodes. Should only be used to exclude the usage of specific nodes from allowed node types because it's less efficient than not allowing a node type.

Parameters

nodes [in] A set of node identifiers that must be kept intact until the destruction of the class.

◆ GetConnectedComponents()

ConnectedComponents * Connectivity::GetConnectedComponents ( )

inherited

Returns the results generated by the execution of the algorithm.

These results contain information related to the connected components found as the number of different components, the set of nodes contained in each component or many other data.

Returns: Returns an instance of the class ConnectedComponents which contain information related to the connected components found.

◆ Run()

virtual void Connectivity::Run ( )

pure virtualinherited

Runs the algorithm in order to find the connected components.

This method can be called only once.

Implemented in StrongConnectivityGabow, and WeakConnectivityDFS.

◆ SetMaterializedAttribute()

void Connectivity::SetMaterializedAttribute ( const std::wstring & attributeName )

inherited

Creates a new common attribute type for all node types in the graph in order to store, persistently, the results related to the connected components found while executing this algorithm.

Whenever the user wants to retrieve the results, even when the graph has been closed and opened again, it is only necessary to create a new instance of the class ConnectedComponents indicating the graph and the name of the common attribute type which stores the results. This instance will have all the information related to the connected components found in the moment of the execution of the algorithm that stored this data.

It is possible to run the algorithm without specifying this parameter in order to avoid materializing the results of the execution.

Parameters

attributeName [in] The name of the common attribute type for all node types in the graph which will store persistently the results generated by the execution of the algorithm.

◆ SetNodesNotVisited()

void Connectivity::SetNodesNotVisited ( )

protectedinherited

Set all the selected nodes in nodesNotVisited.

That's all the nodes of the allowed node types but not the excluded ones.

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

WeakConnectivity.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WeakConnectivity()

Member Function Documentation

◆ AddAllEdgeTypes() [1/2]

◆ AddAllEdgeTypes() [2/2]

◆ AddEdgeType() [1/2]

◆ AddEdgeType() [2/2]

◆ ExcludeEdges()

◆ ExcludeNodes()

◆ GetConnectedComponents()

◆ Run()

◆ SetMaterializedAttribute()

◆ SetNodesNotVisited()