Sparksee  5.2.0
STSDisjointCommunityDetection Class Reference

DisjointCommunityDetection class. More...

Inheritance diagram for STSDisjointCommunityDetection:
Inheritance graph
Collaboration diagram for STSDisjointCommunityDetection:
Collaboration graph

Instance Methods

(void) - addEdgeType:
 Allows connectivity through edges of the given type.
 
(void) - addAllEdgeTypes
 Allows connectivity through all edge types of the graph.
 
(STSDisjointCommunities *) - getCommunities
 Returns the results generated by the execution of the algorithm.
 
(void) - run
 Runs the algorithm in order to find the communities.
 
(void) - setMaterializedAttribute:
 Creates a new common attribute type for all node types in the graph in order to store, persistently, the results related to the disjoint communities found while executing this algorithm.
 
(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) - close
 Closes the CommunityDetection instance.
 
(BOOL) - isClosed
 Check if the CommunityDetection instance is closed.
 

Detailed Description

DisjointCommunityDetection 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) addAllEdgeTypes

Allows connectivity through all edge types of the graph.

The edges can be used in Any direction.

- (void) addEdgeType: (int)  type

Allows connectivity through edges of the given type.

The edges can be used in Any direction.

Parameters
type[in] Edge type.
- (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.
- (STSDisjointCommunities*) getCommunities

Returns the results generated by the execution of the algorithm.

These results contain information related to the disjoint communities 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 DisjointCommunities which contain information related to the disjoint communities found.
- (void) run

Runs the algorithm in order to find the communities.

This method can be called only once.

Implements STSCommunityDetection.

Implemented in STSCommunitiesSCD.

- (void) setMaterializedAttribute: (NSString *)  attributeName

Creates a new common attribute type for all node types in the graph in order to store, persistently, the results related to the disjoint communities 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 DisjointCommunities 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 disjoint communities 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.

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