adams.flow.core
Enum EvaluationStatistic

java.lang.Object
  extended by java.lang.Enum<EvaluationStatistic>
      extended by adams.flow.core.EvaluationStatistic
All Implemented Interfaces:
EnumWithCustomDisplay<EvaluationStatistic>, Serializable, Comparable<EvaluationStatistic>

public enum EvaluationStatistic
extends Enum<EvaluationStatistic>
implements EnumWithCustomDisplay<EvaluationStatistic>

The enumeration for the comparison field.

Version:
$Revision: 5637 $
Author:
fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary
AREA_UNDER_PRC
           
AREA_UNDER_ROC
           
CORRELATION_COEFFICIENT
           
F_MEASURE
           
FALSE_NEGATIVE_RATE
           
FALSE_POSITIVE_RATE
           
IR_PRECISION
           
IR_RECALL
           
KAPPA_STATISTIC
           
KB_INFORMATION
           
KB_MEAN_INFORMATION
           
KB_RELATIVE_INFORMATION
           
MATTHEWS_CORRELATION_COEFFICIENT
           
MEAN_ABSOLUTE_ERROR
           
NUM_FALSE_NEGATIVES
           
NUM_FALSE_POSITIVES
           
NUM_TRUE_NEGATIVES
           
NUM_TRUE_POSITIVES
           
NUMBER_CORRECT
           
NUMBER_INCORRECT
           
NUMBER_UNCLASSIFIED
           
PERCENT_CORRECT
           
PERCENT_INCORRECT
           
PERCENT_UNCLASSIFIED
           
RELATIVE_ABSOLUTE_ERROR
           
ROOT_MEAN_SQUARED_ERROR
           
ROOT_RELATIVE_SQUARED_ERROR
           
SF_ENTROPY_GAIN
           
SF_MEAN_ENTROPY_GAIN
           
SF_MEAN_PRIOR_ENTROPY
           
SF_MEAN_SCHEME_ENTROPY
           
SF_PRIOR_ENTROPY
           
SF_SCHEME_ENTROPY
           
TRUE_NEGATIVE_RATE
           
TRUE_POSITIVE_RATE
           
WEIGHTED_AREA_UNDER_PRC
           
WEIGHTED_AREA_UNDER_ROC
           
WEIGHTED_F_MEASURE
           
WEIGHTED_FALSE_NEGATIVE_RATE
           
WEIGHTED_FALSE_POSITIVE_RATE
           
WEIGHTED_IR_PRECISION
           
WEIGHTED_IR_RECALL
           
WEIGHTED_MATTHEWS_CORRELATION_COEFFICIENT
           
WEIGHTED_TRUE_NEGATIVE_RATE
           
WEIGHTED_TRUE_POSITIVE_RATE
           
 
Method Summary
 String getField()
          Returns the display string without the "numeric" or "nominal" in parentheses.
 EvaluationStatistic parse(String s)
          Parses the given string and returns the associated enum.
 String toDisplay()
          Returns the display string.
 String toRaw()
          Returns the raw enum string.
 String toString()
          Returns the displays string.
static String toString(AbstractOption option, Object object)
          Returns the enum as string.
static EvaluationStatistic valueOf(AbstractOption option, String str)
          Returns an enum generated from the string.
static EvaluationStatistic valueOf(String name)
          Returns the enum constant of this type with the specified name.
