org.ojalgo.series.function

Class SeriesForecaster

java.lang.Object

org.ojalgo.series.function.SeriesFunction<K>

org.ojalgo.series.function.SeriesExtrapolator<CalendarDate>

org.ojalgo.series.function.SeriesForecaster

public abstract class SeriesForecaster
extends SeriesExtrapolator<CalendarDate>

A forecaster is restricted to CalendarDate keys and is intended to predict something related to future keys/dates.

Author:

apete

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SeriesForecaster(CalendarDateSeries<? extends Number> data)
protected	SeriesForecaster(CoordinationSet<? extends Number> coordinatedHistoricalData)

Method Summary

Modifier and Type	Method and Description
protected CalendarDate	getLastKey()
protected CalendarDateUnit	getResolution()
Map<String,Access1D<?>>	invoke(CalendarDate... key)
abstract Map<String,Access1D<?>>	invoke(CalendarDateDuration... horizon)

Methods inherited from class org.ojalgo.series.function.SeriesFunction

getAllSeriesNames, getSeries

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesForecaster

protected SeriesForecaster(CalendarDateSeries<? extends Number> data)

SeriesForecaster

protected SeriesForecaster(CoordinationSet<? extends Number> coordinatedHistoricalData)

Method Detail

invoke

public Map<String,Access1D<?>> invoke(CalendarDate... key)

Specified by:

invoke in class SeriesFunction<CalendarDate>

Parameters:

key - One or more time series keys

Returns:

A map with one entry per series. Each entry/series has the same number of elements as there were input keys.

invoke

public abstract Map<String,Access1D<?>> invoke(CalendarDateDuration... horizon)

getLastKey

protected final CalendarDate getLastKey()

getResolution

protected final CalendarDateUnit getResolution()