com.penguinwerks.jodene
Class Axon

java.lang.Object
  com.penguinwerks.jodene.Axon

All Implemented Interfaces:

java.io.Serializable

public class Axon

extends java.lang.Object

implements java.io.Serializable

An axon connects two neurons. As signals propagate forward through the neural network, the axon carries the signal from the base to the dendrite

Author:

Paul Hoehne

See Also:

Serialized Form

Constructor Summary

Axon()
Constructor - Creates a new Axon with a unique name.

Axon(java.lang.Integer id)
Constructor - creates an Axon with the given name.

Method Summary

void	feedback(double val) When training feedback is fired from the dendrite neuron back to the base.
Neuron	getBase() Returns the base of the Axon.
Neuron	getDendrite() Returns the dendrite of the Axon.
java.lang.Integer	getId() Returns the Id of the axon.
void	propagate(double val) Propagates the given signal to the dendrite neuron from the base.
void	setBase(Neuron neuron) A signal propagates from the base neuron to the dendrite neuron through the axon.
void	setDendrite(Neuron neuron) Sets the dendrite or destination neuron for this axon.

Methods inherited from class java.lang.Object

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

Constructor Detail

Axon

public Axon()

Constructor - Creates a new Axon with a unique name.

Axon

public Axon(java.lang.Integer id)

Constructor - creates an Axon with the given name.

Parameters:

id - Axon name

Method Detail

getId

public java.lang.Integer getId()

Returns the Id of the axon.

Returns:

The id of the azon.

getDendrite

public Neuron getDendrite()

Returns the dendrite of the Axon. A dendrite is the recipient neuron when a signal is propaged through the Axon. When the axon carries a signal it sends it from the base to the dendrite.

Returns:

The dendrite or destination neuron.

getBase

public Neuron getBase()

Returns the base of the Axon. The base is the neuron that will fire into this axon, sending the signal to the dendrite. When an axon carries a signal, it does so from the base to the dendrite.

Returns:

The base of the axon or the source neuron.

setDendrite

public void setDendrite(Neuron neuron)

Sets the dendrite or destination neuron for this axon. An axon fires from the base neuron to the dendrite. The dendrite recieves the signal from this axon.

Parameters:

neuron - The dendrite neuron or signal recipient.

setBase

public void setBase(Neuron neuron)

A signal propagates from the base neuron to the dendrite neuron through the axon. This sets the base, or the neuron that will send a signal to this axon that propagates to the dendrite.

Parameters:

neuron - The base neuron.

propagate

public void propagate(double val)

Propagates the given signal to the dendrite neuron from the base. It notifies that dendrite neuron that it has fired, by passing itself into the recieveSignal method of the dendrite neuron.

Parameters:

val - The value to propagate.

feedback

public void feedback(double val)

When training feedback is fired from the dendrite neuron back to the base. This allows the base neuron to adjust its weight accordingly. For middle-tier neurons this consists of the delta * the connecting weight.

Parameters:

val - The feedback value.