Package etomica.data

Enum DataSourceUniform.LimitType

java.lang.Object

java.lang.Enum<DataSourceUniform.LimitType>

etomica.data.DataSourceUniform.LimitType

Enclosing class:

DataSourceUniform

public static enum DataSourceUniform.LimitType
extends java.lang.Enum<DataSourceUniform.LimitType>

Typed constant that indicates the way limits of the range are interpreted. Choices for the left and right limits may be made independently.

• INCLUSIVE indicates that the end point of the series equals the limit.
• HALF_STEP indicates that the end point lies one half interval-step from the limit.
• EXCLUSIVE indicates that the end point lies one full interval-step from the limit.

For example, with n = 3 points and limits of 0.0 and 1.0, and with the left point (0.0) taken to have limitType = INCLUSIVE, the values are as follows for the different choices of the limitType of the right point (1.0):

• INCLUSIVE: 0.0, 0.5, 1.0
• HALF_STEP: 0.0, 0.4, 0.8
• EXCLUSIVE: 0.0, 0.333, 0.667

To get values that lie at the centers of a set of bins (e.g., for histogramming), use HALF_STEP for both limits.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUSIVE	Limit type indicating that specified limit is not included in the range, and that the extreme value should be one full step from the specified limit.
HALF_STEP	Limit type indicating that extreme value should be one half step from the specified limit.
INCLUSIVE	Limit type indicating that limit is included in range, and that it equals the extreme value.

Method Summary

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

INCLUSIVE

public static final DataSourceUniform.LimitType INCLUSIVE

Limit type indicating that limit is included in range, and that it equals the extreme value.

HALF_STEP

public static final DataSourceUniform.LimitType HALF_STEP

Limit type indicating that extreme value should be one half step from the specified limit.

EXCLUSIVE

public static final DataSourceUniform.LimitType EXCLUSIVE

Limit type indicating that specified limit is not included in the range, and that the extreme value should be one full step from the specified limit.

Method Detail

values

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

Returns:

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

valueOf

public static DataSourceUniform.LimitType 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