org.encog.neural.activation
Class BasicActivationFunction

java.lang.Object
  org.encog.neural.activation.BasicActivationFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ActivationFunction, EncogPersistedObject

Direct Known Subclasses:

ActivationBiPolar, ActivationGaussian, ActivationLinear, ActivationLOG, ActivationSigmoid, ActivationSIN, ActivationSoftMax, ActivationTANH

public abstract class BasicActivationFunction
extends java.lang.Object
implements ActivationFunction

Holds basic functionality that all activation functions will likely have use of. Specifically it implements a name and description for the EncogPersistedObject class.

Author:

jheaton

See Also:

Serialized Form

Constructor Summary

BasicActivationFunction()

Method Summary

java.lang.Object	clone()
Persistor	createPersistor() Create a Persistor for this activation function.
java.lang.String	getDescription()
java.lang.String	getName()
void	setDescription(java.lang.String theDescription) Ignore the description, it is not used for activation functions.
void	setName(java.lang.String theName) Ignore the name, it is not used for activation functions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.encog.neural.activation.ActivationFunction

activationFunction, derivativeFunction, hasDerivative

Constructor Detail

BasicActivationFunction

public BasicActivationFunction()

Method Detail

clone

public java.lang.Object clone()

Specified by:

clone in interface EncogPersistedObject

Overrides:

clone in class java.lang.Object

Returns:

The object cloned.

createPersistor

public Persistor createPersistor()

Create a Persistor for this activation function.

Specified by:

createPersistor in interface EncogPersistedObject

Returns:

The persistor.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface EncogPersistedObject

Returns:

Always returns null, descriptions and names are not used for activation functions.

getName

public java.lang.String getName()

Specified by:

getName in interface EncogPersistedObject

Returns:

Always returns null, descriptions and names are not used for activation functions.

setDescription

public void setDescription(java.lang.String theDescription)

Ignore the description, it is not used for activation functions.

Specified by:

setDescription in interface EncogPersistedObject

Parameters:

theDescription - Ignored.

setName

public void setName(java.lang.String theName)

Ignore the name, it is not used for activation functions.

Specified by:

setName in interface EncogPersistedObject

Parameters:

theName - Ignored.