org.encog.mathutil.error

Enum ErrorCalculationMode

java.lang.Object

java.lang.Enum<ErrorCalculationMode>

org.encog.mathutil.error.ErrorCalculationMode

All Implemented Interfaces:

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

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

Selects the error calculation mode for Encog.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESS Sum of Squares error.
HOT_LOGLOSS Log loss (one-hot encoding/one-of-n encoding) Use for neural networks.
LOGLOSS Log loss (one-hot encoding/one-of-n encoding) Use for models other than neural networks.
MSE Mean square error.
NRMSE_MEAN
NRMSE_RANGE
RMS Root mean square error.

Method Summary

Modifier and Type	Method and Description
static ErrorCalculationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ErrorCalculationMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RMS

public static final ErrorCalculationMode RMS

Root mean square error.

MSE

public static final ErrorCalculationMode MSE

Mean square error.

ESS

public static final ErrorCalculationMode ESS

Sum of Squares error.

HOT_LOGLOSS

public static final ErrorCalculationMode HOT_LOGLOSS

Log loss (one-hot encoding/one-of-n encoding) Use for neural networks.

LOGLOSS

public static final ErrorCalculationMode LOGLOSS

Log loss (one-hot encoding/one-of-n encoding) Use for models other than neural networks.

NRMSE_MEAN

public static final ErrorCalculationMode NRMSE_MEAN

NRMSE_RANGE

public static final ErrorCalculationMode NRMSE_RANGE

Method Detail

values

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

Returns:

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

valueOf

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