ConnectedComponents Class Reference
[Algorithms]

ConnectedComponents class. More...

List of all members.

Public Member Functions

 ConnectedComponents (sparksee::gdb::Session &s, const std::wstring &materializedattribute)
 Creates a new instance of ConnectedComponents.
virtual ~ConnectedComponents ()
 Destructor.
sparksee::gdb::int64_t GetConnectedComponent (sparksee::gdb::oid_t idNode)
 Returns the connected component where the given node belongs to.
sparksee::gdb::int64_t GetCount ()
 Returns the number of connected components found in the graph.
sparksee::gdb::Objects * GetNodes (sparksee::gdb::int64_t idConnectedComponent)
 Returns the collection of nodes contained in the given connected component.
sparksee::gdb::int64_t GetSize (sparksee::gdb::int64_t idConnectedComponent)
 Returns the number of nodes contained in the given connected component.


Detailed Description

ConnectedComponents class.

This class contains the results processed on a Connectivity algorithm.

These results contain information related to the connected components found. We must consider that each connected component 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 connected components found.

When executing any implementation of the Connectivity, it is possible to indicate whether the results of the execution must be stored persistently using the class Connectivity 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

ConnectedComponents::ConnectedComponents ( sparksee::gdb::Session &  s,
const std::wstring &  materializedattribute 
)

Creates a new instance of ConnectedComponents.

This constructor method can only be called when a previous execution of any implementation of the Connectivity 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 Connectivity execution see the documentation of the Connectivity#SetMaterializedAttribute method.

Parameters:
s [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 connected components found in the graph.


Member Function Documentation

sparksee::gdb::int64_t ConnectedComponents::GetConnectedComponent ( sparksee::gdb::oid_t  idNode  ) 

Returns the connected component where the given node belongs to.

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

sparksee::gdb::int64_t ConnectedComponents::GetCount (  ) 

Returns the number of connected components found in the graph.

Returns:
The number of connected components found in the graph.

sparksee::gdb::Objects* ConnectedComponents::GetNodes ( sparksee::gdb::int64_t  idConnectedComponent  ) 

Returns the collection of nodes contained in the given connected component.

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

sparksee::gdb::int64_t ConnectedComponents::GetSize ( sparksee::gdb::int64_t  idConnectedComponent  ) 

Returns the number of nodes contained in the given connected component.

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


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