Package edu.cmu.tetrad.sem

Enum Class AdditiveAnmSimulator.Family

java.lang.Object

java.lang.Enum<AdditiveAnmSimulator.Family>

edu.cmu.tetrad.sem.AdditiveAnmSimulator.Family

All Implemented Interfaces:

Serializable, Comparable<AdditiveAnmSimulator.Family>, Constable

Enclosing class:

AdditiveAnmSimulator

public static enum AdditiveAnmSimulator.Family
extends Enum<AdditiveAnmSimulator.Family>

Represents the type of function family used in the additive noise model (ANM) simulation. The function family determines the mathematical form of the functions applied on graph edges during the simulation. Each family corresponds to a distinct functional model:

This enum is primarily utilized in the configuration and behavior of the AdditiveAnmSimulator class to specify the desired structure for edge functions.

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
POLY	Polynomial Functions, represented as a sum of powers of the input.
RBF	Radial Basis Functions, a sum of exponential terms.
TANH	Hyperbolic Tangent Functions, a sum of tanh-based terms.

Method Summary

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

RBF

public static final AdditiveAnmSimulator.Family RBF

Radial Basis Functions, a sum of exponential terms.

TANH

public static final AdditiveAnmSimulator.Family TANH

Hyperbolic Tangent Functions, a sum of tanh-based terms.

POLY

public static final AdditiveAnmSimulator.Family POLY

Polynomial Functions, represented as a sum of powers of the input.

Method Details

values

public static AdditiveAnmSimulator.Family[] 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 AdditiveAnmSimulator.Family 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