net.sourceforge.cilib.neuralnetwork.generic.errorfunctions
Class MSEErrorFunction

java.lang.Object
  net.sourceforge.cilib.neuralnetwork.generic.errorfunctions.MSEErrorFunction

All Implemented Interfaces:

Serializable, Comparable<Fitness>, Initializable, NNError, Fitness, Type, Cloneable

public class MSEErrorFunction
extends Object
implements NNError, Initializable

Author:

stefanv

See Also:

Serialized Form

Field Summary

protected double	computationData
protected int	noOutputs
protected int	noPatterns
protected double	value

Constructor Summary

MSEErrorFunction()

MSEErrorFunction(int noOutputs, int noPatterns, double value)

Method Summary

int	compareTo(Fitness arg0) Compare the current fitness instance to the provided instance.
void	computeIteration(TypeList output, NNPattern input)
void	finaliseError()
NNError	getClone() Create a cloned copy of the current object and return it.
NeuralNetworkData	getData()
String	getName()
int	getNoOutputs()
int	getNoPatterns()
Double	getValue() Returns the underlying fitness value.
void	initialize()
Fitness	newInstance(Double value) Creation method that maintains Fitness object immutability by returning a new instance of the current class type.
void	setNoOutputs(int noOutputs)
void	setNoPatterns(int noPatterns)
void	setValue(Object val)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.cilib.type.types.Type

equals, hashCode

Field Detail

value

protected double value

computationData

protected double computationData

noOutputs

protected int noOutputs

noPatterns

protected int noPatterns

Constructor Detail

MSEErrorFunction

public MSEErrorFunction()

MSEErrorFunction

public MSEErrorFunction(int noOutputs,
                        int noPatterns,
                        double value)

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface Initializable

getValue

public Double getValue()

Description copied from interface: NNError

Returns the underlying fitness value.

Specified by:

getValue in interface NNError

Specified by:

getValue in interface Fitness

Returns:

the actual fitness value.

compareTo

public int compareTo(Fitness arg0)

Description copied from interface: Fitness

Compare the current fitness instance to the provided instance. Returns a negative integer, zero and a positive integer as this object is less than, equal to or greater than the specified object.

Specified by:

compareTo in interface Comparable<Fitness>

Specified by:

compareTo in interface Fitness

Parameters:

arg0 - The fitness to be compared.

Returns:

a negative integer, zero or a positive integer if this object is less than, equal to or greater than the specified object.

See Also:

Comparable

computeIteration

public void computeIteration(TypeList output,
                             NNPattern input)

Specified by:

computeIteration in interface NNError

finaliseError

public void finaliseError()

Specified by:

finaliseError in interface NNError

getClone

public NNError getClone()

Description copied from interface: NNError

Create a cloned copy of the current object and return it. In general the created copy will be a deep copy of the provided instance. As a result this operation an be quite expensive if used incorrectly.

Specified by:

getClone in interface NNError

Specified by:

getClone in interface Fitness

Specified by:

getClone in interface Type

Specified by:

getClone in interface Cloneable

Returns:

An exact clone of the current object instance.

See Also:

Object.clone()

getNoOutputs

public int getNoOutputs()

setNoOutputs

public void setNoOutputs(int noOutputs)

Specified by:

setNoOutputs in interface NNError

getNoPatterns

public int getNoPatterns()

setNoPatterns

public void setNoPatterns(int noPatterns)

Specified by:

setNoPatterns in interface NNError

setValue

public void setValue(Object val)

Specified by:

setValue in interface NNError

getName

public String getName()

Specified by:

getName in interface NNError

getData

public NeuralNetworkData getData()

toString

public String toString()

Overrides:

toString in class Object

newInstance

public Fitness newInstance(Double value)

Description copied from interface: Fitness

Creation method that maintains Fitness object immutability by returning a new instance of the current class type.

Specified by:

newInstance in interface Fitness

Parameters:

value - The desired value of the Fitness object.