io.improbable.keanu.algorithms.mcmc.nuts

Enum NUTS.Metrics

java.lang.Object

java.lang.Enum<NUTS.Metrics>

io.improbable.keanu.algorithms.mcmc.nuts.NUTS.Metrics

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NUTS.Metrics>

Enclosing class:

NUTS

public static enum NUTS.Metrics
extends java.lang.Enum<NUTS.Metrics>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIVERGENT_SAMPLE
LOG_PROB
MEAN_TREE_ACCEPT
STEPSIZE
TREE_SIZE

Method Summary

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

STEPSIZE

public static final NUTS.Metrics STEPSIZE

LOG_PROB

public static final NUTS.Metrics LOG_PROB

MEAN_TREE_ACCEPT

public static final NUTS.Metrics MEAN_TREE_ACCEPT

TREE_SIZE

public static final NUTS.Metrics TREE_SIZE

DIVERGENT_SAMPLE

public static final NUTS.Metrics DIVERGENT_SAMPLE

Method Detail

values

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

Returns:

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

valueOf

public static NUTS.Metrics 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