kieker.tools.tslib.forecast
Class ForecastResult<T>

java.lang.Object
  kieker.tools.tslib.forecast.ForecastResult<T>

Type Parameters:

T -

All Implemented Interfaces:

IForecastResult<T>

public class ForecastResult<T>
extends Object
implements IForecastResult<T>

Result of a time series forecast, e.g., computed by IForecaster. If additional fields are required, IForecasters should extend this class.

Since:

1.9

Author:

Andre van Hoorn

Constructor Summary

ForecastResult(ITimeSeries<T> tsForecast, ITimeSeries<T> tsOriginal)
Constructs a ForecastResult with confidence level 0, where the time series returned getLower() by getUpper() are the forecast series.

ForecastResult(ITimeSeries<T> tsForecast, ITimeSeries<T> tsOriginal, int confidenceLevel, ITimeSeries<T> tsLower, ITimeSeries<T> tsUpper)

Method Summary

int	getConfidenceLevel() Returns the confidence level for the forecast interval.
ITimeSeries<T>	getForecast() Returns the point forecasts.
ITimeSeries<T>	getLower() Returns the lower limits for forecast interval with respect to the confidence level IForecastResult.getConfidenceLevel().
ITimeSeries<T>	getOriginal() Returns the original time series that was the basis for the forecast.
ITimeSeries<T>	getUpper() Returns the upper limits for forecast interval with respect to the confidence level IForecastResult.getConfidenceLevel().
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ForecastResult

public ForecastResult(ITimeSeries<T> tsForecast,
                      ITimeSeries<T> tsOriginal,
                      int confidenceLevel,
                      ITimeSeries<T> tsLower,
                      ITimeSeries<T> tsUpper)

ForecastResult

public ForecastResult(ITimeSeries<T> tsForecast,
                      ITimeSeries<T> tsOriginal)

Constructs a ForecastResult with confidence level 0, where the time series returned getLower() by getUpper() are the forecast series.

Parameters:

tsForecast -

Method Detail

getForecast

public ITimeSeries<T> getForecast()

Description copied from interface: IForecastResult

Returns the point forecasts.

Specified by:

getForecast in interface IForecastResult<T>

getConfidenceLevel

public int getConfidenceLevel()

Description copied from interface: IForecastResult

Returns the confidence level for the forecast interval.

Specified by:

getConfidenceLevel in interface IForecastResult<T>

getUpper

public ITimeSeries<T> getUpper()

Description copied from interface: IForecastResult

Returns the upper limits for forecast interval with respect to the confidence level IForecastResult.getConfidenceLevel().

Specified by:

getUpper in interface IForecastResult<T>

getLower

public ITimeSeries<T> getLower()

Description copied from interface: IForecastResult

Returns the lower limits for forecast interval with respect to the confidence level IForecastResult.getConfidenceLevel().

Specified by:

getLower in interface IForecastResult<T>

getOriginal

public ITimeSeries<T> getOriginal()

Description copied from interface: IForecastResult

Returns the original time series that was the basis for the forecast.

Specified by:

getOriginal in interface IForecastResult<T>

toString

public String toString()

Overrides:

toString in class Object