org.apache.commons.math3.utils
Enum ISearchIndex.SearchIndexIntervalConvention

java.lang.Object
  java.lang.Enum<ISearchIndex.SearchIndexIntervalConvention>
      org.apache.commons.math3.utils.ISearchIndex.SearchIndexIntervalConvention

All Implemented Interfaces:

Serializable, Comparable<ISearchIndex.SearchIndexIntervalConvention>

Enclosing interface:

ISearchIndex

public static enum ISearchIndex.SearchIndexIntervalConvention
extends Enum<ISearchIndex.SearchIndexIntervalConvention>

Describes the shape of an interval.

Enum Constant Summary

CLOSED_OPEN
(default case) if tab[i] <= x < tab[i + 1], the integer returned is i if x < tab[0], the integer returned is -1 if x >= tab[numberOfPoints-1], the integer returned is numberOfPoints-1

OPEN_CLOSED
if tab[i] < x <= tab[i + 1], the integer returned is i if x <= tab[0], the integer returned is -1 if x > tab[numberOfPoints-1], the integer returned is numberOfPoints-1

Method Summary

static ISearchIndex.SearchIndexIntervalConvention	valueOf(String name) Returns the enum constant of this type with the specified name.
static ISearchIndex.SearchIndexIntervalConvention[]	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

CLOSED_OPEN

public static final ISearchIndex.SearchIndexIntervalConvention CLOSED_OPEN

(default case)

• if tab[i] <= x < tab[i + 1], the integer returned is i
• if x < tab[0], the integer returned is -1
• if x >= tab[numberOfPoints-1], the integer returned is numberOfPoints-1

OPEN_CLOSED

public static final ISearchIndex.SearchIndexIntervalConvention OPEN_CLOSED

• if tab[i] < x <= tab[i + 1], the integer returned is i
• if x <= tab[0], the integer returned is -1
• if x > tab[numberOfPoints-1], the integer returned is numberOfPoints-1

Method Detail

values

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

Returns:

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

valueOf

public static ISearchIndex.SearchIndexIntervalConvention 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