agi.foundation.numericalmethods

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

Enum InterpolationAlgorithmType

java.lang.Object

java.lang.Enum<InterpolationAlgorithmType>

agi.foundation.numericalmethods.InterpolationAlgorithmType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<InterpolationAlgorithmType>

public enum InterpolationAlgorithmType
extends Enum<InterpolationAlgorithmType>
implements Enumeration

Indicates a type of interpolation algorithm to use when interpolating data.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HERMITE Indicates the use of HermitePolynomialApproximation.
LAGRANGE Indicates the use of LagrangePolynomialApproximation.
LINEAR Indicates the use of LinearApproximation.

Method Summary

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

LAGRANGE

public static final InterpolationAlgorithmType LAGRANGE

Indicates the use of LagrangePolynomialApproximation.

HERMITE

public static final InterpolationAlgorithmType HERMITE

Indicates the use of HermitePolynomialApproximation.

LINEAR

public static final InterpolationAlgorithmType LINEAR

Indicates the use of LinearApproximation.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.