org.carrot2.output.metrics
Interface IClusteringMetric

All Known Implementing Classes:

ContaminationMetric, NormalizedMutualInformationMetric, PrecisionRecallMetric

public interface IClusteringMetric

A clustering quality metric. Calculates some metric reflecting the quality of clustering. This interface does not impose any specific constraints on the values of the metric, such as type and range. Instead, specific implementations should annotate the values to be returned with Output Processing Attribute.

Method Summary

void	calculate() Triggers calculation of the metric.
boolean	isEnabled() Return true if this metric should be calculated.

Method Detail

calculate

void calculate()

Triggers calculation of the metric. All Processing Input attributes will have been bound before a call to this method.

isEnabled

boolean isEnabled()

Return true if this metric should be calculated.