com.github.signaflo.timeseries.model.arima

Enum Arima.Constant

java.lang.Object

java.lang.Enum<Arima.Constant>

com.github.signaflo.timeseries.model.arima.Arima.Constant

All Implemented Interfaces:

Serializable, Comparable<Arima.Constant>

Enclosing interface:

Arima

public static enum Arima.Constant
extends Enum<Arima.Constant>

An indicator for whether an ARIMA model has a constant term.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDE
INCLUDE

Method Summary

Modifier and Type	Method and Description
int	asInt()
boolean	include()
static Arima.Constant	valueOf(String name) Returns the enum constant of this type with the specified name.
static Arima.Constant[]	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

INCLUDE

public static final Arima.Constant INCLUDE

EXCLUDE

public static final Arima.Constant EXCLUDE

Method Detail

values

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

Returns:

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

valueOf

public static Arima.Constant 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

asInt

public int asInt()

include

public boolean include()