Package com.bayesserver.inference

Enum QueryDistance

java.lang.Object

java.lang.Enum<QueryDistance>

com.bayesserver.inference.QueryDistance

All Implemented Interfaces:

Serializable, Comparable<QueryDistance>

public enum QueryDistance
extends Enum<QueryDistance>

Type of distance to calculate for a query.

Enum Constant Summary

Enum Constants

Enum Constant	Description
J_S_DIVERGENCE_BITS	Jensen Shannon divergence, JSD(P||Q) measured in BITS
K_L_DIVERGENCE	Kullback-Leibler divergence, D(P||Q) where Q is calculated using Base Evidence (or no evidence), and P is calculated from the standard evidence.
NONE	No distance is calculated.

Method Summary

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

NONE

public static final QueryDistance NONE

No distance is calculated.

K_L_DIVERGENCE

public static final QueryDistance K_L_DIVERGENCE

Kullback-Leibler divergence, D(P||Q) where Q is calculated using Base Evidence (or no evidence), and P is calculated from the standard evidence.

J_S_DIVERGENCE_BITS

public static final QueryDistance J_S_DIVERGENCE_BITS

Jensen Shannon divergence, JSD(P||Q) measured in BITS

Method Detail

values

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

Returns:

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

valueOf

public static QueryDistance valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null