nl.liacs.timeseries.kernel

Enum OutOfBoundsPolicy

java.lang.Object

java.lang.Enum<OutOfBoundsPolicy>

nl.liacs.timeseries.kernel.OutOfBoundsPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OutOfBoundsPolicy>

public enum OutOfBoundsPolicy
extends java.lang.Enum<OutOfBoundsPolicy>

OutOfBoundsPolicy enums are used to as default values for 'windowed' operations, when such a window can not, as a whole, be placed over the input values.

Author:

Marvin Meeng Last updated 11.07.2012

See Also:

AbstractKernel.applyTo(double[], int), BasicKernel.setOutOfBoundsPolicy(OutOfBoundsPolicy)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Do no apply operation on OutOfBounds values, set them to a custom value.
NAN Do no apply operation on OutOfBounds values, set them to Double.NaN
ZERO Do no apply operation on OutOfBounds values, set them to 0.0

Method Summary

Methods

Modifier and Type	Method and Description
static OutOfBoundsPolicy	fromString(java.lang.String theOutOfBoundsPolicy) Returns the OutOfBoundsPolicy corresponding to the String.
static OutOfBoundsPolicy	getDefaultPolicy() The application default OutOfBoundsPolicy.
abstract double	getValue() Returns the double corresponding to the OutOfBoundsPolicy.
static OutOfBoundsPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OutOfBoundsPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ZERO

public static final OutOfBoundsPolicy ZERO

Do no apply operation on OutOfBounds values, set them to 0.0

NAN

public static final OutOfBoundsPolicy NAN

Do no apply operation on OutOfBounds values, set them to Double.NaN

CUSTOM

public static final OutOfBoundsPolicy CUSTOM

Do no apply operation on OutOfBounds values, set them to a custom value.

WARNING: currently setting a custom value has no effect, instead -1.0 is used, always.

Method Detail

values

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

Returns:

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

valueOf

public static OutOfBoundsPolicy 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

getValue

public abstract double getValue()

Returns the double corresponding to the OutOfBoundsPolicy.

fromString

public static OutOfBoundsPolicy fromString(java.lang.String theOutOfBoundsPolicy)

Returns the OutOfBoundsPolicy corresponding to the String.

getDefaultPolicy

public static OutOfBoundsPolicy getDefaultPolicy()

The application default OutOfBoundsPolicy.