The Encog Project

org.encog.neural.data
Interface Indexable

All Superinterfaces:
java.lang.Iterable<NeuralDataPair>, NeuralDataSet
All Known Implementing Classes:
BasicNeuralDataSet, BufferedNeuralDataSet, ImageNeuralDataSet, MarketNeuralDataSet, TemporalNeuralDataSet

public interface Indexable
extends NeuralDataSet

Specifies that a data set can be accessed in random order via an index. This property is required for MPROP training.


Method Summary
 void getRecord(long index, NeuralDataPair pair)
          Read an individual record, specified by index, in random order.
 long getRecordCount()
          Determine the total number of records in the set.
 Indexable openAdditional()
          Opens an additional instance of this dataset.
 
Methods inherited from interface org.encog.neural.data.NeuralDataSet
add, add, add, close, getIdealSize, getInputSize
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

getRecordCount

long getRecordCount()
Determine the total number of records in the set.

Returns:
The total number of records in the set.

getRecord

void getRecord(long index,
               NeuralDataPair pair)
Read an individual record, specified by index, in random order.

Parameters:
index - The index to read.
pair - The pair that the record will be copied into.

openAdditional

Indexable openAdditional()
Opens an additional instance of this dataset.

Returns:
The new instance.

The Encog Project