Package edu.cmu.tetrad.search

Enum Class Ftfc.Algorithm

java.lang.Object

java.lang.Enum<Ftfc.Algorithm>

edu.cmu.tetrad.search.Ftfc.Algorithm

All Implemented Interfaces:

Serializable, Comparable<Ftfc.Algorithm>, Constable

Enclosing class:

Ftfc

public static enum Ftfc.Algorithm
extends Enum<Ftfc.Algorithm>

Gives the options to be used in FOFC to sort through the various possibilities for forming clusters to find the best options. SAG (Seed and Grow) looks for good seed clusters and then grows them by adding one variable at a time. GAP (Grow and Pick) grows out all the cluster initially and then just picks from among these. SAG is generally faster; GAP is generally slower but more accurate.

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
GAP	The GAP algorithm.
SAG	The SAG algorithm.

Method Summary

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

SAG

public static final Ftfc.Algorithm SAG

The SAG algorithm.

GAP

public static final Ftfc.Algorithm GAP

The GAP algorithm.

Method Details

values

public static Ftfc.Algorithm[] 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 Ftfc.Algorithm 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