java.lang.Object
- network.aika.Provider<INeuron>
- - network.aika.neuron.Neuron

All Implemented Interfaces:

java.lang.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

All Methods Static Methods Instance Methods Concrete Methods
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)`
`java.util.stream.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.
`java.util.stream.Stream<Activation>`	`getActivations(Document doc, int slot, Position pos, boolean onlyFinal)`
`java.util.Collection<Synapse>`	`getInMemoryInputSynapses()`
`java.util.Collection<Synapse>`	`getInMemoryOutputSynapses()`
`java.lang.String`	`getLabel()`
`int`	`getNewSynapseId()`
`PassiveInputFunction`	`getPassiveInputFunction()`
`Synapse`	`getSynapseById(int synapseId)`
`static Neuron`	`init(Document doc, Neuron n, double bias, ActivationFunction activationFunction, INeuron.Type type, java.util.Collection<Neuron.Builder> inputs)`
`static Neuron`	`init(Document doc, Neuron n, double bias, ActivationFunction activationFunction, INeuron.Type type, java.util.Collection<Synapse.Builder> synapseBuilders, java.util.Collection<Relation.Builder> relationBuilders)`	Initializes a neuron with the given bias.
`static Neuron`	`init(Document doc, Neuron n, double bias, ActivationFunction activationFunction, INeuron.Type type, Neuron.Builder... inputs)`	Creates a neuron with the given bias.
`static Neuron`	`init(Document doc, Neuron n, double bias, INeuron.Type type, 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, ActivationFunction activationFunction, INeuron.Type type, java.util.Collection<Neuron.Builder> inputs)`
`static Neuron`	`init(Neuron n, double bias, ActivationFunction activationFunction, INeuron.Type type, java.util.Collection<Synapse.Builder> synapseBuilders, java.util.Collection<Relation.Builder> relationBuilders)`	Initializes a neuron with the given bias.
`static Neuron`	`init(Neuron n, double bias, ActivationFunction activationFunction, INeuron.Type type, Neuron.Builder... inputs)`	Creates a neuron with the given bias.
`static Neuron`	`init(Neuron n, double bias, INeuron.Type type, java.util.Collection<Neuron.Builder> inputs)`
`static Neuron`	`init(Neuron n, double bias, INeuron.Type type, java.util.Collection<Synapse.Builder> synapseBuilders, java.util.Collection<Relation.Builder> relationBuilders)`	Creates a neuron with the given bias.
`static Neuron`	`init(Neuron n, double bias, INeuron.Type type, 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, java.util.function.Predicate<Synapse> filter)`
`void`	`setOutputText(java.lang.String outputText)`
`void`	`setPassiveInputFunction(PassiveInputFunction f)`
`java.lang.String`	`toString()`

Methods inherited from class network.aika.Provider
compareTo, equals, get, get, get, getIfNotSuspended, hashCode, 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 java.lang.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,
                           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)