Package ai.libs.jaicore.ml.core.dataset

Class TimeSeriesDataset<L>

java.lang.Object

ai.libs.jaicore.ml.core.dataset.TimeSeriesDataset<L>

All Implemented Interfaces:

AILabeledAttributeArrayDataset<TimeSeriesInstance<L>,L>, IDataset<TimeSeriesInstance<L>>, IOrderedDataset<TimeSeriesInstance<L>>, IOrderedLabeledAttributeArrayDataset<TimeSeriesInstance<L>,L>, java.lang.Iterable<TimeSeriesInstance<L>>, java.util.Collection<TimeSeriesInstance<L>>, java.util.List<TimeSeriesInstance<L>>

public class TimeSeriesDataset<L>
extends java.lang.Object
implements IOrderedLabeledAttributeArrayDataset<TimeSeriesInstance<L>,L>

Time Series Dataset.

Constructor Summary

Constructors

Constructor	Description
TimeSeriesDataset(java.util.List<org.nd4j.linalg.api.ndarray.INDArray> valueMatrices, java.util.List<org.nd4j.linalg.api.ndarray.INDArray> timestampMatrices, org.nd4j.linalg.api.ndarray.INDArray targets, IAttributeType<L> targetType)	Creates a TimeSeries dataset.

Method Summary

