org.encog.ml.data.buffer.codec

Class NeuralDataSetCODEC

java.lang.Object

org.encog.ml.data.buffer.codec.NeuralDataSetCODEC

All Implemented Interfaces:

DataSetCODEC

public class NeuralDataSetCODEC
extends java.lang.Object
implements DataSetCODEC

A CODEC that works with the NeuralDataSet class.

Constructor Summary

Constructors

Constructor and Description
NeuralDataSetCODEC(MLDataSet theDataset) Construct a CODEC.

Method Summary

Modifier and Type	Method and Description
void	close() Close any open files.
int	getIdealSize()
int	getInputSize()
void	prepareRead() Prepare to read from an external data source.
void	prepareWrite(int recordCount, int theInputSize, int theIdealSize) Prepare to write to an external data destination.
boolean	read(double[] input, double[] ideal, double[] significance) Read one record of data from an external source.
void	write(double[] input, double[] ideal, double significance) Write one record of data to an external destination.

Methods inherited from class java.lang.Object

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

Constructor Detail

NeuralDataSetCODEC

public NeuralDataSetCODEC(MLDataSet theDataset)

Construct a CODEC.

Parameters:

theDataset - The dataset to use.

Method Detail

getInputSize

public int getInputSize()

Specified by:

getInputSize in interface DataSetCODEC

Returns:

The size of the input data.

getIdealSize

public int getIdealSize()

Specified by:

getIdealSize in interface DataSetCODEC

Returns:

The size of the ideal data.

read

public boolean read(double[] input,
                    double[] ideal,
                    double[] significance)

Read one record of data from an external source.

Specified by:

read in interface DataSetCODEC

Parameters:

input - The input data array.

ideal - The ideal data array.

significance - The significance. The first element will be modified to hold the significance.

Returns:

True, if there is more data to be read.

write

public void write(double[] input,
                  double[] ideal,
                  double significance)

Write one record of data to an external destination.

Specified by:

write in interface DataSetCODEC

Parameters:

input - The input data array.

ideal - The ideal data array.

significance - The significance (full = 1.0)

prepareWrite

public void prepareWrite(int recordCount,
                         int theInputSize,
                         int theIdealSize)

Prepare to write to an external data destination.

Specified by:

prepareWrite in interface DataSetCODEC

Parameters:

recordCount - The total record count, that will be written.

theInputSize - The input size.

theIdealSize - The ideal size.

prepareRead

public void prepareRead()

Prepare to read from an external data source.

Specified by:

prepareRead in interface DataSetCODEC

close

public void close()

Close any open files.

Specified by:

close in interface DataSetCODEC