Package edu.cmu.tetrad.search

Enum Class FaskOrig.LeftRight

java.lang.Object

java.lang.Enum<FaskOrig.LeftRight>

edu.cmu.tetrad.search.FaskOrig.LeftRight

All Implemented Interfaces:

Serializable, Comparable<FaskOrig.LeftRight>, Constable

Enclosing class:

FaskOrig

public static enum FaskOrig.LeftRight
extends Enum<FaskOrig.LeftRight>

Enumerates the options left-right rules to use for FASK. Options include the FASK left-right rule and three left-right rules from the Hyvarinen and Smith pairwise orientation paper: Robust Skew, Skew, and Tanh. In that paper, "empirical" versions were given in which the variables are multiplied through by the signs of the skewnesses; we follow this advice here (with good results). These others are provided for those who prefer them.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FASK1	The original FASK left-right rule.
FASK2	The modified FASK left-right rule.
RSKEW	The robust skew rule from the Hyvarinen and Smith paper.
SKEW	The skew rule from the Hyvarinen and Smith paper.
TANH	The tanh rule from the Hyvarinen and Smith paper.

Method Summary

Modifier and Type	Method	Description
static FaskOrig.LeftRight	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FaskOrig.LeftRight[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FASK1

public static final FaskOrig.LeftRight FASK1

The original FASK left-right rule.

FASK2

public static final FaskOrig.LeftRight FASK2

The modified FASK left-right rule.

RSKEW

public static final FaskOrig.LeftRight RSKEW

The robust skew rule from the Hyvarinen and Smith paper.

SKEW

public static final FaskOrig.LeftRight SKEW

The skew rule from the Hyvarinen and Smith paper.

TANH

public static final FaskOrig.LeftRight TANH

The tanh rule from the Hyvarinen and Smith paper.

Method Details

values

public static FaskOrig.LeftRight[] 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 FaskOrig.LeftRight 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