CommunitiesSCD Class Reference
[Algorithms]

CommunitiesSCD class. More...

Inheritance diagram for CommunitiesSCD:

Inheritance graph
Collaboration diagram for CommunitiesSCD:

Collaboration graph

List of all members.

Public Member Functions

 CommunitiesSCD (sparksee::gdb::Session &session)
 Creates a new instance of CommunitiesSCD.
virtual ~CommunitiesSCD ()
 Destructor.
void SetLookAhead (sparksee::gdb::int32_t lookahead)
 Sets the size of the lookahead iterations to look.
void Run ()
 Executes the algorithm.
virtual void AddEdgeType (sparksee::gdb::type_t type)
 Allows connectivity through edges of the given type.
virtual void AddAllEdgeTypes ()
 Allows connectivity through all edge types of the graph.
DisjointCommunitiesGetCommunities ()
 Returns the results generated by the execution of the algorithm.
void SetMaterializedAttribute (const std::wstring &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.
virtual void AddNodeType (sparksee::gdb::type_t type)
 Allows connectivity through nodes of the given type.
virtual void AddAllNodeTypes ()
 Allows connectivity through all node types of the graph.
virtual void ExcludeNodes (sparksee::gdb::Objects &nodes)
 Set which nodes can't be used.
virtual void ExcludeEdges (sparksee::gdb::Objects &edges)
 Set which edges can't be used.

Protected Types

typedef std::map
< sparksee::gdb::type_t,
sparksee::gdb::EdgesDirection
EdgeTypes_t
 A type definition to store allowed edge types.
typedef std::vector
< sparksee::gdb::type_t
NodeTypes_t
 A type definition to store allowed node types.

Protected Member Functions

void AddEdgeType (sparksee::gdb::type_t type, sparksee::gdb::EdgesDirection direction)
 Allows connectivity through edges of the given type.
void AddAllEdgeTypes (sparksee::gdb::EdgesDirection direction)
 Allows connectivity through all edge types of the graph.
void SetCommunity (sparksee::gdb::oid_t idNode)
 Assigns the current community to the given node.
void AssertNotCommunityAttribute (const std::wstring &attributeName)
 Check that the given attribute name is not already in use.
void CreateGlobalPersistentAttribute (const std::wstring &attributeName)
 Set a new persistent global attribute to store the disjoint communities information.
void CreateGlobalTransientAttribute ()
 Set a new temporary global attribute to store the disjoint communities information.
void RemoveGlobalAttribute ()
 Removes the global attribute where the disjoint communities information is stored.
void AssertAddedEdges ()
 Check that edges had been added.
void AssertAddedNodes ()
 Check that nodes had been added.
void AssertNotComputed ()
 Check that the connectivity had not been calculated yet.
void SetNodesNotVisited ()
 Set all the selected nodes in nodesNotVisited.
void AssertComputed ()
 Check that the communities had been calculated.
void AssertEdgeType (sparksee::gdb::type_t edgetype)
 Check that the given edge type is valid.
void AssertNodeType (sparksee::gdb::type_t nodetype)
 Check that the given node type is valid.
sparksee::gdb::bool_t IsNodeTypeAllowed (sparksee::gdb::oid_t nodeId)
 Check if the given node has an allowed type.
sparksee::gdb::bool_t IsNodeExcluded (sparksee::gdb::oid_t node)
 Check if the given node is forbidden.
sparksee::gdb::bool_t IsEdgeExcluded (sparksee::gdb::oid_t edge)
 Check if the given edge is forbidden.

Protected Attributes

sparksee::gdb::attr_t attrCommunity
 common attribute where the connected component information is stored.
std::wstring attrCommunityName
 name of the common attribute where the connected component information is stored.
sparksee::gdb::int64_t actualCommunity
 Current community identifier.
sparksee::gdb::bool_t matResults
 Materialized results.
DisjointCommunitiesdcs
 The calculated communities information.
sparksee::gdb::Session * sess
 Session.
sparksee::gdb::Graph * graph
 Graph.
EdgeTypes_t edgeTypes
 Allowed edge types.
std::vector
< sparksee::gdb::type_t
nodeTypes
 Allowed node types.
sparksee::gdb::Objects * nodesNotVisited
 Identifiers of the nodes not visited.
sparksee::gdb::bool_t computed
 True if the connectivity has been calculated.
sparksee::gdb::Objects * excludedNodes
 The set of excluded nodes.
sparksee::gdb::Objects * excludedEdges
 The set of excluded edges.


Detailed Description

CommunitiesSCD class.

Implementation of the community detection algorithm "Scalable Community Detection" based on the paper "High quality, scalable and parallel community detection for large real graphs" by Arnau Prat-Perez, David Dominguez-Sal, Josep-Lluis Larriba-Pey - WWW 2014.

The purpose of this algorithm is to find disjoint communities in an undirected graph or in a directed graph which will be considered as an undirected one.

It is possible to set some restrictions after constructing a new instance of this class and before running it in order to limit the results.

After the execution, we can retrieve the results stored in an instance of the DisjointCommunities class using the getCommunities method.

Check out the 'Algorithms' section in the SPARKSEE User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

CommunitiesSCD::CommunitiesSCD ( sparksee::gdb::Session &  session  ) 

Creates a new instance of CommunitiesSCD.

After creating this instance is required to indicate the set of edge types and the set of node types which will be navigated through while traversing the graph in order to find the communities.

Parameters:
session [in] Session to get the graph from and calculate the communities


Member Function Documentation

void CommunitiesSCD::SetLookAhead ( sparksee::gdb::int32_t  lookahead  ) 

Sets the size of the lookahead iterations to look.

Parameters:
lookahead [in] Number of iterations. It must be positive or zero.

virtual void DisjointCommunityDetection::AddEdgeType ( sparksee::gdb::type_t  type  )  [virtual, inherited]

Allows connectivity through edges of the given type.

The edges can be used in Any direction.

Parameters:
type [in] Edge type.

void CommunityDetection::AddEdgeType ( sparksee::gdb::type_t  type,
sparksee::gdb::EdgesDirection  direction 
) [protected, inherited]

Allows connectivity through edges of the given type.

Parameters:
t [in] Edge type.
d [in] Edge direction.

virtual void DisjointCommunityDetection::AddAllEdgeTypes (  )  [virtual, inherited]

Allows connectivity through all edge types of the graph.

The edges can be used in Any direction.

void CommunityDetection::AddAllEdgeTypes ( sparksee::gdb::EdgesDirection  direction  )  [protected, inherited]

Allows connectivity through all edge types of the graph.

Parameters:
d [in] Edge direction.

DisjointCommunities* DisjointCommunityDetection::GetCommunities (  )  [inherited]

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 DisjointCommunityDetection::SetMaterializedAttribute ( const std::wstring &  attributeName  )  [inherited]

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.

virtual void CommunityDetection::ExcludeNodes ( sparksee::gdb::Objects &  nodes  )  [virtual, inherited]

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.

virtual void CommunityDetection::ExcludeEdges ( sparksee::gdb::Objects &  edges  )  [virtual, inherited]

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 CommunityDetection::SetNodesNotVisited (  )  [protected, inherited]

Set all the selected nodes in nodesNotVisited.

That's all the nodes of the allowed node types but not the excluded ones.


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

Generated on Tue Jun 2 13:44:06 2015 for Sparksee by  doxygen 1.5.6