CommunityDetection class. More...
Instance Methods | |
| (void) | - addNodeType: |
| Allows connectivity through nodes of the given type. More... | |
| (void) | - addAllNodeTypes |
| Allows connectivity through all node types of the graph. | |
| (void) | - excludeNodes: |
| Set which nodes can't be used. More... | |
| (void) | - excludeEdges: |
| Set which edges can't be used. More... | |
| (void) | - includeNodes: |
| Set additional nodes that can be used. More... | |
| (void) | - includeEdges: |
| Set additional edges that can be used. More... | |
| (void) | - run |
| Runs the algorithm in order to find the connected components. More... | |
| (void) | - close |
| Closes the CommunityDetection instance. More... | |
| (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.
Method Documentation
| - (void) addNodeType: | (int) | type |
Allows connectivity through nodes of the given type.
- Parameters
-
type null
| - (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) includeEdges: | (STSObjects *) | 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) includeNodes: | (STSObjects *) | 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.
| - (void) run |
Runs the algorithm in order to find the connected components.
This method can be called only once.
Implemented in STSDisjointCommunityDetection, and STSCommunitiesSCD.
The documentation for this class was generated from the following file:
- Sparksee.h
