org.aika

Class Neuron

java.lang.Object

org.aika.Provider<INeuron>

org.aika.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

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, m

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Activation	addInput(Document doc, int begin, int end) Propagate an input activation into the network.
Activation	addInput(Document doc, int begin, int end, Integer rid) Propagate an input activation into the network.
Activation	addInput(Document doc, int begin, int end, Integer rid, InterprNode o) Propagate an input activation into the network.
Activation	addInput(Document doc, int begin, int end, Integer rid, InterprNode o, double value) Propagate an input activation into the network.
Activation	addInput(Document doc, int begin, int end, InterprNode o) Propagate an input activation into the network.
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.
void	removeInput(Document doc, int begin, int end)
void	removeInput(Document doc, int begin, int end, Integer rid)
void	removeInput(Document doc, int begin, int end, Integer rid, InterprNode o)
void	removeInput(Document doc, int begin, int end, InterprNode o)

Methods inherited from class org.aika.Provider

compareTo, discard, equals, get, getIfNotSuspended, hashCode, isSuspended, setModified, 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

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,
                           InterprNode o)

Propagate an input activation into the network.

Parameters:

doc - The current document

begin - The range begin

end - The range end

o - The interpretation node

addInput

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

Propagate an input activation into the network.

Parameters:

doc - The current document

begin - The range begin

end - The range end

rid - The relational id (e.g. the word position)

addInput

public Activation addInput(Document doc,
                           int begin,
                           int end,
                           Integer rid,
                           InterprNode o)

Propagate an input activation into the network.

Parameters:

doc - The current document

begin - The range begin

end - The range end

rid - The relational id (e.g. the word position)

o - The interpretation node

addInput

public Activation addInput(Document doc,
                           int begin,
                           int end,
                           Integer rid,
                           InterprNode o,
                           double value)

Propagate an input activation into the network.

Parameters:

doc - The current document

begin - The range begin

end - The range end

rid - The relational id (e.g. the word position)

o - The interpretation node

value - The activation value of this input activation

removeInput

public void removeInput(Document doc,
                        int begin,
                        int end)

removeInput

public void removeInput(Document doc,
                        int begin,
                        int end,
                        InterprNode o)

removeInput

public void removeInput(Document doc,
                        int begin,
                        int end,
                        Integer rid)

removeInput

public void removeInput(Document doc,
                        int begin,
                        int end,
                        Integer rid,
                        InterprNode o)

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.