com.github.signaflo.timeseries.operators

Class LagOperator

java.lang.Object

com.github.signaflo.timeseries.operators.LagOperator

public final class LagOperator
extends Object

Static methods for working with the lag operator.

Method Summary

Modifier and Type	Method and Description
static double	apply(double[] series, int index, int times) Apply the lag operator the given number of times at the given index.
static double	apply(TimeSeries series, int index) Apply the lag operator once at the given index.
static double	apply(TimeSeries series, int index, int times) Apply the lag operator the given number of times at the given index.
static double	apply(TimeSeries series, OffsetDateTime dateTime) Apply the lag operator once at the given date-time.
static double	apply(TimeSeries series, OffsetDateTime dateTime, int times) Apply the lag operator the given number of times at the given date-time.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

apply

public static double apply(TimeSeries series,
                           int index)

Apply the lag operator once at the given index.

Parameters:

series - the series to apply the lag operator to.

index - the index to apply the lag operator at.

Returns:

the value of the series at lag 1 from the given index.

apply

public static double apply(TimeSeries series,
                           OffsetDateTime dateTime)

Apply the lag operator once at the given date-time.

Parameters:

series - the series to apply the lag operator to.

dateTime - the date-time to apply the lag operator at.

Returns:

the value of the series at lag 1 from the given date-time.

apply

public static double apply(TimeSeries series,
                           int index,
                           int times)

Apply the lag operator the given number of times at the given index.

Parameters:

series - the series to apply the lag operator to.

index - the index to apply the lag operator at.

times - the number of times to apply the lag operator.

Returns:

the value of the series at the given number of lags from the given index.

apply

public static double apply(TimeSeries series,
                           OffsetDateTime dateTime,
                           int times)

Apply the lag operator the given number of times at the given date-time.

Parameters:

series - the series to apply the lag operator to.

dateTime - the date-time to apply the lag operator at.

times - the number of times to apply the lag operator.

Returns:

the value of the series at the given number of lags from the given date-time.

apply

public static double apply(double[] series,
                           int index,
                           int times)

Apply the lag operator the given number of times at the given index.

Parameters:

series - the series to apply the lag operator to.

index - the index to apply the lag operator at.

times - the number of times to apply the lag operator.

Returns:

the value of the series at the given number of lags from the given index.