agi.foundation.numericalmethods

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

Enum KindOfStepSize

java.lang.Object

java.lang.Enum<KindOfStepSize>

agi.foundation.numericalmethods.KindOfStepSize

All Implemented Interfaces:

Enumeration, Serializable, Comparable<KindOfStepSize>

public enum KindOfStepSize
extends Enum<KindOfStepSize>
implements Enumeration

Indicates what kind of behavior the step size will have during integration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED Maintain a given step size from one step to the next.
RELATIVE Update the step size relative to the error in the process of integration.

Method Summary

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

FIXED

public static final KindOfStepSize FIXED

Maintain a given step size from one step to the next.

RELATIVE

public static final KindOfStepSize RELATIVE

Update the step size relative to the error in the process of integration.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.