agi.foundation.propagators

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

Enum TransitionType

java.lang.Object

java.lang.Enum<TransitionType>

agi.foundation.propagators.TransitionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TransitionType>

public enum TransitionType
extends Enum<TransitionType>
implements Enumeration

An enumeration that defines the format of transformation described by a StateTransitionMatrix.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EPOCH_TRANSITION The state transition matrix will first equal the InitialStateTransitionMatrix (get / set) at the propagation epoch and will integrate continuously throughout propagation.
PIECEWISE_TRANSITION Every time step the StateTransitionMatrix will be reverted to the Identity matrix prior to propagation.

Method Summary

Modifier and Type	Method and Description
static TransitionType	getDefault() Get the enum constant that is considered to be the default.
static TransitionType	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 TransitionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransitionType[]	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

EPOCH_TRANSITION

public static final TransitionType EPOCH_TRANSITION

The state transition matrix will first equal the InitialStateTransitionMatrix (get / set) at the propagation epoch and will integrate continuously throughout propagation. This means that the StateTransitionMatrix at each time step will be the matrix that transitions from the initial epoch to that time step.

PIECEWISE_TRANSITION

public static final TransitionType PIECEWISE_TRANSITION

Every time step the StateTransitionMatrix will be reverted to the Identity matrix prior to propagation. This means that the StateTransitionMatrix at each time step will transition the state from the previous time step to that current time step.

Method Detail

values

public static TransitionType[] 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 (TransitionType c : TransitionType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TransitionType 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 TransitionType 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 TransitionType getDefault()

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

Returns:

The default enum constant.