edu.mines.jtk.interp

Enum CubicInterpolator.Method

java.lang.Object

java.lang.Enum<CubicInterpolator.Method>

edu.mines.jtk.interp.CubicInterpolator.Method

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CubicInterpolator.Method>

Enclosing class:

CubicInterpolator

public static enum CubicInterpolator.Method
extends java.lang.Enum<CubicInterpolator.Method>

The method used to compute 1st derivatives y'(x).

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINEAR The interpolated y(x) is continuous, but has discontinuous 1st and higher derivatives.
MONOTONIC The interpolated y(x) is continuous with continuous 1st derivative, but may have discontinuous 2nd and higher-order derivatives.
SPLINE The interpolated y(x) is continuous with continuous 1st and 2nd derivatives, but may have discontinuous 3rd and higher-order derivatives.

Method Summary

Methods

Modifier and Type	Method and Description
static CubicInterpolator.Method	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CubicInterpolator.Method[]	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

LINEAR

public static final CubicInterpolator.Method LINEAR

The interpolated y(x) is continuous, but has discontinuous 1st and higher derivatives. This method is equivalent to (though less efficient than) simple piecewise linear interpolation.

MONOTONIC

public static final CubicInterpolator.Method MONOTONIC

The interpolated y(x) is continuous with continuous 1st derivative, but may have discontinuous 2nd and higher-order derivatives. This method preserves monotonicity. In intervals where specified y(x) are monotonic, the interpolated values y(x) are also monotonic.

SPLINE

public static final CubicInterpolator.Method SPLINE

The interpolated y(x) is continuous with continuous 1st and 2nd derivatives, but may have discontinuous 3rd and higher-order derivatives.

Method Detail

values

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

Returns:

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

valueOf

public static CubicInterpolator.Method valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null