sparksee.DisjointCommunityDetection Class Reference

DisjointCommunityDetection class. More...

Inheritance diagram for sparksee.DisjointCommunityDetection:

Inheritance graph
Collaboration diagram for sparksee.DisjointCommunityDetection:

Collaboration graph

List of all members.

Public Member Functions

def add_node_type
 Allows connectivity through nodes of the given type.
def add_edge_type
 Allows connectivity through edges of the given type.
def add_all_node_types
 Allows connectivity through all node types of the graph.
def add_all_edge_types
 Allows connectivity through all edge types of the graph.
def exclude_nodes
 Set which nodes can't be used.
def run
 Runs the algorithm in order to find the communities.
def set_materialized_attribute
 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.
def get_communities
 Returns the results generated by the execution of the algorithm.
def exclude_edges
 Set which edges can't be used.
def is_closed
 Gets if CommunityDetection has been closed or not.
def close
 Closes the CommunityDetection instance.


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

Member Function Documentation

def sparksee.DisjointCommunityDetection.add_node_type (   self,
  type 
)

Allows connectivity through nodes of the given type.

Parameters:
type null

Reimplemented from sparksee.CommunityDetection.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.add_edge_type (   self,
  type 
)

Allows connectivity through edges of the given type.

The edges can be used in Any direction.

Parameters:
type [in] Edge type.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.add_all_edge_types (   self  ) 

Allows connectivity through all edge types of the graph.

The edges can be used in Any direction.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.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 from sparksee.CommunityDetection.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.run (   self  ) 

Runs the algorithm in order to find the communities.

This method can be called only once.

Reimplemented from sparksee.CommunityDetection.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.set_materialized_attribute (   self,
  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.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.get_communities (   self  ) 

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.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.DisjointCommunityDetection.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 from sparksee.CommunityDetection.

Reimplemented in sparksee.CommunitiesSCD.

def sparksee.CommunityDetection.is_closed (   self  )  [inherited]

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.close (   self  )  [inherited]

Closes the CommunityDetection instance.

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


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