DisjointCommunities Class Reference
[Algorithms]

DisjointCommunities class. More...

List of all members.

Public Member Functions

 DisjointCommunities (sparksee::gdb::Session &session, const std::wstring &materializedattribute)
 Creates a new instance of DisjointCommunities.
virtual ~DisjointCommunities ()
 Destructor.
sparksee::gdb::int64_t GetCommunity (sparksee::gdb::oid_t idNode)
 Returns the disjoint community where the given node belongs to.
sparksee::gdb::int64_t GetCount ()
 Returns the number of communities found in the graph.
sparksee::gdb::Objects * GetNodes (sparksee::gdb::int64_t idCommunity)
 Returns the collection of nodes contained in the given community.
sparksee::gdb::int64_t GetSize (sparksee::gdb::int64_t idCommunity)
 Returns the number of nodes contained in the given community.


Detailed Description

DisjointCommunities class.

This class contains the results processed on a DisjointCommunityDetection algorithm.

These results contain information related to the communities found. We must consider that each community has a number in order to identify it. These number identifiers are values from 0 to N-1, where N is the number of different communities found.

When executing any implementation of the DisjointCommunityDetection, it is possible to indicate whether the results of the execution must be stored persistently using the class DisjointCommunityDetection setMaterializedAttribute method. In case the results are set to be materialized, users can retrieve this data whenever they want, even if the graph has been closed and opened again, just by creating a new instance of this class.

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

DisjointCommunities::DisjointCommunities ( sparksee::gdb::Session &  session,
const std::wstring &  materializedattribute 
)

Creates a new instance of DisjointCommunities.

This constructor method can only be called when a previous execution of any implementation of the DisjointCommunityDetection class has materialized the results in a common attribute type for all the nodes in the graph. For further information about materializing the results processed on any DisjointCommunityDetection execution see the documentation of the DisjointCommunityDetection#SetMaterializedAttribute method.

Parameters:
session [in] Session to get the graph Graph on which the information will be retrieved just by getting the values contained in the given common attribute type for all the nodes in the graph and processing them.
materializedattribute [in] The common attribute type for all the nodes in the graph where data will be retrieved in order to process the results related to the communities found in the graph.


Member Function Documentation

sparksee::gdb::int64_t DisjointCommunities::GetCommunity ( sparksee::gdb::oid_t  idNode  ) 

Returns the disjoint community where the given node belongs to.

Parameters:
idNode [in] The node identifier for which the disjoint community identifier where it belongs will be returned.
Returns:
The disjoint community identifier where the given node identifier belongs to.

sparksee::gdb::int64_t DisjointCommunities::GetCount (  ) 

Returns the number of communities found in the graph.

Returns:
The number of communities found in the graph.

sparksee::gdb::Objects* DisjointCommunities::GetNodes ( sparksee::gdb::int64_t  idCommunity  ) 

Returns the collection of nodes contained in the given community.

Parameters:
[in] idCommunity The community for which the collection of nodes contained in it will be returned.
Returns:
The collection of node identifiers contained in the given community.

sparksee::gdb::int64_t DisjointCommunities::GetSize ( sparksee::gdb::int64_t  idCommunity  ) 

Returns the number of nodes contained in the given community.

Parameters:
[in] idCommunity The community for which the number of nodes contained in it will be returned.
Returns:
The number of nodes contained in the given community.


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

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