org.datavec.api.records

Interface SequenceRecord

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

SequenceRecord

public interface SequenceRecord
extends java.io.Serializable

A SequenceRecord contains a set of values for a single sequence or time series (usually with multiple values per time step, and multiple time steps).
Each value in the Record is represented by Writable object; each time step is thus a List<Writable> and the entire sequence is represented by a List<List<Writable>>, where the outer list is over time steps, and the inner list is over values for a given time step.
The SequenceRecord may (optionally) also have a RecordMetaData instance, that represents metadata (source location, etc) for the record.
For standard (non-sequential) data, see Record

Method Summary

Modifier and Type	Method and Description
RecordMetaData	getMetaData() Get the RecordMetaData for this record
int	getSequenceLength() Get the overall length of the sequence record (number of time/sequence steps, etc).
java.util.List<java.util.List<Writable>>	getSequenceRecord() Get the sequence record values
java.util.List<Writable>	getTimeStep(int timeStep) Get a single time step.
void	setMetaData(RecordMetaData recordMetaData) Set the Record metadata
void	setSequenceRecord(java.util.List<java.util.List<Writable>> sequenceRecord) Set the sequence record values

Method Detail

getSequenceRecord

java.util.List<java.util.List<Writable>> getSequenceRecord()

Get the sequence record values

Returns:

Sequence record values

getSequenceLength

int getSequenceLength()

Get the overall length of the sequence record (number of time/sequence steps, etc). Equivalent to getSequenceRecord().size()

Returns:

Length of sequence record

getTimeStep

java.util.List<Writable> getTimeStep(int timeStep)

Get a single time step. Equivalent to getSequenceRecord().get(timeStep)

Parameters:

timeStep - Time step to get. Must be 0 <= timeStep < getSequenceLength()

Returns:

Values for a single time step

setSequenceRecord

void setSequenceRecord(java.util.List<java.util.List<Writable>> sequenceRecord)

Set the sequence record values

Parameters:

sequenceRecord - Sequence record values to set

getMetaData

RecordMetaData getMetaData()

Get the RecordMetaData for this record

Returns:

Metadata for this record (or null, if none has been set)

setMetaData

void setMetaData(RecordMetaData recordMetaData)

Set the Record metadata