org.aika.neuron

Class Neuron

java.lang.Object

org.aika.Provider<INeuron>

org.aika.neuron.Neuron

All Implemented Interfaces:

Comparable<Provider<?>>

public class Neuron
extends Provider<INeuron>

The Neuron class is a proxy implementation for the real neuron implementation in the class INeuron. Aika uses the provider pattern to store and reload rarely used neurons or logic nodes.

Author:

Lukas Molzberger

Nested Class Summary

Nested classes/interfaces inherited from class org.aika.Provider

Provider.SuspensionMode

Field Summary

Fields

Modifier and Type	Field and Description
NavigableMap<Synapse,Synapse>	inMemoryInputSynapses
NavigableMap<Synapse,Synapse>	inMemoryOutputSynapses
ReadWriteLock	lock

Fields inherited from class org.aika.Provider

id, model

Constructor Summary

Constructors

Constructor and Description
Neuron(Model m, INeuron n)
Neuron(Model m, int id)

Method Summary

Modifier and Type	Method and Description
void	addInMemoryInputSynapse(Synapse s)
void	addInMemoryOutputSynapse(Synapse s)
Activation	addInput(Document doc, Activation.Builder inputAct) Propagate an input activation into the network.
Activation	addInput(Document doc, int begin, int end) Propagate an input activation into the network.
Activation	addInput(Document doc, int begin, int end, Integer relationalId) Propagate an input activation into the network.
void	addSynapse(Document doc, Synapse.Builder input)
void	addSynapse(Synapse.Builder input)
Collection<Activation>	getFinalActivations(Document doc) getFinalActivations is a convenience method to retrieve all activations of the given neuron that are part of the final interpretation.
String	getLabel()
boolean	init(Document doc, double bias, String activationFunctionKey, INeuron.Type type, Collection<Synapse.Builder> inputs)
static Neuron	init(Document doc, Neuron n, double bias, INeuron.Type type, Synapse.Builder... inputs) Creates a neuron with the given bias.
static Neuron	init(Document doc, Neuron n, double bias, String activationFunctionKey, INeuron.Type type, Collection<Synapse.Builder> inputs) Initializes a neuron with the given bias.
static Neuron	init(Document doc, Neuron n, double bias, String activationFunctionKey, INeuron.Type type, Synapse.Builder... inputs) Creates a neuron with the given bias.
boolean	init(double bias, String activationFunctionKey, INeuron.Type type, Collection<Synapse.Builder> inputs) Initializes a neuron with the given bias.
static Neuron	init(Neuron n, double bias, INeuron.Type type, Collection<Synapse.Builder> inputs) Creates a neuron with the given bias.
static Neuron	init(Neuron n, double bias, INeuron.Type type, Synapse.Builder... inputs) Creates a neuron with the given bias.
static Neuron	init(Neuron n, double bias, String activationFunctionKey, INeuron.Type type, Collection<Synapse.Builder> inputs) Initializes a neuron with the given bias.
static Neuron	init(Neuron n, double bias, String activationFunctionKey, INeuron.Type type, Synapse.Builder... inputs) Creates a neuron with the given bias.
void	removeInMemoryInputSynapse(Synapse s)
void	removeInMemoryOutputSynapse(Synapse s)

Methods inherited from class org.aika.Provider

compareTo, equals, get, get, get, getIfNotSuspended, hashCode, isSuspended, save, suspend, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lock

public ReadWriteLock lock

inMemoryInputSynapses

public NavigableMap<Synapse,Synapse> inMemoryInputSynapses

inMemoryOutputSynapses

public NavigableMap<Synapse,Synapse> inMemoryOutputSynapses

Constructor Detail

Neuron

public Neuron(Model m,
              int id)

Neuron

public Neuron(Model m,
              INeuron n)

Method Detail

getLabel

public String getLabel()

addInput

public Activation addInput(Document doc,
                           int begin,
                           int end)

Propagate an input activation into the network.

Parameters:

doc - The current document

begin - The range begin

end - The range end

addInput

public Activation addInput(Document doc,
                           int begin,
                           int end,
                           Integer relationalId)

Propagate an input activation into the network.

Parameters:

doc - The current document

begin - The range begin

end - The range end

relationalId -

addInput

public Activation addInput(Document doc,
                           Activation.Builder inputAct)

Propagate an input activation into the network.

Parameters:

doc - The current document

inputAct -

init

public static Neuron init(Neuron n,
                          double bias,
                          INeuron.Type type,
                          Synapse.Builder... inputs)

Creates a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Document doc,
                          Neuron n,
                          double bias,
                          INeuron.Type type,
                          Synapse.Builder... inputs)

Creates a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Neuron n,
                          double bias,
                          String activationFunctionKey,
                          INeuron.Type type,
                          Synapse.Builder... inputs)

Creates a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Document doc,
                          Neuron n,
                          double bias,
                          String activationFunctionKey,
                          INeuron.Type type,
                          Synapse.Builder... inputs)

Creates a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Neuron n,
                          double bias,
                          INeuron.Type type,
                          Collection<Synapse.Builder> inputs)

Creates a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Neuron n,
                          double bias,
                          String activationFunctionKey,
                          INeuron.Type type,
                          Collection<Synapse.Builder> inputs)

Initializes a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Document doc,
                          Neuron n,
                          double bias,
                          String activationFunctionKey,
                          INeuron.Type type,
                          Collection<Synapse.Builder> inputs)

Initializes a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public boolean init(double bias,
                    String activationFunctionKey,
                    INeuron.Type type,
                    Collection<Synapse.Builder> inputs)

Initializes a neuron with the given bias.

Parameters:

bias -

inputs -

Returns:

init

public boolean init(Document doc,
                    double bias,
                    String activationFunctionKey,
                    INeuron.Type type,
                    Collection<Synapse.Builder> inputs)

addSynapse

public void addSynapse(Synapse.Builder input)

addSynapse

public void addSynapse(Document doc,
                       Synapse.Builder input)

getFinalActivations

public Collection<Activation> getFinalActivations(Document doc)

getFinalActivations is a convenience method to retrieve all activations of the given neuron that are part of the final interpretation. Before calling this method, the doc.process() needs to be called first. getFinalActivations requires that the doc.process() method has been called first.

Parameters:

doc - The current document

Returns:

A collection with all final activations of this neuron.

addInMemoryInputSynapse

public void addInMemoryInputSynapse(Synapse s)

removeInMemoryInputSynapse

public void removeInMemoryInputSynapse(Synapse s)

addInMemoryOutputSynapse

public void addInMemoryOutputSynapse(Synapse s)

removeInMemoryOutputSynapse

public void removeInMemoryOutputSynapse(Synapse s)