com.imsl.stat

Enum TimeSeriesOperations.CombineMethod

java.lang.Object

java.lang.Enum<TimeSeriesOperations.CombineMethod>

com.imsl.stat.TimeSeriesOperations.CombineMethod

All Implemented Interfaces:

Serializable, Comparable<TimeSeriesOperations.CombineMethod>

Enclosing class:

TimeSeriesOperations

public static enum TimeSeriesOperations.CombineMethod
extends Enum<TimeSeriesOperations.CombineMethod>

Public enum of methods for combining synchronous time series values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABS_DIFF Takes the absolute difference |ts1-ts2| between the two values.
AVERAGE Takes the average of the two values.
CUSTOM Uses a custom combine function that is provided by the user.
DIFF Takes the difference (ts1-ts2) of the two values.
FIRST Uses the value from ts1, the first series in the call.
MAX Uses the maximum of the two values.
MIN Uses the minimum of the two values.
SUM Takes the sum of the two values.

Method Summary

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

FIRST

public static final TimeSeriesOperations.CombineMethod FIRST

Uses the value from ts1, the first series in the call.

AVERAGE

public static final TimeSeriesOperations.CombineMethod AVERAGE

Takes the average of the two values.

SUM

public static final TimeSeriesOperations.CombineMethod SUM

Takes the sum of the two values.

MIN

public static final TimeSeriesOperations.CombineMethod MIN

Uses the minimum of the two values.

MAX

public static final TimeSeriesOperations.CombineMethod MAX

Uses the maximum of the two values.

DIFF

public static final TimeSeriesOperations.CombineMethod DIFF

Takes the difference (ts1-ts2) of the two values.

ABS_DIFF

public static final TimeSeriesOperations.CombineMethod ABS_DIFF

Takes the absolute difference |ts1-ts2| between the two values.

CUSTOM

public static final TimeSeriesOperations.CombineMethod CUSTOM

Uses a custom combine function that is provided by the user.

Method Detail

values

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

Returns:

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

valueOf

public static TimeSeriesOperations.CombineMethod 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