DexNet 4.7.0
Public Member Functions
com::sparsity::dex::algorithms::StrongConnectivity Class Reference

StrongConnectivity class. More...

Inheritance diagram for com::sparsity::dex::algorithms::StrongConnectivity:
Inheritance graph
Collaboration diagram for com::sparsity::dex::algorithms::StrongConnectivity:
Collaboration graph

List of all members.

Public Member Functions

void AddAllNodeTypes ()
 Allows connectivity through all node types of the graph.
void AddAllEdgeTypes (com.sparsity.dex.gdb.EdgesDirection d)
 Allows connectivity through all edge types of the graph.
void Run ()
 Runs the algorithm in order to find the connected components.
void ExcludeNodes (com.sparsity.dex.gdb.Objects nodes)
 Set which nodes can't be used.
void AddEdgeType (int t, com.sparsity.dex.gdb.EdgesDirection d)
 Allows connectivity through edges of the given type.
void SetMaterializedAttribute (System.String 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.
void AddNodeType (int t)
 Allows connectivity through nodes of the given type.
com.sparsity.dex.algorithms.ConnectedComponents GetConnectedComponents ()
 Returns the results generated by the execution of the algorithm.
void ExcludeEdges (com.sparsity.dex.gdb.Objects edges)
 Set which edges can't be used.
boolean IsClosed ()
 Gets if Connectivity instance has been closed or not.
void Close ()
 Closes the Connectivity instance.

Detailed Description

StrongConnectivity class.

Any class implementing this abstract class can be used to solve the problem of finding strongly connected components in a directed graph.

It consists in finding components where every pair (u,v) of nodes contained in it has a path from u to v using the specified direction for each edge type.

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. Those restrictions are:

(i) The set of edge types which will be navigated through while traversing the graph. The method is AddEdgeType for adding one edge type and AddAllEdgeTypes for adding all edge types with a specified direction.

(ii) The set of node types which will be navigated through while traversing the graph. The method is AddNodeType for adding one node type and AddAllNodeTypes for adding all node types.

For each instance of this class, it is only allowed to run the algorithm once.

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

NOTE: It is required to indicate the set of edge types and node types before running this algorithm.

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

Member Function Documentation

void com::sparsity::dex::algorithms::StrongConnectivity::AddAllEdgeTypes ( com.sparsity.dex.gdb.EdgesDirection  d)

Allows connectivity through all edge types of the graph.

Parameters:
d[in] Edge direction.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

void com::sparsity::dex::algorithms::StrongConnectivity::AddEdgeType ( int  t,
com.sparsity.dex.gdb.EdgesDirection  d 
)

Allows connectivity through edges of the given type.

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

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

void com::sparsity::dex::algorithms::StrongConnectivity::AddNodeType ( int  t)

Allows connectivity through nodes of the given type.

Parameters:
tnull

Reimplemented from com::sparsity::dex::algorithms::Connectivity.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

void com::sparsity::dex::algorithms::Connectivity::Close ( ) [inherited]

Closes the Connectivity instance.

It must be called to ensure the integrity of all data.

void com::sparsity::dex::algorithms::StrongConnectivity::ExcludeEdges ( com.sparsity.dex.gdb.Objects  edges)

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.

Reimplemented from com::sparsity::dex::algorithms::Connectivity.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

void com::sparsity::dex::algorithms::StrongConnectivity::ExcludeNodes ( com.sparsity.dex.gdb.Objects  nodes)

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.

Reimplemented from com::sparsity::dex::algorithms::Connectivity.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

com.sparsity.dex.algorithms.ConnectedComponents com::sparsity::dex::algorithms::StrongConnectivity::GetConnectedComponents ( )

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.

Reimplemented from com::sparsity::dex::algorithms::Connectivity.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

boolean com::sparsity::dex::algorithms::Connectivity::IsClosed ( ) [inherited]

Gets if Connectivity instance has been closed or not.

See also:
Close()
Returns:
TRUE if the Connectivity instance has been closed, FALSE otherwise.
void com::sparsity::dex::algorithms::StrongConnectivity::Run ( )

Runs the algorithm in order to find the connected components.

This method can be called only once.

Reimplemented from com::sparsity::dex::algorithms::Connectivity.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.

void com::sparsity::dex::algorithms::StrongConnectivity::SetMaterializedAttribute ( System.String  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.

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.

Reimplemented from com::sparsity::dex::algorithms::Connectivity.

Reimplemented in com::sparsity::dex::algorithms::StrongConnectivityGabow.