Package network.aika.neuron

Class Neuron

java.lang.Object

network.aika.Provider<INeuron>

network.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

Modifier and Type	Class	Description
static interface	Neuron.Builder

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

Provider.SuspensionMode

Field Summary

Fields

Modifier and Type	Field	Description
static Neuron	MAX_NEURON
static Neuron	MIN_NEURON

Fields inherited from class network.aika.Provider

id, model

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Activation	addInput(Document doc, int begin, int end)	Propagate an input activation into the network.
Activation	addInput(Document doc, Activation.Builder inputAct)	Propagate an input activation into the network.
Activation	getActivation(Document doc, int begin, int end, boolean onlyFinal)
Stream<Activation>	getActivations(Document doc, boolean onlyFinal)	getFinalActivations is a convenience method to retrieve all activations of the given neuron that are part of the final interpretation.
Stream<Activation>	getActivations(Document doc, int slot, Position pos, boolean onlyFinal)
Collection<Synapse>	getActiveInputSynapses()	Active input synapses are those synapses that are currently available in the main memory.
Collection<Synapse>	getActiveOutputSynapses()
String	getLabel()
int	getNewSynapseId()
PassiveInputFunction	getPassiveInputFunction()
Synapse	getSynapseById(int synapseId)
INeuron.Type	getType()
static Neuron	init(Document doc, Neuron n, double bias, Collection<Neuron.Builder> inputs)
static Neuron	init(Document doc, Neuron n, double bias, Collection<Synapse.Builder> synapseBuilders, Collection<Relation.Builder> relationBuilders)	Initializes a neuron with the given bias.
static Neuron	init(Document doc, Neuron n, double bias, Neuron.Builder... inputs)	Creates a neuron with the given bias.
static Neuron	init(Document doc, Neuron n, Neuron.Builder... inputs)
static Neuron	init(Neuron n, double bias, Collection<Neuron.Builder> inputs)
static Neuron	init(Neuron n, double bias, Collection<Synapse.Builder> synapseBuilders, Collection<Relation.Builder> relationBuilders)	Initializes a neuron with the given bias.
static Neuron	init(Neuron n, double bias, Neuron.Builder... inputs)	Creates a neuron with the given bias.
static Neuron	init(Neuron n, Neuron.Builder... inputs)
void	registerSynapseId(int synId)
Synapse	selectInputSynapse(Neuron inputNeuron, Predicate<Synapse> filter)
void	setActivationFunction(ActivationFunction actF)
void	setOutputText(String outputText)
void	setPassiveInputFunction(PassiveInputFunction f)
void	setType(INeuron.Type t)
String	toString()

Methods inherited from class network.aika.Provider

compareTo, delete, equals, get, get, get, getId, getIfNotSuspended, getModel, hashCode, isMarkedDeleted, isSuspended, save, suspend

Methods inherited from class java.lang.Object

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

Field Detail

MIN_NEURON

public static final Neuron MIN_NEURON

MAX_NEURON

public static final Neuron MAX_NEURON

Constructor Detail

Neuron

public Neuron(Model m,
              int id)

Neuron

public Neuron(Model m,
              INeuron n)

Method Detail

getLabel

public String getLabel()

getType

public INeuron.Type getType()

setType

public void setType(INeuron.Type t)

setActivationFunction

public void setActivationFunction(ActivationFunction actF)

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,
                           Activation.Builder inputAct)

Propagate an input activation into the network.

Parameters:

doc - The current document

inputAct -

init

public static Neuron init(Neuron n,
                          Neuron.Builder... inputs)

init

public static Neuron init(Document doc,
                          Neuron n,
                          Neuron.Builder... inputs)

init

public static Neuron init(Neuron n,
                          double bias,
                          Neuron.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,
                          Neuron.Builder... inputs)

Creates a neuron with the given bias.

Parameters:

n -

bias -

inputs -

Returns:

init

public static Neuron init(Neuron n,
                          double bias,
                          Collection<Synapse.Builder> synapseBuilders,
                          Collection<Relation.Builder> relationBuilders)

Initializes a neuron with the given bias.

Parameters:

n -

bias -

synapseBuilders -

relationBuilders -

Returns:

init

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

init

public static Neuron init(Document doc,
                          Neuron n,
                          double bias,
                          Collection<Synapse.Builder> synapseBuilders,
                          Collection<Relation.Builder> relationBuilders)

Initializes a neuron with the given bias.

Parameters:

n -

bias -

synapseBuilders -

relationBuilders -

Returns:

init

public static Neuron init(Document doc,
                          Neuron n,
                          double bias,
                          Collection<Neuron.Builder> inputs)

getPassiveInputFunction

public PassiveInputFunction getPassiveInputFunction()

setPassiveInputFunction

public void setPassiveInputFunction(PassiveInputFunction f)

setOutputText

public void setOutputText(String outputText)

getSynapseById

public Synapse getSynapseById(int synapseId)

getActivations

public Stream<Activation> getActivations(Document doc,
                                         boolean onlyFinal)

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.

getActivations

public Stream<Activation> getActivations(Document doc,
                                         int slot,
                                         Position pos,
                                         boolean onlyFinal)

getActivation

public Activation getActivation(Document doc,
                                int begin,
                                int end,
                                boolean onlyFinal)

selectInputSynapse

public Synapse selectInputSynapse(Neuron inputNeuron,
                                  Predicate<Synapse> filter)

toString

public String toString()

Overrides:

toString in class Provider<INeuron>

getNewSynapseId

public int getNewSynapseId()

registerSynapseId

public void registerSynapseId(int synId)

getActiveInputSynapses

public Collection<Synapse> getActiveInputSynapses()

Active input synapses are those synapses that are currently available in the main memory.

Returns:

getActiveOutputSynapses

public Collection<Synapse> getActiveOutputSynapses()