Modifier and Type	Method	Description
void	add(int arg0, TimeSeriesInstance<L> arg1)
boolean	add(TimeSeriesInstance<L> e)
void	add(org.nd4j.linalg.api.ndarray.INDArray valueMatrix, org.nd4j.linalg.api.ndarray.INDArray timestampMatrix)	Add a time series variable to the dataset.
boolean	addAll(int arg0, java.util.Collection<? extends TimeSeriesInstance<L>> arg1)
boolean	addAll(java.util.Collection<? extends TimeSeriesInstance<L>> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
IDataset<TimeSeriesInstance<L>>	createEmpty()	Creates an empty copy of the same structure (and same type).
TimeSeriesInstance<L>	get(int index)
java.util.List<IAttributeType<?>>	getAttributeTypes()	Returns the list of attribute types.
int	getFrequency(TimeSeriesInstance<L> instance)
int	getNumberOfAttributes()	Getter for the number of attributes (excluding target attribute).
long	getNumberOfInstances()
int	getNumberOfVariables()
org.nd4j.linalg.api.ndarray.INDArray	getTargets()
IAttributeType<L>	getTargetType()	Returns the attribute type of the target attribute.
org.nd4j.linalg.api.ndarray.INDArray	getTimestamps(int index)
org.nd4j.linalg.api.ndarray.INDArray	getTimestampsOrNull(int index)
org.nd4j.linalg.api.ndarray.INDArray	getValues(int index)
org.nd4j.linalg.api.ndarray.INDArray	getValuesOrNull(int index)
int	indexOf(java.lang.Object arg0)
boolean	isEmpty()
boolean	isMultivariate()
boolean	isUnivariate()
java.util.Iterator<TimeSeriesInstance<L>>	iterator()
int	lastIndexOf(java.lang.Object arg0)
java.util.ListIterator<TimeSeriesInstance<L>>	listIterator()
java.util.ListIterator<TimeSeriesInstance<L>>	listIterator(int arg0)
TimeSeriesInstance<L>	remove(int index)	Removes the time series variable at a given index.
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
void	replace(int index, org.nd4j.linalg.api.ndarray.INDArray valueMatrix, org.nd4j.linalg.api.ndarray.INDArray timestampMatrix)	Replaces the time series variable at a given index with a new one.
boolean	retainAll(java.util.Collection<?> c)
TimeSeriesInstance<L>	set(int arg0, TimeSeriesInstance<L> arg1)
int	size()
java.util.List<TimeSeriesInstance<L>>	subList(int arg0, int arg1)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Constructor Detail

TimeSeriesDataset

public TimeSeriesDataset(java.util.List<org.nd4j.linalg.api.ndarray.INDArray> valueMatrices,
                         java.util.List<org.nd4j.linalg.api.ndarray.INDArray> timestampMatrices,
                         org.nd4j.linalg.api.ndarray.INDArray targets,
                         IAttributeType<L> targetType)

Creates a TimeSeries dataset. Let `n` be the number of instances.

Parameters:

valueMatrices - Values for the time series variables. List of 2D-Arrays with shape `[n, ?]`.

timestampMatrices - Timestamps for the time series variables. List of 2D-Arrays with shape `[n, ?]`. Or `null` if no timestamps exist for the corresponding time series variable. The shape of the `i`th index must be equal to the shape of the `i`th element of `valueMatrices`.

targets - Target values for the instances.

Method Detail

add

public void add(org.nd4j.linalg.api.ndarray.INDArray valueMatrix,
                org.nd4j.linalg.api.ndarray.INDArray timestampMatrix)

Add a time series variable to the dataset.

Parameters:

valueMatrix - Values for the time series variable to add. 2D-Arrays with shape `[n, ?]` where `n` is the number of instances of the dataset.

timestampMatrix - Timestamps for the time series variable to add. 2D-Arrays with shape `[n, ?]` where `n` is the number of instances of the dataset. Or `null` if no timestamp exists for this time series variable.

remove

public TimeSeriesInstance<L> remove(int index)

Removes the time series variable at a given index.

Specified by:

remove in interface java.util.List<L>

Parameters:

index -

Returns:

Throws:

java.lang.IndexOutOfBoundsException

replace

public void replace(int index,
                    org.nd4j.linalg.api.ndarray.INDArray valueMatrix,
                    org.nd4j.linalg.api.ndarray.INDArray timestampMatrix)

Replaces the time series variable at a given index with a new one.

Parameters:

index - Index of the time series varialbe to replace.

valueMatrix - Values for the time series variable to add. 2D-Arrays with shape `[n, ?]` where `n` is the number of instances of the dataset.

timestampMatrix - Timestamps for the time series variable to add. 2D-Arrays with shape `[n, ?]` where `n` is the number of instances of the dataset. Or `null` if no timestamp exists for this time series variable.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if `numberOfInstances <= index`.

getTargets

public org.nd4j.linalg.api.ndarray.INDArray getTargets()

getNumberOfVariables

public int getNumberOfVariables()

getNumberOfInstances

public long getNumberOfInstances()

getValues

public org.nd4j.linalg.api.ndarray.INDArray getValues(int index)

getTimestamps

public org.nd4j.linalg.api.ndarray.INDArray getTimestamps(int index)

getValuesOrNull

public org.nd4j.linalg.api.ndarray.INDArray getValuesOrNull(int index)

getTimestampsOrNull

public org.nd4j.linalg.api.ndarray.INDArray getTimestampsOrNull(int index)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<L>

Specified by:

isEmpty in interface java.util.List<L>

isUnivariate

public boolean isUnivariate()

isMultivariate

public boolean isMultivariate()

get

public TimeSeriesInstance<L> get(int index)

Specified by:

get in interface java.util.List<L>

iterator

public java.util.Iterator<TimeSeriesInstance<L>> iterator()

Specified by:

iterator in interface java.util.Collection<L>

Specified by:

iterator in interface java.lang.Iterable<L>

Specified by:

iterator in interface java.util.List<L>

getNumberOfAttributes

public int getNumberOfAttributes()

Description copied from interface: AILabeledAttributeArrayDataset

Getter for the number of attributes (excluding target attribute).

Specified by:

getNumberOfAttributes in interface AILabeledAttributeArrayDataset<TimeSeriesInstance<L>,L>

Returns:

The number of attributes.

getAttributeTypes

public java.util.List<IAttributeType<?>> getAttributeTypes()

Description copied from interface: AILabeledAttributeArrayDataset

Returns the list of attribute types.

Specified by:

getAttributeTypes in interface AILabeledAttributeArrayDataset<TimeSeriesInstance<L>,L>

Returns:

The list of attribute types.

getTargetType

public IAttributeType<L> getTargetType()

Description copied from interface: AILabeledAttributeArrayDataset

Returns the attribute type of the target attribute.

Specified by:

getTargetType in interface AILabeledAttributeArrayDataset<TimeSeriesInstance<L>,L>

Returns:

The attribute type of the target attribute.

createEmpty

public IDataset<TimeSeriesInstance<L>> createEmpty()

Description copied from interface: IDataset

Creates an empty copy of the same structure (and same type).

Specified by:

createEmpty in interface IDataset<L>

Returns:

The newly created dataset.

add

public boolean add(TimeSeriesInstance<L> e)

Specified by:

add in interface java.util.Collection<L>

Specified by:

add in interface java.util.List<L>

addAll

public boolean addAll(java.util.Collection<? extends TimeSeriesInstance<L>> c)

Specified by:

addAll in interface java.util.Collection<L>

Specified by:

addAll in interface java.util.List<L>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<L>

Specified by:

clear in interface java.util.List<L>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<L>

Specified by:

contains in interface java.util.List<L>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<L>

Specified by:

containsAll in interface java.util.List<L>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<L>

Specified by:

remove in interface java.util.List<L>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<L>

Specified by:

removeAll in interface java.util.List<L>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<L>

Specified by:

retainAll in interface java.util.List<L>

size

public int size()

Specified by:

size in interface java.util.Collection<L>

Specified by:

size in interface java.util.List<L>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<L>

Specified by:

toArray in interface java.util.List<L>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<L>

Specified by:

toArray in interface java.util.List<L>

add

public void add(int arg0,
                TimeSeriesInstance<L> arg1)

Specified by:

add in interface java.util.List<L>

addAll

public boolean addAll(int arg0,
                      java.util.Collection<? extends TimeSeriesInstance<L>> arg1)

Specified by:

addAll in interface java.util.List<L>

indexOf

public int indexOf(java.lang.Object arg0)

Specified by:

indexOf in interface java.util.List<L>

lastIndexOf

public int lastIndexOf(java.lang.Object arg0)

Specified by:

lastIndexOf in interface java.util.List<L>

listIterator

public java.util.ListIterator<TimeSeriesInstance<L>> listIterator()

Specified by:

listIterator in interface java.util.List<L>

listIterator

public java.util.ListIterator<TimeSeriesInstance<L>> listIterator(int arg0)

Specified by:

listIterator in interface java.util.List<L>

set

public TimeSeriesInstance<L> set(int arg0,
                                 TimeSeriesInstance<L> arg1)

Specified by:

set in interface java.util.List<L>

subList

public java.util.List<TimeSeriesInstance<L>> subList(int arg0,
                                                     int arg1)

Specified by:

subList in interface java.util.List<L>

getFrequency

public int getFrequency(TimeSeriesInstance<L> instance)

Specified by:

getFrequency in interface IDataset<L>