CommunityDetection class. More...
Public Member Functions | |
| def | run (self) |
| Runs the algorithm in order to find the connected components. More... | |
| def | exclude_nodes (self, nodes) |
| Set which nodes can't be used. More... | |
| def | add_node_type (self, type) |
| Allows connectivity through nodes of the given type. More... | |
| def | exclude_edges (self, edges) |
| Set which edges can't be used. More... | |
| def | close (self) |
| Closes the CommunityDetection instance. More... | |
| def | include_nodes (self, nodes) |
| Set additional nodes that can be used. More... | |
| def | add_all_node_types (self) |
| Allows connectivity through all node types of the graph. | |
| def | include_edges (self, edges) |
| Set additional edges that can be used. More... | |
| def | is_closed (self) |
| Gets if CommunityDetection has been closed or not. More... | |
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.
Member Function Documentation
| def sparksee.CommunityDetection.add_node_type | ( | self, | |
| type | |||
| ) |
Allows connectivity through nodes of the given type.
- Parameters
-
type null
| def sparksee.CommunityDetection.close | ( | self | ) |
Closes the CommunityDetection instance.
It must be called to ensure the integrity of all data.
| def sparksee.CommunityDetection.exclude_edges | ( | self, | |
| 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.
| def sparksee.CommunityDetection.exclude_nodes | ( | self, | |
| 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.
| def sparksee.CommunityDetection.include_edges | ( | self, | |
| 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.
| def sparksee.CommunityDetection.include_nodes | ( | self, | |
| 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.
| def sparksee.CommunityDetection.is_closed | ( | self | ) |
Gets if CommunityDetection has been closed or not.
- See also
- close()
- Returns
- TRUE if the CommunityDetection instance has been closed, FALSE otherwise.
| def sparksee.CommunityDetection.run | ( | self | ) |
Runs the algorithm in order to find the connected components.
This method can be called only once.
