com.imsl.stat

Enum TimeSeriesOperations.MergeRule

java.lang.Object

java.lang.Enum<TimeSeriesOperations.MergeRule>

com.imsl.stat.TimeSeriesOperations.MergeRule

All Implemented Interfaces:

Serializable, Comparable<TimeSeriesOperations.MergeRule>

Enclosing class:

TimeSeriesOperations

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

Public enum of merge rules that defines how two time series should be merged.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTERSECTION The merge operation includes time points and values only at the matching time points and applies the CombineMethod to the values at the matching time points.
UNION The merge operation includes all time points and values from each time series and applies the CombineMethod to the values at the matching time points.
UNION_MISSING The merge operation includes all time points but applies the CombineMethod only to values at matching time points, indicating a missing value Double.NaN for time points that are not in the intersection.

Method Summary

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

UNION

public static final TimeSeriesOperations.MergeRule UNION

The merge operation includes all time points and values from each time series and applies the CombineMethod to the values at the matching time points.

INTERSECTION

public static final TimeSeriesOperations.MergeRule INTERSECTION

The merge operation includes time points and values only at the matching time points and applies the CombineMethod to the values at the matching time points.

UNION_MISSING

public static final TimeSeriesOperations.MergeRule UNION_MISSING

The merge operation includes all time points but applies the CombineMethod only to values at matching time points, indicating a missing value Double.NaN for time points that are not in the intersection.

Method Detail

values

public static TimeSeriesOperations.MergeRule[] 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.MergeRule c : TimeSeriesOperations.MergeRule.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.MergeRule 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