org.aika.neuron

Class Synapse.Builder

java.lang.Object

org.aika.neuron.Synapse.Builder

All Implemented Interfaces:

Comparable<Synapse.Builder>

Direct Known Subclasses:

MetaSynapse.Builder

Enclosing class:

Synapse

public static class Synapse.Builder
extends Object
implements Comparable<Synapse.Builder>

The Builder class is just a helper class which is used to initialize a neuron. Most of the parameters of this class will be mapped to a input synapse for this neuron.

Author:

Lukas Molzberger

Field Summary

Fields

Modifier and Type	Field and Description
Integer	absoluteRid
double	bias
Neuron	neuron
Range.Relation	rangeMatch
Range.Output	rangeOutput
boolean	recurrent
Integer	relativeRid
double	weight

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Synapse.Builder in)
Synapse	getSynapse(Neuron outputNeuron)
Synapse.Builder	setAbsoluteRid(Integer absoluteRid) If the absolute relational id (rid) not null, then it is required to match the rid of input activation.
Synapse.Builder	setBias(double bias) The bias of this input that will later on be added to the neurons bias.
Synapse.Builder	setNeuron(Neuron neuron) Determines the input neuron.
Synapse.Builder	setRangeMatch(Range.Operator beginToBegin, Range.Operator endToEnd) setRangeMatch is just a convenience function to call both setBeginToBeginRangeMatch and setEndToEndRangeMatch at the same time.
Synapse.Builder	setRangeMatch(Range.Relation rr) setRangeMatch is just a convenience function to call both setBeginToBeginRangeMatch and setEndToEndRangeMatch at the same time.
Synapse.Builder	setRangeOutput(boolean ro) setRangeOutput is just a convenience function to call setBeginRangeOutput and setEndRangeOutput at the same time.
Synapse.Builder	setRangeOutput(boolean begin, boolean end) setRangeOutput is just a convenience function to call setBeginRangeOutput and setEndRangeOutput at the same time.
Synapse.Builder	setRangeOutput(Range.Mapping begin, Range.Mapping end) Determines if this input is used to compute the range start of the output activation.
Synapse.Builder	setRangeOutput(Range.Output rangeOutput) setRangeOutput is just a convenience function to call setBeginRangeOutput and setEndRangeOutput at the same time.
Synapse.Builder	setRecurrent(boolean recurrent) The property recurrent specifies if input is a recurrent feedback link.
Synapse.Builder	setRelativeRid(Integer relativeRid) The relative relational id (rid) determines the relative position of this inputs rid with respect to other inputs of this neuron.
Synapse.Builder	setWeight(double weight) The synapse weight of this input.

Methods inherited from class java.lang.Object

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

Field Detail

recurrent

public boolean recurrent

neuron

public Neuron neuron

weight

public double weight

bias

public double bias

rangeMatch

public Range.Relation rangeMatch

rangeOutput

public Range.Output rangeOutput

relativeRid

public Integer relativeRid

absoluteRid

public Integer absoluteRid

Constructor Detail

Builder

public Builder()

Method Detail

setRecurrent

public Synapse.Builder setRecurrent(boolean recurrent)

The property recurrent specifies if input is a recurrent feedback link. Recurrent feedback links can be either negative or positive depending on the weight of the synapse. Recurrent feedback links kind of allow to use future information as inputs of a current neuron. Aika allows this by making assumptions about the recurrent input neuron. The class SearchNode modifies these assumptions until the best interpretation for this document is found.

Parameters:

recurrent -

Returns:

setNeuron

public Synapse.Builder setNeuron(Neuron neuron)

Determines the input neuron.

Parameters:

neuron -

Returns:

setWeight

public Synapse.Builder setWeight(double weight)

The synapse weight of this input.

Parameters:

weight -

Returns:

setBias

public Synapse.Builder setBias(double bias)

The bias of this input that will later on be added to the neurons bias.

Parameters:

bias -

Returns:

setAbsoluteRid

public Synapse.Builder setAbsoluteRid(Integer absoluteRid)

If the absolute relational id (rid) not null, then it is required to match the rid of input activation.

Parameters:

absoluteRid -

Returns:

setRelativeRid

public Synapse.Builder setRelativeRid(Integer relativeRid)

The relative relational id (rid) determines the relative position of this inputs rid with respect to other inputs of this neuron.

Parameters:

relativeRid -

Returns:

setRangeMatch

public Synapse.Builder setRangeMatch(Range.Relation rr)

setRangeMatch is just a convenience function to call both setBeginToBeginRangeMatch and setEndToEndRangeMatch at the same time.

Parameters:

rr -

Returns:

setRangeMatch

public Synapse.Builder setRangeMatch(Range.Operator beginToBegin,
                                     Range.Operator endToEnd)

setRangeMatch is just a convenience function to call both setBeginToBeginRangeMatch and setEndToEndRangeMatch at the same time.

Parameters:

beginToBegin -

endToEnd -

Returns:

setRangeOutput

public Synapse.Builder setRangeOutput(boolean ro)

setRangeOutput is just a convenience function to call setBeginRangeOutput and setEndRangeOutput at the same time.

Parameters:

ro -

Returns:

setRangeOutput

public Synapse.Builder setRangeOutput(boolean begin,
                                      boolean end)

setRangeOutput is just a convenience function to call setBeginRangeOutput and setEndRangeOutput at the same time.

Parameters:

begin -

end -

Returns:

setRangeOutput

public Synapse.Builder setRangeOutput(Range.Output rangeOutput)

setRangeOutput is just a convenience function to call setBeginRangeOutput and setEndRangeOutput at the same time.

Parameters:

rangeOutput -

Returns:

setRangeOutput

public Synapse.Builder setRangeOutput(Range.Mapping begin,
                                      Range.Mapping end)

Determines if this input is used to compute the range start of the output activation.

Parameters:

begin -

end -

Returns:

getSynapse

public Synapse getSynapse(Neuron outputNeuron)

compareTo

public int compareTo(Synapse.Builder in)

Specified by:

compareTo in interface Comparable<Synapse.Builder>