Module ojalgo

Package org.ojalgo.series.function

Class SeriesFunction<K extends Comparable<? super K>>

java.lang.Object

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

Type Parameters:

K - The series key type

Direct Known Subclasses:

SeriesExtrapolator

public abstract class SeriesFunction<K extends Comparable<? super K>>
extends Object

A function that maps from a (collection of) series and one or more keys to a series of numbers. The interpretation of the input series data and the output series is completely free.

Author:

apete

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SeriesFunction(Map<String,? extends BasicSeries<K,? extends Comparable<?>>> data)
protected	SeriesFunction(BasicSeries<K,? extends Comparable<?>> data)

Method Summary

Modifier and Type	Method	Description
protected List<String>	getAllSeriesNames()
protected BasicSeries<K,? extends Comparable<?>>	getSeries(String name)
abstract Map<String,Access1D<?>>	invoke(K... key)

Methods inherited from class java.lang.Object

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

Constructor Details

SeriesFunction

protected SeriesFunction(BasicSeries<K,? extends Comparable<?>> data)

SeriesFunction

protected SeriesFunction(Map<String,? extends BasicSeries<K,? extends Comparable<?>>> data)

Method Details

invoke

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

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.

getAllSeriesNames

protected List<String> getAllSeriesNames()

getSeries

protected BasicSeries<K,? extends Comparable<?>> getSeries(String name)