kieker.tools.opad.timeseries.forecast

Class ForecastResult

java.lang.Object

kieker.tools.opad.timeseries.forecast.ForecastResult

All Implemented Interfaces:

IForecastResult

public class ForecastResult
extends java.lang.Object
implements IForecastResult

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

Since:

1.10

Author:

Andre van Hoorn

Constructor Summary

Constructors

Constructor and Description
ForecastResult(ITimeSeries<java.lang.Double> tsForecast, ITimeSeries<java.lang.Double> tsOriginal, ForecastMethod fcStrategy) Constructs a ForecastResult with confidence level 0, where the time series returned getLower() by getUpper() are the forecast series.
ForecastResult(ITimeSeries<java.lang.Double> tsForecast, ITimeSeries<java.lang.Double> tsOriginal, int tsconfidenceLevel, double tsmeanAbsoluteScaledError, ITimeSeries<java.lang.Double> tsLower, ITimeSeries<java.lang.Double> tsUpper, ForecastMethod fcStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
int	getConfidenceLevel() Returns the confidence level for the forecast interval.
ForecastMethod	getFcStrategy() Returns the forecasting strategy that has been used for this forecast.
ITimeSeries<java.lang.Double>	getForecast() Returns the point forecasts.
ITimeSeries<java.lang.Double>	getLower() Returns the lower limits for forecast interval with respect to the confidence level IForecastResult.getConfidenceLevel().
double	getMeanAbsoluteScaledError() Returns the MeanAbsoluteScaledError.
ITimeSeries<java.lang.Double>	getOriginal() Returns the original time series that was the basis for the forecast.
ITimeSeries<java.lang.Double>	getUpper() Returns the upper limits for forecast interval with respect to the confidence level IForecastResult.getConfidenceLevel().
boolean	isPlausible() Checks whether the input seems to be plausible.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForecastResult

public ForecastResult(ITimeSeries<java.lang.Double> tsForecast,
              ITimeSeries<java.lang.Double> tsOriginal,
              int tsconfidenceLevel,
              double tsmeanAbsoluteScaledError,
              ITimeSeries<java.lang.Double> tsLower,
              ITimeSeries<java.lang.Double> tsUpper,
              ForecastMethod fcStrategy)

Parameters:

tsForecast - TimesSeries

tsOriginal - TimeSeries

tsconfidenceLevel - confidentLevel

tsmeanAbsoluteScaledError - MASE

tsLower - ??

tsUpper - ??

fcStrategy - FC Method

ForecastResult

public ForecastResult(ITimeSeries<java.lang.Double> tsForecast,
              ITimeSeries<java.lang.Double> tsOriginal,
              ForecastMethod fcStrategy)

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

Parameters:

tsForecast - Timeseries with forecast

tsOriginal - Timeseries with orginal

fcStrategy - forecastMethod

Method Detail

getForecast

public ITimeSeries<java.lang.Double> getForecast()

Description copied from interface: IForecastResult

Returns the point forecasts.

Specified by:

getForecast in interface IForecastResult

getConfidenceLevel

public int getConfidenceLevel()

Description copied from interface: IForecastResult

Returns the confidence level for the forecast interval.

Specified by:

getConfidenceLevel in interface IForecastResult

getUpper

public ITimeSeries<java.lang.Double> 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

getLower

public ITimeSeries<java.lang.Double> 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

getOriginal

public ITimeSeries<java.lang.Double> getOriginal()

Description copied from interface: IForecastResult

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

Specified by:

getOriginal in interface IForecastResult

Returns:

orginal Timeseries

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMeanAbsoluteScaledError

public double getMeanAbsoluteScaledError()

Description copied from interface: IForecastResult

Returns the MeanAbsoluteScaledError.

Specified by:

getMeanAbsoluteScaledError in interface IForecastResult

Returns:

MASE

getFcStrategy

public ForecastMethod getFcStrategy()

Description copied from interface: IForecastResult

Returns the forecasting strategy that has been used for this forecast.

Specified by:

getFcStrategy in interface IForecastResult

Returns:

ForecastMethod

isPlausible

public boolean isPlausible()

Checks whether the input seems to be plausible.

Specified by:

isPlausible in interface IForecastResult

Returns:

true if plausible, else false