Package ffx.numerics.integrate

Enum Class Integrate1DNumeric.IntegrationType

java.lang.Object

java.lang.Enum<Integrate1DNumeric.IntegrationType>

ffx.numerics.integrate.Integrate1DNumeric.IntegrationType

All Implemented Interfaces:

Serializable, Comparable<Integrate1DNumeric.IntegrationType>, Constable

Enclosing class:

Integrate1DNumeric

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

Enumeration of implemented integration methods, and the number of points required by them.

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
BOOLE	Boole's Five Point Integration, requiring 5 points.
RECTANGULAR	Rectangular integration, requiring 1 point.
SIMPSONS	Simpson's Three Point Integration, requiring 3 points.
TRAPEZOIDAL	Trapezoidal integration, requiring 2 points.

Method Summary

Modifier and Type	Method	Description
final int	pointsNeeded()	Returns the number of points required for integration.
static Integrate1DNumeric.IntegrationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Integrate1DNumeric.IntegrationType[]	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

RECTANGULAR

public static final Integrate1DNumeric.IntegrationType RECTANGULAR

Rectangular integration, requiring 1 point.

TRAPEZOIDAL

public static final Integrate1DNumeric.IntegrationType TRAPEZOIDAL

Trapezoidal integration, requiring 2 points.

SIMPSONS

public static final Integrate1DNumeric.IntegrationType SIMPSONS

Simpson's Three Point Integration, requiring 3 points.

BOOLE

public static final Integrate1DNumeric.IntegrationType BOOLE

Boole's Five Point Integration, requiring 5 points.

Method Details

values

public static Integrate1DNumeric.IntegrationType[] 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.IntegrationType 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

pointsNeeded

public final int pointsNeeded()

Returns the number of points required for integration.

Returns:

Number of points required for integration.