static EvaluationStatistic[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NUMBER_CORRECT

public static final EvaluationStatistic NUMBER_CORRECT

NUMBER_INCORRECT

public static final EvaluationStatistic NUMBER_INCORRECT

NUMBER_UNCLASSIFIED

public static final EvaluationStatistic NUMBER_UNCLASSIFIED

PERCENT_CORRECT

public static final EvaluationStatistic PERCENT_CORRECT

PERCENT_INCORRECT

public static final EvaluationStatistic PERCENT_INCORRECT

PERCENT_UNCLASSIFIED

public static final EvaluationStatistic PERCENT_UNCLASSIFIED

KAPPA_STATISTIC

public static final EvaluationStatistic KAPPA_STATISTIC

MEAN_ABSOLUTE_ERROR

public static final EvaluationStatistic MEAN_ABSOLUTE_ERROR

ROOT_MEAN_SQUARED_ERROR

public static final EvaluationStatistic ROOT_MEAN_SQUARED_ERROR

RELATIVE_ABSOLUTE_ERROR

public static final EvaluationStatistic RELATIVE_ABSOLUTE_ERROR

ROOT_RELATIVE_SQUARED_ERROR

public static final EvaluationStatistic ROOT_RELATIVE_SQUARED_ERROR

CORRELATION_COEFFICIENT

public static final EvaluationStatistic CORRELATION_COEFFICIENT

SF_PRIOR_ENTROPY

public static final EvaluationStatistic SF_PRIOR_ENTROPY

SF_SCHEME_ENTROPY

public static final EvaluationStatistic SF_SCHEME_ENTROPY

SF_ENTROPY_GAIN

public static final EvaluationStatistic SF_ENTROPY_GAIN

SF_MEAN_PRIOR_ENTROPY

public static final EvaluationStatistic SF_MEAN_PRIOR_ENTROPY

SF_MEAN_SCHEME_ENTROPY

public static final EvaluationStatistic SF_MEAN_SCHEME_ENTROPY

SF_MEAN_ENTROPY_GAIN

public static final EvaluationStatistic SF_MEAN_ENTROPY_GAIN

KB_INFORMATION

public static final EvaluationStatistic KB_INFORMATION

KB_MEAN_INFORMATION

public static final EvaluationStatistic KB_MEAN_INFORMATION

KB_RELATIVE_INFORMATION

public static final EvaluationStatistic KB_RELATIVE_INFORMATION

TRUE_POSITIVE_RATE

public static final EvaluationStatistic TRUE_POSITIVE_RATE

NUM_TRUE_POSITIVES

public static final EvaluationStatistic NUM_TRUE_POSITIVES

FALSE_POSITIVE_RATE

public static final EvaluationStatistic FALSE_POSITIVE_RATE

NUM_FALSE_POSITIVES

public static final EvaluationStatistic NUM_FALSE_POSITIVES

TRUE_NEGATIVE_RATE

public static final EvaluationStatistic TRUE_NEGATIVE_RATE

NUM_TRUE_NEGATIVES

public static final EvaluationStatistic NUM_TRUE_NEGATIVES

FALSE_NEGATIVE_RATE

public static final EvaluationStatistic FALSE_NEGATIVE_RATE

NUM_FALSE_NEGATIVES

public static final EvaluationStatistic NUM_FALSE_NEGATIVES

IR_PRECISION

public static final EvaluationStatistic IR_PRECISION

IR_RECALL

public static final EvaluationStatistic IR_RECALL

F_MEASURE

public static final EvaluationStatistic F_MEASURE

MATTHEWS_CORRELATION_COEFFICIENT

public static final EvaluationStatistic MATTHEWS_CORRELATION_COEFFICIENT

AREA_UNDER_ROC

public static final EvaluationStatistic AREA_UNDER_ROC

AREA_UNDER_PRC

public static final EvaluationStatistic AREA_UNDER_PRC

WEIGHTED_TRUE_POSITIVE_RATE

public static final EvaluationStatistic WEIGHTED_TRUE_POSITIVE_RATE

WEIGHTED_FALSE_POSITIVE_RATE

public static final EvaluationStatistic WEIGHTED_FALSE_POSITIVE_RATE

WEIGHTED_TRUE_NEGATIVE_RATE

public static final EvaluationStatistic WEIGHTED_TRUE_NEGATIVE_RATE

WEIGHTED_FALSE_NEGATIVE_RATE

public static final EvaluationStatistic WEIGHTED_FALSE_NEGATIVE_RATE

WEIGHTED_IR_PRECISION

public static final EvaluationStatistic WEIGHTED_IR_PRECISION

WEIGHTED_IR_RECALL

public static final EvaluationStatistic WEIGHTED_IR_RECALL

WEIGHTED_F_MEASURE

public static final EvaluationStatistic WEIGHTED_F_MEASURE

WEIGHTED_MATTHEWS_CORRELATION_COEFFICIENT

public static final EvaluationStatistic WEIGHTED_MATTHEWS_CORRELATION_COEFFICIENT

WEIGHTED_AREA_UNDER_ROC

public static final EvaluationStatistic WEIGHTED_AREA_UNDER_ROC

WEIGHTED_AREA_UNDER_PRC

public static final EvaluationStatistic WEIGHTED_AREA_UNDER_PRC
Method Detail

values

public static EvaluationStatistic[] 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 (EvaluationStatistic c : EvaluationStatistic.values())
    System.out.println(c);

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

valueOf

public static EvaluationStatistic valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

toDisplay

public String toDisplay()
Returns the display string.

Specified by:
toDisplay in interface EnumWithCustomDisplay<EvaluationStatistic>
Returns:
the display string

toRaw

public String toRaw()
Returns the raw enum string.

Specified by:
toRaw in interface EnumWithCustomDisplay<EvaluationStatistic>
Returns:
the raw enum string

parse

public EvaluationStatistic parse(String s)
Parses the given string and returns the associated enum.

Specified by:
parse in interface EnumWithCustomDisplay<EvaluationStatistic>
Parameters:
s - the string to parse
Returns:
the enum or null if not found

getField

public String getField()
Returns the display string without the "numeric" or "nominal" in parentheses.

Returns:
the field string

toString

public String toString()
Returns the displays string.

Overrides:
toString in class Enum<EvaluationStatistic>
Returns:
the display string

toString

public static String toString(AbstractOption option,
                              Object object)
Returns the enum as string.

Parameters:
option - the current option
object - the enum object to convert
Returns:
the generated string

valueOf

public static EvaluationStatistic valueOf(AbstractOption option,
                                          String str)
Returns an enum generated from the string.

Parameters:
option - the current option
str - the string to convert to an enum
Returns:
the generated enum or null in case of error


Copyright © 2012 University of Waikato, Hamilton, NZ. All Rights Reserved.