Package ffx.numerics.integrate

Enum Class Integrate1DNumeric.IntegrationSide

java.lang.Object

java.lang.Enum<Integrate1DNumeric.IntegrationSide>

ffx.numerics.integrate.Integrate1DNumeric.IntegrationSide

All Implemented Interfaces:

Serializable, Comparable<Integrate1DNumeric.IntegrationSide>, Constable

Enclosing class:

Integrate1DNumeric

public static enum Integrate1DNumeric.IntegrationSide
extends Enum<Integrate1DNumeric.IntegrationSide>

Left vs right-hand integration; left-hand integration will start from the first available point, run right as far as possible, and then clean up any remaining points using finishIntegration, while right-hand integration will start from the last available point, run left as far as possible, and then clean up any remaining points using finishIntegration.

Values: LEFT, RIGHT.

Not meaningful for trapezoidal integration; there will never be any unused points, and the method is symmetrical.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEFT
RIGHT

Method Summary

Modifier and Type	Method	Description
static Integrate1DNumeric.IntegrationSide	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Integrate1DNumeric.IntegrationSide[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT

public static final Integrate1DNumeric.IntegrationSide LEFT

RIGHT

public static final Integrate1DNumeric.IntegrationSide RIGHT

Method Details

values

public static Integrate1DNumeric.IntegrationSide[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Integrate1DNumeric.IntegrationSide valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null