de.aitools.dm.clusterlabeling.validation.internal.measure
Enum CumulativeGain.CumulationType

java.lang.Object
  java.lang.Enum<CumulativeGain.CumulationType>
      de.aitools.dm.clusterlabeling.validation.internal.measure.CumulativeGain.CumulationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CumulativeGain.CumulationType>

Enclosing class:

CumulativeGain

public static enum CumulativeGain.CumulationType
extends java.lang.Enum<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

Enum Constant Summary

DISCOUNTED

NORMALIZED_DISCOUNTED

SIMPLE

Method Summary

static CumulativeGain.CumulationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CumulativeGain.CumulationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIMPLE

public static final CumulativeGain.CumulationType SIMPLE

DISCOUNTED

public static final CumulativeGain.CumulationType DISCOUNTED

NORMALIZED_DISCOUNTED

public static final CumulativeGain.CumulationType NORMALIZED_DISCOUNTED

Method Detail

values

public static CumulativeGain.CumulationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CumulativeGain.CumulationType c : CumulativeGain.CumulationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CumulativeGain.CumulationType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null