Class LocalCommunityEvaluation¶

Defined in File LocalCommunityEvaluation.hpp

Inheritance Relationships¶

Base Type¶

public NetworKit::Algorithm (Class Algorithm)

Derived Types¶

public NetworKit::LocalCoverEvaluation (Class LocalCoverEvaluation)
public NetworKit::LocalPartitionEvaluation (Class LocalPartitionEvaluation)

Class Documentation¶

class LocalCommunityEvaluation : public NetworKit::Algorithm ¶

Virtual base class of all evaluation methods for a single clustering which is based on the evaluation of single clusters. This is the base class both for Partitions as well as for Covers.

Subclassed by NetworKit::LocalCoverEvaluation, NetworKit::LocalPartitionEvaluation

Public Functions

~LocalCommunityEvaluation() override = default¶: Default destructor for the virtual base class

inline double getWeightedAverage() const¶

Get the average value weighted by cluster size.

Returns:: The weighted average value.

inline double getUnweightedAverage() const¶

Get the (unweighted) average value of all clusters.

Returns:: The unweighted average value.

inline double getMaximumValue() const¶

Get the maximum value of all clusters.

Returns:: The maximum value.

inline double getMinimumValue() const¶

Get the minimum value of all clusters.

Returns:: The minimum value.

inline double getValue(index i) const¶

Get the value of the specified cluster.

Parameters:: i – The cluster to get the value for.
Returns:: The value of cluster i.

inline std::vector<double> getValues() const¶

Get the values of all clusters.

Returns:: The values of all clusters.

virtual bool isSmallBetter() const = 0¶

If small values are better (otherwise large values are better).

Returns:: If small values are better.

Protected Attributes

double weightedAverage¶

double unweightedAverage¶

double maximumValue¶

double minimumValue¶

std::vector<double> values¶