agi.foundation.numericalmethods

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

Enum IntegrationSense

java.lang.Object

java.lang.Enum<IntegrationSense>

agi.foundation.numericalmethods.IntegrationSense

All Implemented Interfaces:

Enumeration, Serializable, Comparable<IntegrationSense>

public enum IntegrationSense
extends Enum<IntegrationSense>
implements Enumeration

Indicates whether the integration proceeds with the independent variable increasing or decreasing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECREASING Apply the step backward so that the final independent variable value is less than the initial independent variable value.
INCREASING Apply the step forward so that the final independent variable value is greater than the initial independent variable value.

Method Summary

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

INCREASING

public static final IntegrationSense INCREASING

Apply the step forward so that the final independent variable value is greater than the initial independent variable value.

DECREASING

public static final IntegrationSense DECREASING

Apply the step backward so that the final independent variable value is less than the initial independent variable value.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.