sparksee.CommunityDetection Class Reference

CommunityDetection class. More...

Inheritance diagram for sparksee.CommunityDetection:

Inheritance graph

List of all members.

Public Member Functions

def add_node_type
 Allows connectivity through nodes of the given type.
def add_all_node_types
 Allows connectivity through all node types of the graph.
def run
 Runs the algorithm in order to find the connected components.
def exclude_nodes
 Set which nodes can't be used.
def is_closed
 Gets if CommunityDetection has been closed or not.
def exclude_edges
 Set which edges can't be used.
def close
 Closes the CommunityDetection instance.


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

def sparksee.CommunityDetection.add_node_type (   self,
  type 
)

Allows connectivity through nodes of the given type.

Parameters:
type null

Reimplemented in sparksee.CommunitiesSCD, and sparksee.DisjointCommunityDetection.

def sparksee.CommunityDetection.run (   self  ) 

Runs the algorithm in order to find the connected components.

This method can be called only once.

Reimplemented in sparksee.CommunitiesSCD, and sparksee.DisjointCommunityDetection.

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.

Reimplemented in sparksee.CommunitiesSCD, and sparksee.DisjointCommunityDetection.

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.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.

Reimplemented in sparksee.CommunitiesSCD, and sparksee.DisjointCommunityDetection.

def sparksee.CommunityDetection.close (   self  ) 

Closes the CommunityDetection instance.

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


Generated on Tue Jun 2 16:12:18 2015 for SparkseePython by  doxygen 1.5.6