org.datavec.api.records

Interface SequenceRecord

All Superinterfaces:

Serializable

All Known Implementing Classes:

SequenceRecord

public interface SequenceRecord
extends Serializable

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).
List<List<Writable>>	getSequenceRecord() Get the sequence record values
List<Writable>	getTimeStep(int timeStep) Get a single time step.
void	setMetaData(RecordMetaData recordMetaData) Set the Record metadata
void	setSequenceRecord(List<List<Writable>> sequenceRecord) Set the sequence record values

Method Detail

getSequenceRecord

List<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

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