Class SeriesForecaster

java.lang.Object

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

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.

Field Summary

Fields

Modifier and Type	Field	Description
private final CalendarDate	myLastKey
private final CalendarDateUnit	myResolution

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SeriesForecaster(Map<String, ? extends BasicSeries<CalendarDate, ? extends Comparable<?>>> data)
private	SeriesForecaster(BasicSeries<CalendarDate, ? extends Number> data)
protected	SeriesForecaster(CalendarDateSeries<? extends Comparable<?>> data)
protected	SeriesForecaster(CoordinationSet<? extends Comparable<?>> coordinatedHistoricalData)

Method Summary

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

Methods inherited from class SeriesFunction

getAllSeriesNames, getSeries

Methods inherited from class Object

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

Field Details

myLastKey

private final CalendarDate myLastKey

myResolution

private final CalendarDateUnit myResolution

Constructor Details

SeriesForecaster

private SeriesForecaster(BasicSeries<CalendarDate, ? extends Number> data)

SeriesForecaster

private SeriesForecaster(Map<String, ? extends BasicSeries<CalendarDate, ? extends Comparable<?>>> data)

SeriesForecaster

protected SeriesForecaster(CalendarDateSeries<? extends Comparable<?>> data)

SeriesForecaster

protected SeriesForecaster(CoordinationSet<? extends Comparable<?>> coordinatedHistoricalData)

Method Details

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()