Package mgui.neuro.networks

Class AbstractNeuralNet

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.interfaces.models.InterfaceAbstractModel

mgui.models.networks.AbstractNetworkModel

mgui.models.networks.AbstractNetwork

mgui.neuro.networks.AbstractNeuralNet

All Implemented Interfaces:

java.lang.Cloneable, AttributeObject, GraphableObject, InterfaceObject, NamedObject, InterfaceNeuroComponentListener, TreeObject, CleanableObject, DynamicModel, InterfaceNetworkComponentListener

Direct Known Subclasses:

KohonenNet, PerceptronNet

public abstract class AbstractNeuralNet
extends AbstractNetwork
implements InterfaceNeuroComponentListener

Abstract class for all neural net classes to inherit.

Author:

Andrew Reid

Field Summary

Fields

Modifier and Type	Field	Description
java.util.ArrayList<AbstractSensoryNeuron>	inputs
static int	MODE_TEST
static int	MODE_TRAIN
java.util.ArrayList<ConnectableNeuron>	units

Fields inherited from class mgui.models.networks.AbstractNetwork

idFactory, listeners

Fields inherited from class mgui.models.networks.AbstractNetworkModel

attributes, environment

Fields inherited from class mgui.interfaces.AbstractInterfaceObject

isDestroyed, tree_nodes

Constructor Summary

Constructors

Constructor	Description
AbstractNeuralNet()

Method Summary

Modifier and Type	Method	Description
boolean	addUnit(ConnectableNeuron unit)
boolean	addUnit(ConnectableNeuron unit, boolean fire)
void	componentUpdated(NetworkComponentEvent e)
protected void	fireUnitAdded(ConnectableNeuron n)
java.util.ArrayList<DynamicModelComponent>	getComponents()
java.util.ArrayList<InterfaceDataSource>	getDataSources()
abstract double	getEnergy()	Returns the energy calculation for this neural network.
NeuralNetGraph	getGraph()	Constructs and returns a directed graph from the model components and their connections.
java.lang.String	getName()	Gets the name for this object.
int	getUnitCount()
protected void	init()
boolean	removeUnit(ConnectableNeuron unit)
void	setName(java.lang.String name)	Sets the name for this object.
void	setTreeNode(InterfaceTreeNode treeNode)	Sets the children for this node's InterfaceTreeNode.

Methods inherited from class mgui.models.networks.AbstractNetwork

addListener, fireListeners, fireListeners, removeListener, reset

Methods inherited from class mgui.models.networks.AbstractNetworkModel

addListener, addSensor, clone, fireComponentAdded, fireComponentRemoved, getAttribute, getAttributes, getAttributeValue, getEnvironment, getSensors, removeListener, removeSensor, setAttribute, setAttributes, setEnvironment

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, destroy, getTreeLabel, isDestroyed, issueTreeNode, updateTreeNodes

Methods inherited from class java.lang.Object

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

Methods inherited from interface mgui.interfaces.util.CleanableObject

clean

Methods inherited from interface mgui.interfaces.InterfaceObject

destroy, isDestroyed

Methods inherited from interface mgui.interfaces.trees.TreeObject

getTreeLabel, issueTreeNode

Field Details

MODE_TRAIN

public static final int MODE_TRAIN

See Also:

Constant Field Values

MODE_TEST

public static final int MODE_TEST

See Also:

Constant Field Values

units

public java.util.ArrayList<ConnectableNeuron> units

inputs

public java.util.ArrayList<AbstractSensoryNeuron> inputs

Constructor Details

AbstractNeuralNet

public AbstractNeuralNet()

Method Details

getGraph

public NeuralNetGraph getGraph()

Constructs and returns a directed graph from the model components and their connections. DirectedGraph is a class provided in the JUNG API.

Specified by:

getGraph in interface GraphableObject

Specified by:

getGraph in class AbstractNetwork

Returns:

init

protected void init()

Overrides:

init in class AbstractNetwork

getDataSources

public java.util.ArrayList<InterfaceDataSource> getDataSources()

getUnitCount

public int getUnitCount()

componentUpdated

public void componentUpdated(NetworkComponentEvent e)

Specified by:

componentUpdated in interface InterfaceNetworkComponentListener

setTreeNode

public void setTreeNode(InterfaceTreeNode treeNode)

Description copied from interface: TreeObject

Sets the children for this node's InterfaceTreeNode.

Specified by:

setTreeNode in interface TreeObject

Overrides:

setTreeNode in class AbstractInterfaceObject

addUnit

public boolean addUnit(ConnectableNeuron unit)
                throws NeuroNetException

Throws:

NeuroNetException

addUnit

public boolean addUnit(ConnectableNeuron unit,
boolean fire)
                throws NeuroNetException

Throws:

NeuroNetException

fireUnitAdded

protected void fireUnitAdded(ConnectableNeuron n)

removeUnit

public boolean removeUnit(ConnectableNeuron unit)

getName

public java.lang.String getName()

Description copied from interface: NamedObject

Gets the name for this object.

Specified by:

getName in interface NamedObject

Overrides:

getName in class AbstractInterfaceObject

Returns:

getEnergy

public abstract double getEnergy()

Returns the energy calculation for this neural network. I.e., the Lyapunov function. All instances of AbstractNeuralNet must implement this.

Returns:

getComponents

public java.util.ArrayList<DynamicModelComponent> getComponents()

Specified by:

getComponents in interface DynamicModel

Specified by:

getComponents in class AbstractNetwork

setName

public void setName(java.lang.String name)

Description copied from interface: NamedObject

Sets the name for this object.

Specified by:

setName in interface NamedObject

Overrides:

setName in class AbstractInterfaceObject