The Encog Project

org.encog.neural.data.bipolar
Class BiPolarNeuralData

java.lang.Object
  extended by org.encog.neural.data.bipolar.BiPolarNeuralData
All Implemented Interfaces:
java.io.Serializable, NeuralData

public class BiPolarNeuralData
extends java.lang.Object
implements NeuralData, java.io.Serializable

A NeuralData implementation designed to work with bipolar data. Bipolar data contains two values. True is stored as 1, and false is stored as -1.

Author:
jheaton
See Also:
Serialized Form

Constructor Summary
BiPolarNeuralData(boolean[] d)
          Construct this object with the specified data.
BiPolarNeuralData(int size)
          Construct a data object with the specified size.
 
Method Summary
 boolean getBoolean(int i)
          Get the specified data item as a boolean.
 double[] getData()
          Get the data held by this object as an array of doubles.
 double getData(int index)
          Get the data held by the index.
 void setData(double[] data)
          Store the array.
 void setData(int index, boolean value)
          Set the specified index of this object as a boolean.
 void setData(int index, double d)
          Set the specified index of this object as a double.
 int size()
          Get the size of this data object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BiPolarNeuralData

public BiPolarNeuralData(boolean[] d)
Construct this object with the specified data.

Parameters:
d - The data to create this object with.

BiPolarNeuralData

public BiPolarNeuralData(int size)
Construct a data object with the specified size.

Parameters:
size - The size of this data object.
Method Detail

getBoolean

public boolean getBoolean(int i)
Get the specified data item as a boolean.

Parameters:
i - The index to read.
Returns:
The specified data item's value.

getData

public double[] getData()
Get the data held by this object as an array of doubles.

Specified by:
getData in interface NeuralData
Returns:
The data held by this object.

getData

public double getData(int index)
Get the data held by the index.

Specified by:
getData in interface NeuralData
Parameters:
index - The index to read.
Returns:
Return the data held at the specified index.

setData

public void setData(double[] data)
Store the array.

Specified by:
setData in interface NeuralData
Parameters:
data - The data to store.

setData

public void setData(int index,
                    boolean value)
Set the specified index of this object as a boolean. This value will be converted into bipolar.

Parameters:
index - The index to set.
value - The value to set.

setData

public void setData(int index,
                    double d)
Set the specified index of this object as a double. This value will be converted into bipolar.

Specified by:
setData in interface NeuralData
Parameters:
index - The index to set.
d - The value to set.

size

public int size()
Get the size of this data object.

Specified by:
size in interface NeuralData
Returns:
The size of this data object.

The Encog Project