smile.validation

Class MutualInformation

java.lang.Object

smile.validation.MutualInformation

All Implemented Interfaces:

ClusterMeasure

public class MutualInformation
extends java.lang.Object
implements ClusterMeasure

Mutual Information for comparing clustering.

References

1. X. Vinh, J. Epps, J. Bailey. Information Theoretic Measures for Clusterings Comparison: Variants, Properties, Normalization and Correction for Chance. JMLR, 2010.

Field Summary

Fields

Modifier and Type	Field and Description
static MutualInformation	instance

Constructor Summary

Constructors

Constructor and Description
MutualInformation()

Method Summary

Modifier and Type	Method and Description
double	measure(int[] y1, int[] y2) Returns an index to measure the quality of clustering.
static double	of(int[] y1, int[] y2) Calculates the mutual information.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

instance

public static final MutualInformation instance

Constructor Detail

MutualInformation

public MutualInformation()

Method Detail

measure

public double measure(int[] y1,
                      int[] y2)

Description copied from interface: ClusterMeasure

Returns an index to measure the quality of clustering.

Specified by:

measure in interface ClusterMeasure

Parameters:

y1 - the cluster labels.

y2 - the alternative cluster labels.

of

public static double of(int[] y1,
                        int[] y2)

Calculates the mutual information.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object