weka.core.stats

Enum ArffSummaryNumericMetric

java.lang.Object

java.lang.Enum<ArffSummaryNumericMetric>

weka.core.stats.ArffSummaryNumericMetric

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ArffSummaryNumericMetric>

public enum ArffSummaryNumericMetric
extends java.lang.Enum<ArffSummaryNumericMetric>

An enumerated utility type for the various numeric summary metrics that are computed.

Version:

$Revision: 10929 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNT
FIRSTQUARTILE
MAX
MEAN
MEDIAN
MIN
MISSING
STDDEV
SUM
SUMSQ
THIRDQUARTILE

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	makeAttributeValue(double value) Makes the internal encoded version of this metric given it's value as a double
java.lang.String	toString()
double	toValue(java.lang.String v, java.lang.String name) Extracts the value of the metric from the string representation
abstract double	valueFromAttribute(weka.core.Attribute att) Extracts the value of this particular metric from the summary Attribute
static ArffSummaryNumericMetric	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ArffSummaryNumericMetric[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COUNT

public static final ArffSummaryNumericMetric COUNT

SUM

public static final ArffSummaryNumericMetric SUM

SUMSQ

public static final ArffSummaryNumericMetric SUMSQ

MIN

public static final ArffSummaryNumericMetric MIN

MAX

public static final ArffSummaryNumericMetric MAX

MISSING

public static final ArffSummaryNumericMetric MISSING

MEAN

public static final ArffSummaryNumericMetric MEAN

STDDEV

public static final ArffSummaryNumericMetric STDDEV

FIRSTQUARTILE

public static final ArffSummaryNumericMetric FIRSTQUARTILE

MEDIAN

public static final ArffSummaryNumericMetric MEDIAN

THIRDQUARTILE

public static final ArffSummaryNumericMetric THIRDQUARTILE

Method Detail

values

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

Returns:

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

valueOf

public static ArffSummaryNumericMetric 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

valueFromAttribute

public abstract double valueFromAttribute(weka.core.Attribute att)

Extracts the value of this particular metric from the summary Attribute

Parameters:

att - the summary attribute to extract the metric from

Returns:

the value of this particular metric

makeAttributeValue

public abstract java.lang.String makeAttributeValue(double value)

Makes the internal encoded version of this metric given it's value as a double

Parameters:

value - the value of the metric

Returns:

the internal representation of this metric

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ArffSummaryNumericMetric>

toValue

public double toValue(java.lang.String v,
                      java.lang.String name)

Extracts the value of the metric from the string representation

Parameters:

v - the string representation

name - the name of the attribute that the metric belongs to

Returns:

the value of the metric