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

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

All Implemented Interfaces:

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

public class ClassificationErrorReal
extends Object
implements NNError

Author:

Stefan

See Also:

Serialized Form

Field Summary

protected int	numberPatternsCorrect
protected int	numberPatternsIncorrect
protected double	outputSensitivityThreshold
protected double	percentageCorrect

Constructor Summary

ClassificationErrorReal()

Method Summary

int	compareTo(Fitness f) 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.
String	getName()
int	getNumberPatternsCorrect()
int	getNumberPatternsIncorrect()
double	getOutputSensitivityThreshold()
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 nr)
void	setNoPatterns(int noPatterns)
void	setOutputSensitivityThreshold(double outputSensitivityThreshold)
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

numberPatternsCorrect

protected int numberPatternsCorrect

numberPatternsIncorrect

protected int numberPatternsIncorrect

outputSensitivityThreshold

protected double outputSensitivityThreshold

percentageCorrect

protected double percentageCorrect

Constructor Detail

ClassificationErrorReal

public ClassificationErrorReal()

Method Detail

computeIteration

public void computeIteration(TypeList output,
                             NNPattern input)

Specified by:

computeIteration in interface NNError

finaliseError

public void finaliseError()

Specified by:

finaliseError in interface NNError

setValue

public void setValue(Object val)

Specified by:

setValue in interface NNError

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 f)

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:

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

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

getName

public String getName()

Specified by:

getName in interface NNError

setNoPatterns

public void setNoPatterns(int noPatterns)

Specified by:

setNoPatterns in interface NNError

setNoOutputs

public void setNoOutputs(int nr)

Specified by:

setNoOutputs in interface NNError

getOutputSensitivityThreshold

public double getOutputSensitivityThreshold()

setOutputSensitivityThreshold

public void setOutputSensitivityThreshold(double outputSensitivityThreshold)

getNumberPatternsCorrect

public int getNumberPatternsCorrect()

getNumberPatternsIncorrect

public int getNumberPatternsIncorrect()

toString

public String toString()

Overrides:

toString in class Object

initialize

public void initialize()

Specified by:

initialize in interface Initializable

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.