All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
NetworKit::ParallelAgglomerativeClusterer Class Reference

A parallel agglomerative community detection algorithm, maximizing modularity. More...

#include <ParallelAgglomerativeClusterer.h>

Public Member Functions

 ParallelAgglomerativeClusterer (const Graph &G)
 Constructor to the parallel agglomerative clusterer. More...
 
virtual void run ()
 Detect communities. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from NetworKit::CommunityDetectionAlgorithm
 CommunityDetectionAlgorithm (const Graph &G)
 A community detection algorithm operates on a graph, so the constructor expects a graph. More...
 
 CommunityDetectionAlgorithm (const Graph &G, const Partition baseClustering)
 A community detection algorithm operates on a graph, so the constructor expects a graph. More...
 
virtual ~CommunityDetectionAlgorithm ()=default
 Default destructor. More...
 
virtual Partition getPartition ()
 Returns the result of the run method or throws an error, if the algorithm hasn't run yet. More...
 
- Public Member Functions inherited from NetworKit::Algorithm
 Algorithm ()
 Constructor to the algorithm base class. More...
 
virtual ~Algorithm ()=default
 Virtual default destructor. More...
 
bool hasFinished () const
 Indicates whether an algorithm has completed computation or not. More...
 
void assureFinished () const
 Assure that the algorithm has been run, throws a std::runtime_error otherwise. More...
 
virtual bool isParallel () const
 

Additional Inherited Members

- Protected Attributes inherited from NetworKit::CommunityDetectionAlgorithm
const GraphG
 
Partition result
 
- Protected Attributes inherited from NetworKit::Algorithm
bool hasRun
 A boolean variable indicating whether an algorithm has finished its computation or not. More...
 

Detailed Description

A parallel agglomerative community detection algorithm, maximizing modularity.

Constructor & Destructor Documentation

NetworKit::ParallelAgglomerativeClusterer::ParallelAgglomerativeClusterer ( const Graph G)

Constructor to the parallel agglomerative clusterer.

Parameters
[in]Ginput graph

Member Function Documentation

void NetworKit::ParallelAgglomerativeClusterer::run ( )
virtual

Detect communities.

< threshold for minimum number of matching edges relative to number of vertices to proceed agglomeration

Implements NetworKit::CommunityDetectionAlgorithm.

std::string NetworKit::ParallelAgglomerativeClusterer::toString ( ) const
virtual
Returns
string representation of algorithm and parameters.

Reimplemented from NetworKit::CommunityDetectionAlgorithm.


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