de.aitools.dm.clusterlabeling.validation.internal.measure
Class CumulativeGain

java.lang.Object
  de.aitools.dm.clusterlabeling.validation.internal.measure.CumulativeGain

All Implemented Interfaces:

InternMeasure

public class CumulativeGain
extends java.lang.Object
implements InternMeasure

Summing the gain. Depends on CumulationType given on constructing, SIMPLE being the default. See CumulativeGain.CumulationType for more information.

Version:

$Id: CumulativeGain.java,v 1.1 2011/02/18 16:08:24 hoppe Exp $

Author:

johannes.kiesel(/\t)uni-weimar.de

Nested Class Summary

static class

CumulativeGain.CumulationType SIMPLE: Simple calculation of the sum of the gain of each RatedPhrase DISCOUNTED Effect of labels decrease with their rank, as their gain is multiplied by a factor of 1 / log2(rank + 1) NORMALIZED_DISCOUNTED As Discounted, but calculated sum divided by the maximum DiscountedCumulativeGain (DCG), that means the one with the best ordering of labels

Constructor Summary

CumulativeGain()

CumulativeGain(CumulativeGain.CumulationType cumulationType)

Method Summary

double	evalClusterLabels(RatedPhrase[] clusterLabels) This will set the clusterLabels to be used on validation and the evaluate those labels via the corresponding gain.
CumulativeGain.CumulationType	getCumulationType()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CumulativeGain

public CumulativeGain()

CumulativeGain

public CumulativeGain(CumulativeGain.CumulationType cumulationType)

Method Detail

getCumulationType

public CumulativeGain.CumulationType getCumulationType()

evalClusterLabels

public double evalClusterLabels(RatedPhrase[] clusterLabels)

Description copied from interface: InternMeasure

This will set the clusterLabels to be used on validation and the evaluate those labels via the corresponding gain.
Attention: The return-value may vary significantly in its meaning depending on the implementation. Higher values should suggest closer pairs.

Specified by:

evalClusterLabels in interface InternMeasure