com.sparsity.sparksee.algorithms.CommunityDetection Class Reference

CommunityDetection class. More...

Inheritance diagram for com.sparsity.sparksee.algorithms.CommunityDetection:

Public Member Functions
boolean	IsClosed ()
	Gets if CommunityDetection instance has been closed or not.
void	IncludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
	Set additional nodes that can be used.
void	AddNodeType (int type)
	Allows connectivity through nodes of the given type.
void	AddAllNodeTypes ()
	Allows connectivity through all node types of the graph.
void	Close ()
	Closes the CommunityDetection instance.
void	IncludeEdges (com.sparsity.sparksee.gdb.Objects edges)
	Set additional edges that can be used.
void	Run ()
	Runs the algorithm in order to find the connected components.
void	ExcludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
	Set which nodes can't be used.
void	ExcludeEdges (com.sparsity.sparksee.gdb.Objects edges)
	Set which edges can't be used.

Detailed Description

CommunityDetection class.

Any class implementing this abstract class can be used to solve a problem related to graph connectivity as finding the strongly connected components, finding the weakly connected components.

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

Author

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

Member Function Documentation

void com.sparsity.sparksee.algorithms.CommunityDetection.AddNodeType

(

int

type

)

Allows connectivity through nodes of the given type.

Parameters

type

null

void com.sparsity.sparksee.algorithms.CommunityDetection.Close

(

)

Closes the CommunityDetection instance.

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

void com.sparsity.sparksee.algorithms.CommunityDetection.ExcludeEdges

(

com.sparsity.sparksee.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.

void com.sparsity.sparksee.algorithms.CommunityDetection.ExcludeNodes

(

com.sparsity.sparksee.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.

void com.sparsity.sparksee.algorithms.CommunityDetection.IncludeEdges

(

com.sparsity.sparksee.gdb.Objects

edges

)

Set additional edges that can be used.

This will replace any previously specified set of include edges. Using this optional method adds valid edges to the edges of any edge type explicitly set as a valid type. Should only be used to include specific small sets of edges because it's less efficient than just using an edge type. For any edge to be used, both nodes must be also valid.

Parameters

edges

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

void com.sparsity.sparksee.algorithms.CommunityDetection.IncludeNodes

(

com.sparsity.sparksee.gdb.Objects

nodes

)

Set additional nodes that can be used.

This will replace any previously specified set of include nodes. Using this optional method adds valid nodes to the nodes of any node type explicitly set as a valid type. Should only be used to include specific small sets of nodes because it's less efficient than just using a node type.

Parameters

nodes

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

boolean com.sparsity.sparksee.algorithms.CommunityDetection.IsClosed

(

)

Gets if CommunityDetection instance has been closed or not.

See Also

Close()

Returns

TRUE if the CommunityDetection instance has been closed, FALSE otherwise.

void com.sparsity.sparksee.algorithms.CommunityDetection.Run

(

)

Runs the algorithm in order to find the connected components.

This method can be called only once.