com.github.signaflo.timeseries.model.regression

Enum TimeSeriesLinearRegression.TimeTrend

java.lang.Object

java.lang.Enum<TimeSeriesLinearRegression.TimeTrend>

com.github.signaflo.timeseries.model.regression.TimeSeriesLinearRegression.TimeTrend

All Implemented Interfaces:

Serializable, Comparable<TimeSeriesLinearRegression.TimeTrend>

Enclosing interface:

TimeSeriesLinearRegression

public static enum TimeSeriesLinearRegression.TimeTrend
extends Enum<TimeSeriesLinearRegression.TimeTrend>

Specifies whether a time series regression model has a time trend.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDE
INCLUDE

Method Summary

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

EXCLUDE

public static final TimeSeriesLinearRegression.TimeTrend EXCLUDE

Method Detail

values

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

Returns:

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

valueOf

public static TimeSeriesLinearRegression.TimeTrend 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