Class OverlappingNMIDistance

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class OverlappingNMIDistance : public NetworKit::DissimilarityMeasure

Compare two covers using the overlapping normalized mutual information measure. This is a dissimilarity measure with a range of [0, 1]. A value of 0 indicates a perfect agreement while a 1 indicates complete disagreement.

For the MAX normalization, this is the measure introduced in [NMI13]. Other normalization methods result in similar measures.

Please note that non-overlapping NMIDistance uses another definition of the normalized mutual information. See NMIDistance for details on its computation. Both NMIDistance and OverlappingNMIDistance can be used with partitions, but produce different values.

[NMI13] McDaid, Aaron F., Derek Greene, and Neil Hurley. “Normalized Mutual Information to Evaluate Overlapping Community Finding Algorithms.” ArXiv:1110.2515 [Physics], August 2, 2013. http://arxiv.org/abs/1110.2515.

Public Types

enum Normalization

Values:

enumerator MIN
enumerator GEOMETRIC_MEAN
enumerator ARITHMETIC_MEAN
enumerator MAX
enumerator JOINT_ENTROPY

Public Functions

OverlappingNMIDistance() = default
inline explicit OverlappingNMIDistance(Normalization normalization)
inline void setNormalization(Normalization normalization)
virtual double getDissimilarity(const Graph &G, const Partition &zeta, const Partition &eta) override
virtual double getDissimilarity(const Graph &G, const Cover &zeta, const Cover &eta) override