org.simbrain.network.subnetworks

Class FeedForward

java.lang.Object

org.simbrain.network.groups.Group

org.simbrain.network.groups.Subnetwork

org.simbrain.network.subnetworks.FeedForward

Direct Known Subclasses:

BackpropNetwork, BPTTNetwork, LMSNetwork

public class FeedForward
extends Subnetwork

A standard feed-forward network, where a succession of neuron groups and synapse groups are organized into layers.

Author:

Jeff Yoshimi

Constructor Summary

Constructors

Constructor and Description
FeedForward(Network network, int[] nodesPerLayer, java.awt.geom.Point2D initialPosition) Add the layered network to the specified network, with a specified number of layers and nodes in each layer.
FeedForward(Network network, int[] nodesPerLayer, java.awt.geom.Point2D initialPosition, Neuron inputNeuronTemplate) Construct a feed-forward network.

Method Summary

Modifier and Type	Method and Description
void	addNeuronGroup(NeuronGroup group) Add a neuron group.
int	getBetweenLayerInterval()
NeuronGroup	getInputLayer() Returns the input layer.
java.util.List<Neuron>	getInputNeurons() Convenience method for getting the neurons associated with the input group.
NeuronGroup	getOutputLayer() Returns the output layer.
java.util.List<Neuron>	getOutputNeurons() Convenience method for getting the neurons associated with the output group.
java.lang.String	getUpdateMethodDesecription() Returns a description of this group's update method, which is displayed in the update manager panel.
void	setBetweenLayerInterval(int betweenLayerInterval)

Methods inherited from class org.simbrain.network.groups.Subnetwork

addAndLabelSynapseGroup, addRowToTrainingSet, addSynapseGroup, clearActivations, connectNeuronGroups, connectNeuronGroups, connectNeuronGroups, delete, displayNeuronGroups, getEnabled, getFlatNeuronList, getFlatSynapseList, getIndexOfNeuronGroup, getLongDescription, getModifiableNeuronList, getNeuronGroup, getNeuronGroup, getNeuronGroupByLabel, getNeuronGroupCount, getNeuronGroupList, getNeuronGroupsAsList, getSynapseGroup, getSynapseGroup, getSynapseGroupByLabel, getSynapseGroupCount, getSynapseGroupList, isEmpty, recursivelySetIds, removeNeuronGroup, removeSynapseGroup, setDisplayNeuronGroups, setEnabled, size, toString, update

Methods inherited from class org.simbrain.network.groups.Group

getId, getLabel, getParentGroup, getParentNetwork, getStateInfo, hasParentGroup, isMarkedForDeletion, isTopLevelGroup, setId, setLabel, setMarkedForDeletion, setParentGroup, setStateInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedForward

public FeedForward(Network network,
                   int[] nodesPerLayer,
                   java.awt.geom.Point2D initialPosition,
                   Neuron inputNeuronTemplate)

Construct a feed-forward network.

Parameters:

network - the parent network to which the layered network is being added

nodesPerLayer - an array of integers which determines the number of layers and neurons in each layer. Integers 1...n in the array correspond to the number of nodes in layers 1...n.

initialPosition - bottom corner where network will be placed.

inputNeuronTemplate - the type of Neuron to use for the input layer

FeedForward

public FeedForward(Network network,
                   int[] nodesPerLayer,
                   java.awt.geom.Point2D initialPosition)

Add the layered network to the specified network, with a specified number of layers and nodes in each layer.

Parameters:

network - the parent network to which the layered network is being added

nodesPerLayer - an array of integers which determines the number of layers and neurons in each layer. Integers 1...n in the array correspond to the number of nodes in layers 1...n.

initialPosition - upper left corner where network will be placed.

Method Detail

getBetweenLayerInterval

public int getBetweenLayerInterval()

Returns:

the betweenLayerInterval

setBetweenLayerInterval

public void setBetweenLayerInterval(int betweenLayerInterval)

Parameters:

betweenLayerInterval - the betweenLayerInterval to set

addNeuronGroup

public void addNeuronGroup(NeuronGroup group)

Description copied from class: Subnetwork

Add a neuron group.

Overrides:

addNeuronGroup in class Subnetwork

Parameters:

group - the neuron group to add

getInputLayer

public NeuronGroup getInputLayer()

Returns the input layer.

Returns:

the input layer

getOutputLayer

public NeuronGroup getOutputLayer()

Returns the output layer.

Returns:

the output layer

getInputNeurons

public java.util.List<Neuron> getInputNeurons()

Convenience method for getting the neurons associated with the input group. Also allows all feed-forward networks to implement Trainable.

Returns:

the input layer neurons as a list.

getOutputNeurons

public java.util.List<Neuron> getOutputNeurons()

Convenience method for getting the neurons associated with the output group. Also allows all feed-forward networks to implement Trainable.

Returns:

the output layer neurons as a list.

getUpdateMethodDesecription

public java.lang.String getUpdateMethodDesecription()

Description copied from class: Group

Returns a description of this group's update method, which is displayed in the update manager panel.

Overrides:

getUpdateMethodDesecription in class Subnetwork

Returns:

a description of the update method.