org.joone.engine.learning

Class AbstractTeacherSynapse

java.lang.Object

org.joone.engine.Synapse

org.joone.engine.learning.AbstractTeacherSynapse

All Implemented Interfaces:

java.io.Serializable, InputPatternListener, Learnable, LearnableSynapse, NeuralElement, OutputPatternListener, Inspectable

Direct Known Subclasses:

TeacherSynapse

public abstract class AbstractTeacherSynapse
extends Synapse

This class provides a framework to extend in order to implement various teachers, just by overriding or implementing certain functions different functionality can easily implemented.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractTeacherSynapse() Creates a new instance of AbstractTeacherSynapse

Method Summary

Modifier and Type	Method and Description
java.util.TreeSet	check() Base for check messages.
Pattern	fwdGet() Here, it forwards (returns) the pushed error (in FIFO order).
void	fwdPut(Pattern pattern) Method to put a pattern forward to the next layer
StreamInputSynapse	getDesired() Gets the stream to read the desired output.
void	init() Synapse's initialization.
void	netStoppedError()
void	reset() Reset the input and desired synapses
void	resetInput()
Pattern	revGet() Returns the error pattern coming from the next layer during the training phase
void	revPut(Pattern pattern) Method to put an error pattern backward to the previous layer
boolean	setDesired(StreamInputSynapse newDesired) Set the input data stream containing desired training data.
void	setInputDimension(int newInputDimension) Sets the input dimension of the synapse
void	setMonitor(Monitor newMonitor) Sets the Monitor object of the Teacher Synapse.

Methods inherited from class org.joone.engine.Synapse

addNoise, canCountSteps, getIgnoreBefore, getInputDimension, getLearner, getLearningRate, getMomentum, getMonitor, getName, getOutputDimension, getWeights, initLearner, InspectableTitle, Inspections, isEnabled, isInputFull, isLoopBack, isOutputFull, randomize, setEnabled, setIgnoreBefore, setInputFull, setLearningRate, setLoopBack, setMomentum, setName, setOutputDimension, setOutputFull, setWeights

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTeacherSynapse

public AbstractTeacherSynapse()

Creates a new instance of AbstractTeacherSynapse

Method Detail

fwdGet

public Pattern fwdGet()

Here, it forwards (returns) the pushed error (in FIFO order).

Specified by:

fwdGet in interface InputPatternListener

Overrides:

fwdGet in class Synapse

Returns:

the pattern holding the error of the network. {@link Synapse#fwdGet()

getDesired

public StreamInputSynapse getDesired()

Gets the stream to read the desired output.

Returns:

the desired output stream.

setDesired

public boolean setDesired(StreamInputSynapse newDesired)

Set the input data stream containing desired training data.

Parameters:

newDesired - the stream from where to read the desired output.

setInputDimension

public void setInputDimension(int newInputDimension)

Description copied from class: Synapse

Sets the input dimension of the synapse

Specified by:

setInputDimension in interface OutputPatternListener

Overrides:

setInputDimension in class Synapse

Parameters:

newInputDimension - int

reset

public void reset()

Reset the input and desired synapses

Specified by:

reset in interface InputPatternListener

Overrides:

reset in class Synapse

resetInput

public void resetInput()

setMonitor

public void setMonitor(Monitor newMonitor)

Sets the Monitor object of the Teacher Synapse.

Specified by:

setMonitor in interface NeuralElement

Overrides:

setMonitor in class Synapse

Parameters:

newMonitor - neural.engine.Monitor

netStoppedError

public void netStoppedError()

init

public void init()

Description copied from class: Synapse

Synapse's initialization. It needs to be invoked at the starting of the neural network It's called within the Layer.init() method

Specified by:

init in interface NeuralElement

Overrides:

init in class Synapse

check

public java.util.TreeSet check()

Description copied from class: Synapse

Base for check messages. Subclasses should call this method from thier own check method.

Specified by:

check in interface NeuralElement

Overrides:

check in class Synapse

Returns:

validation errors.

See Also:

InputPaternListener, OutputPaternListener

revPut

public void revPut(Pattern pattern)

Description copied from interface: InputPatternListener

Method to put an error pattern backward to the previous layer

Specified by:

revPut in interface InputPatternListener

Overrides:

revPut in class Synapse

Parameters:

pattern - neural.engine.Pattern

revGet

public Pattern revGet()

Description copied from interface: OutputPatternListener

Returns the error pattern coming from the next layer during the training phase

Specified by:

revGet in interface OutputPatternListener

Overrides:

revGet in class Synapse

Returns:

neural.engine.Pattern

fwdPut

public void fwdPut(Pattern pattern)

Description copied from interface: OutputPatternListener

Method to put a pattern forward to the next layer

Specified by:

fwdPut in interface OutputPatternListener

Overrides:

fwdPut in class Synapse

Parameters:

pattern - neural.engine.Pattern