Sparksee  5.2.0
STSCommunityDetection Class Reference

CommunityDetection class. More...

Inheritance diagram for STSCommunityDetection:
Inheritance graph
Collaboration diagram for STSCommunityDetection:
Collaboration graph

Instance Methods

(void) - addNodeType:
 Allows connectivity through nodes of the given type.
 
(void) - addAllNodeTypes
 Allows connectivity through all node types of the graph.
 
(void) - excludeNodes:
 Set which nodes can't be used.
 
(void) - excludeEdges:
 Set which edges can't be used.
 
(void) - run
 Runs the algorithm in order to find the connected components.
 
(void) - close
 Closes the CommunityDetection instance.
 
(BOOL) - isClosed
 Check if the CommunityDetection instance is closed.
 

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

Method Documentation

- (void) addNodeType: (int)  type

Allows connectivity through nodes of the given type.

Parameters
typenull
- (void) close

Closes the CommunityDetection instance.

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

- (void) excludeEdges: (STSObjects *)  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) excludeNodes: (STSObjects *)  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) run

Runs the algorithm in order to find the connected components.

This method can be called only once.

Implemented in STSCommunitiesSCD, and STSDisjointCommunityDetection.


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