agi.foundation.propagators

(agi.foundation.models-2024r2.jar)

Enum PropagationStage

java.lang.Object

java.lang.Enum<PropagationStage>

agi.foundation.propagators.PropagationStage

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PropagationStage>

public enum PropagationStage
extends Enum<PropagationStage>
implements Enumeration

An enumerator that communicates the which stage of propagation an evaluator is called during.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CORRECTION_AFTER_STEP The call occurs at the end of the step, after propagation.
OUTSIDE_OF_PROPAGATION This signifies that the evaluation was not made as part of propagation.
PROPAGATION_STEP The call occurs during propagation.
UPDATE_PRIOR_TO_STEP The call occurs at the beginning of the step, prior to propagation.

Method Summary

Modifier and Type	Method and Description
static PropagationStage	getDefault() Get the enum constant that is considered to be the default.
static PropagationStage	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static PropagationStage	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropagationStage[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UPDATE_PRIOR_TO_STEP

public static final PropagationStage UPDATE_PRIOR_TO_STEP

The call occurs at the beginning of the step, prior to propagation.

PROPAGATION_STEP

public static final PropagationStage PROPAGATION_STEP

The call occurs during propagation.

CORRECTION_AFTER_STEP

public static final PropagationStage CORRECTION_AFTER_STEP

The call occurs at the end of the step, after propagation.

OUTSIDE_OF_PROPAGATION

public static final PropagationStage OUTSIDE_OF_PROPAGATION

This signifies that the evaluation was not made as part of propagation.

Method Detail

values

public static PropagationStage[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropagationStage c : PropagationStage.values())
    System.out.println(c);

Returns:

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

valueOf

public static PropagationStage valueOf(String name)

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

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static PropagationStage getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static PropagationStage getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.