Enum Class EdgePriors.Semantics

java.lang.Object

java.lang.Enum<EdgePriors.Semantics>

edu.cmu.tetrad.search.utils.EdgePriors.Semantics

All Implemented Interfaces:

Serializable, Comparable<EdgePriors.Semantics>, Constable

Enclosing class:

EdgePriors

public static enum EdgePriors.Semantics
extends Enum<EdgePriors.Semantics>

What the stored numbers mean.

Author:

josephramsey

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOG_ODDS	Prior log-odds beta_ij; neutral element 0.
WEIGHTS	Multiplicative p-value weights w_ij; neutral element 1.

Method Summary

Modifier and Type	Method	Description
double	neutral()	Returns the neutral (no-information) value for this semantics.
static EdgePriors.Semantics	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EdgePriors.Semantics[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOG_ODDS

public static final EdgePriors.Semantics LOG_ODDS

Prior log-odds beta_ij; neutral element 0.

WEIGHTS

public static final EdgePriors.Semantics WEIGHTS

Multiplicative p-value weights w_ij; neutral element 1.

Method Details

values

public static EdgePriors.Semantics[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EdgePriors.Semantics valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

neutral

public double neutral()

Returns the neutral (no-information) value for this semantics.

Returns:

0 for LOG_ODDS, 1 for WEIGHTS.