io.improbable.keanu.algorithms.variational.optimizer

Enum ConvergenceChecker.Norm

java.lang.Object

java.lang.Enum<ConvergenceChecker.Norm>

io.improbable.keanu.algorithms.variational.optimizer.ConvergenceChecker.Norm

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConvergenceChecker.Norm>

Enclosing interface:

ConvergenceChecker

public static enum ConvergenceChecker.Norm
extends java.lang.Enum<ConvergenceChecker.Norm>

Enum Constant Summary

Enum Constants

Enum Constant and Description
L2
MAX

Method Summary

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

L2

public static final ConvergenceChecker.Norm L2

MAX

public static final ConvergenceChecker.Norm MAX

Method Detail

values

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

Returns:

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

valueOf

public static ConvergenceChecker.Norm 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