Package edu.cmu.tetrad.search.utils

Enum Class ClusterSignificance.CheckType

java.lang.Object

java.lang.Enum<ClusterSignificance.CheckType>

edu.cmu.tetrad.search.utils.ClusterSignificance.CheckType

All Implemented Interfaces:

Serializable, Comparable<ClusterSignificance.CheckType>, Constable

Enclosing class:

ClusterSignificance

public static enum ClusterSignificance.CheckType
extends Enum<ClusterSignificance.CheckType>

Gives the options for checking significance of clusters--could check the significance using a regression model, or could check to see if the cluster is a clique, or could not do the check.

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
Clique	Check to see if the cluster is a clique.
None	Do not do the check.
Significance	Check the significance using a regression model.

Method Summary

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

Significance

public static final ClusterSignificance.CheckType Significance

Check the significance using a regression model.

Clique

public static final ClusterSignificance.CheckType Clique

Check to see if the cluster is a clique.

None

public static final ClusterSignificance.CheckType None

Do not do the check.

Method Details

values

public static ClusterSignificance.CheckType[] 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 ClusterSignificance.CheckType 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