agi.foundation.numericalmethods

(agi.foundation.segmentpropagation-2024r1.jar)

Enum ScalarConstraintDifference

java.lang.Object

java.lang.Enum<ScalarConstraintDifference>

agi.foundation.numericalmethods.ScalarConstraintDifference

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ScalarConstraintDifference>

public enum ScalarConstraintDifference
extends Enum<ScalarConstraintDifference>
implements Enumeration

Specifies the manner in which the difference is computed. This applies to the scalar, ScalarDifferenceOfSegmentConstraint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE_VALUE Use the absolute value of the difference between the final and initial state.
FINAL_MINUS_INITIAL Use the value at the segment's final state minus the value at the initial state.
INITIAL_MINUS_FINAL Use the value at the segment's initial state minus the value at the final state.

Method Summary

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

FINAL_MINUS_INITIAL

public static final ScalarConstraintDifference FINAL_MINUS_INITIAL

Use the value at the segment's final state minus the value at the initial state.

INITIAL_MINUS_FINAL

public static final ScalarConstraintDifference INITIAL_MINUS_FINAL

Use the value at the segment's initial state minus the value at the final state.

ABSOLUTE_VALUE

public static final ScalarConstraintDifference ABSOLUTE_VALUE

Use the absolute value of the difference between the final and initial state.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.