smile.validation.metric

Enum NormalizedMutualInformation.Method

java.lang.Object

java.lang.Enum<NormalizedMutualInformation.Method>

smile.validation.metric.NormalizedMutualInformation.Method

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NormalizedMutualInformation.Method>

Enclosing class:

NormalizedMutualInformation

public static enum NormalizedMutualInformation.Method
extends java.lang.Enum<NormalizedMutualInformation.Method>

The normalization method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JOINT I(y1, y2) / H(y1, y2)
MAX I(y1, y2) / max(H(y1), H(y2))
MIN I(y1, y2) / min(H(y1), H(y2))
SQRT I(y1, y2) / sqrt(H(y1) * H(y2))
SUM 2 * I(y1, y2) / (H(y1) + H(y2))

Method Summary

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

JOINT

public static final NormalizedMutualInformation.Method JOINT

I(y1, y2) / H(y1, y2)

MAX

public static final NormalizedMutualInformation.Method MAX

I(y1, y2) / max(H(y1), H(y2))

MIN

public static final NormalizedMutualInformation.Method MIN

I(y1, y2) / min(H(y1), H(y2))

SUM

public static final NormalizedMutualInformation.Method SUM

2 * I(y1, y2) / (H(y1) + H(y2))

SQRT

public static final NormalizedMutualInformation.Method SQRT

I(y1, y2) / sqrt(H(y1) * H(y2))

Method Detail

values

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

Returns:

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

valueOf

public static NormalizedMutualInformation.Method 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