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

Virtual base class of all evaluation methods for a single Partition which is based on the evaluation of single clusters. More...

#include <LocalPartitionEvaluation.h>

Public Member Functions

 LocalPartitionEvaluation (const Graph &G, const Partition &P)
 Initialize the partition evaluation method. More...
 
- Public Member Functions inherited from NetworKit::LocalCommunityEvaluation
virtual ~LocalCommunityEvaluation ()=default
 Default destructor for the virtual base class. More...
 
double getWeightedAverage () const
 Get the average value weighted by cluster size. More...
 
double getUnweightedAverage () const
 Get the (unweighted) average value of all clusters. More...
 
double getMaximumValue () const
 Get the maximum value of all clusters. More...
 
double getMinimumValue () const
 Get the minimum value of all clusters. More...
 
double getValue (index i) const
 Get the value of the specified cluster. More...
 
std::vector< double > getValues () const
 Get the values of all clusters. More...
 
virtual bool isSmallBetter () const =0
 If small values are better (otherwise large values are better). More...
 
- Public Member Functions inherited from NetworKit::Algorithm
 Algorithm ()
 Constructor to the algorithm base class. More...
 
virtual ~Algorithm ()=default
 Virtual default destructor. More...
 
virtual void run ()=0
 The generic run method which calls runImpl() and takes care of setting to the appropriate value. 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 std::string toString () const
 Returns a string with the algorithm's name and its parameters, if there are any. More...
 
virtual bool isParallel () const
 

Protected Attributes

const GraphG
 
const PartitionP
 
- Protected Attributes inherited from NetworKit::LocalCommunityEvaluation
double weightedAverage
 
double unweightedAverage
 
double maximumValue
 
double minimumValue
 
std::vector< double > values
 
- Protected Attributes inherited from NetworKit::Algorithm
bool hasRun
 A boolean variable indicating whether an algorithm has finished its computation or not. More...
 

Detailed Description

Virtual base class of all evaluation methods for a single Partition which is based on the evaluation of single clusters.

This is the base class for Partitions.

Constructor & Destructor Documentation

NetworKit::LocalPartitionEvaluation::LocalPartitionEvaluation ( const Graph G,
const Partition P 
)

Initialize the partition evaluation method.

Parameters
GThe graph on which the evaluation shall be performed
PThe partition that shall be evaluated.

Member Data Documentation

const Graph& NetworKit::LocalPartitionEvaluation::G
protected
const Partition& NetworKit::LocalPartitionEvaluation::P
protected

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