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

All Implemented Interfaces:

Comparable<INeuron>, Writable
```
public class INeuron
extends AbstractNode<Neuron>
implements Comparable<INeuron>
```
The INeuron class represents a internal neuron implementation in Aikas neural network and is connected to other neurons through input synapses and output synapses. The activation value of a neuron is calculated by computing the weighted sum (input act. value * synapse weight) of the input synapses, adding the bias to it and sending the resulting value through a transfer function (the upper part of tanh).

The neuron does not store its activationsBySlotAndPosition by itself. The activation objects are stored within the logic nodes. To access the activationsBySlotAndPosition of this neuron simply use the member variable node or use the method getFinalActivations(Document doc) to ge the final activationsBySlotAndPosition of this neuron.

Author:

Lukas Molzberger

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class INeuron.ActKey

static class INeuron.SynapseSummary

static class INeuron.Type

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`ALLOW_WEAK_NEGATIVE_WEIGHTS`
`static INeuron`	`MAX_NEURON`
`static INeuron`	`MIN_NEURON`
`Set<Integer>`	`slotHasInputs`
`Set<Integer>`	`slotRequired`
`static double`	`WEIGHT_TOLERANCE`

Fields inherited from class network.aika.AbstractNode
lastUsedDocumentId, modified, provider

Constructor Summary

Constructors
Constructor Description

INeuron(Model m, String label, String outputText, INeuron.Type type, ActivationFunction actF)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Activation`	`addInput(Document doc, Activation.Builder input)`	Propagate an input activation into the network.
`void`	`addRequiredSlot(int slot)`
`boolean`	`checkRequiredSlots(Document doc, SortedMap<Integer,Position> slots)`
`void`	`clearActivations()`
`void`	`clearActivations(int threadId)`
`void`	`clearActivations(Document doc)`
`void`	`commit(Collection<Synapse> modifiedSynapses)`
`int`	`compareTo(INeuron n)`
`ActivationFunction`	`getActivationFunction()`
`Stream<Activation>`	`getActivations(Document doc)`
`Stream<Activation>`	`getActivations(Document doc, boolean onlyFinal)`
`Stream<Activation>`	`getActivations(Document doc, int slot, Position pos, boolean onlyFinal)`
`Stream<Activation>`	`getActivations(Document doc, int fromSlot, Position fromPos, boolean fromInclusive, int toSlot, Position toPos, boolean toInclusive)`
`Collection<Activation>`	`getActivations(Document doc, SortedMap<Integer,Position> slots)`
`double`	`getBias()`
`<T extends Writable> T`	`getExtension()`
`Provider<OrNode>`	`getInputNode()`
`Collection<Synapse>`	`getInputSynapses()`
`String`	`getLabel()`
`double`	`getNewBias()`
`int`	`getNewSynapseId()`
`Provider<InputNode>`	`getOutputNode()`
`Map<Integer,Relation>`	`getOutputRelations()`
`String`	`getOutputText()`
`Collection<Synapse>`	`getPassiveInputSynapses()`
`INeuron.SynapseSummary`	`getSynapseSummary()`
`INeuron.Type`	`getType()`
`boolean`	`isEmpty(Document doc)`
`boolean`	`isPassiveInputNeuron()`
`Activation`	`lookupActivation(Document doc, SortedMap<Integer,Position> slots, Predicate<Activation.Link> filter)`
`void`	`propagate(Activation act)`
`void`	`reactivate()`
`void`	`readFields(DataInput in, Model m)`	Deserialize the fields of this object from `in`.
`static INeuron`	`readNeuron(DataInput in, Neuron p)`
`void`	`register(Activation act)`
`void`	`registerPassiveInputSynapse(Synapse s)`
`void`	`registerSynapseId(Integer synId)`
`void`	`remove()`
`void`	`setBias(double b)`
`void`	`setOutputNode(Provider<InputNode> node)`
`void`	`setOutputText(String outputText)`
`int`	`size(Document doc)`
`void`	`suspend()`
`String`	`toString()`
`String`	`toStringWithSynapses()`
`void`	`updateBiasDelta(double biasDelta)`
`void`	`write(DataOutput out)`	Serialize the fields of this object to `out`.

Methods inherited from class network.aika.AbstractNode
getProvider, read, setModified

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALLOW_WEAK_NEGATIVE_WEIGHTS

public static boolean ALLOW_WEAK_NEGATIVE_WEIGHTS

WEIGHT_TOLERANCE
```
public static double WEIGHT_TOLERANCE
```

MIN_NEURON
```
public static final INeuron MIN_NEURON
```

MAX_NEURON
```
public static final INeuron MAX_NEURON
```

slotHasInputs
```
public Set<Integer> slotHasInputs
```

slotRequired
```
public Set<Integer> slotRequired
```

Constructor Detail

INeuron

public INeuron(Model m,
               String label,
               String outputText,
               INeuron.Type type,
               ActivationFunction actF)

Method Detail

setOutputNode

public void setOutputNode(Provider<InputNode> node)

getLabel
```
public String getLabel()
```

getType
```
public INeuron.Type getType()
```

getOutputNode

public Provider<InputNode> getOutputNode()

getInputNode

public Provider<OrNode> getInputNode()

getSynapseSummary

public INeuron.SynapseSummary getSynapseSummary()

getOutputRelations

public Map<Integer,Relation> getOutputRelations()

getInputSynapses

public Collection<Synapse> getInputSynapses()

getPassiveInputSynapses

public Collection<Synapse> getPassiveInputSynapses()

addRequiredSlot

public void addRequiredSlot(int slot)

getActivationFunction

public ActivationFunction getActivationFunction()

getExtension

public <T extends Writable> T getExtension()

getActivations

public Stream<Activation> getActivations(Document doc)

isEmpty

public boolean isEmpty(Document doc)

size
```
public int size(Document doc)
```

clearActivations

public void clearActivations(Document doc)

getActivations

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

clearActivations
```
public void clearActivations()
```

clearActivations

public void clearActivations(int threadId)

getActivations

public Stream<Activation> getActivations(Document doc,
                                         int fromSlot,
                                         Position fromPos,
                                         boolean fromInclusive,
                                         int toSlot,
                                         Position toPos,
                                         boolean toInclusive)

getActivations

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

getActivations

public Collection<Activation> getActivations(Document doc,
                                             SortedMap<Integer,Position> slots)

setOutputText

public void setOutputText(String outputText)

getOutputText
```
public String getOutputText()
```

addInput

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

Propagate an input activation into the network.

Parameters:: doc - The current document; input -

commit

public void commit(Collection<Synapse> modifiedSynapses)

checkRequiredSlots

public boolean checkRequiredSlots(Document doc,
                                  SortedMap<Integer,Position> slots)

lookupActivation

public Activation lookupActivation(Document doc,
                                   SortedMap<Integer,Position> slots,
                                   Predicate<Activation.Link> filter)

remove
```
public void remove()
```

getNewSynapseId
```
public int getNewSynapseId()
```

registerSynapseId

public void registerSynapseId(Integer synId)

propagate

public void propagate(Activation act)

compareTo
```
public int compareTo(INeuron n)
```
Specified by:

compareTo in interface Comparable<INeuron>

write
```
public void write(DataOutput out)
           throws IOException
```
Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

IOException

readFields
```
public void readFields(DataInput in,
                       Model m)
                throws IOException
```
Description copied from interface: Writable

Deserialize the fields of this object from in.
For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

IOException

suspend
```
public void suspend()
```
Overrides:

suspend in class AbstractNode<Neuron>

reactivate
```
public void reactivate()
```
Overrides:

reactivate in class AbstractNode<Neuron>

setBias
```
public void setBias(double b)
```

updateBiasDelta

public void updateBiasDelta(double biasDelta)

getBias
```
public double getBias()
```

getNewBias
```
public double getNewBias()
```

register

public void register(Activation act)

readNeuron

public static INeuron readNeuron(DataInput in,
                                 Neuron p)
                          throws IOException

Throws:: IOException

isPassiveInputNeuron
```
public boolean isPassiveInputNeuron()
```

registerPassiveInputSynapse

public void registerPassiveInputSynapse(Synapse s)

toString
```
public String toString()
```
Overrides:

toString in class Object

toStringWithSynapses
```
public String toStringWithSynapses()
```

Modifier and Type	Class	Description
`static class`	`INeuron.ActKey`
`static class`	`INeuron.SynapseSummary`
`static class`	`INeuron.Type`

Class INeuron

Nested Class Summary

Field Summary

Fields inherited from class network.aika.AbstractNode

Constructor Summary

Method Summary

Methods inherited from class network.aika.AbstractNode

Methods inherited from class java.lang.Object

Field Detail

ALLOW_WEAK_NEGATIVE_WEIGHTS

WEIGHT_TOLERANCE

MIN_NEURON

MAX_NEURON

slotHasInputs

slotRequired

Constructor Detail

INeuron

Method Detail

setOutputNode

getLabel

getType

getOutputNode

getInputNode

getSynapseSummary

getOutputRelations

getInputSynapses

getPassiveInputSynapses

addRequiredSlot

getActivationFunction

getExtension

getActivations

isEmpty

size

clearActivations

getActivations

clearActivations

clearActivations

getActivations

getActivations

getActivations

setOutputText

getOutputText

addInput

commit

checkRequiredSlots

lookupActivation

remove

getNewSynapseId

registerSynapseId

propagate

compareTo

write

readFields

suspend

reactivate

setBias

updateBiasDelta

getBias

getNewBias

register

readNeuron

isPassiveInputNeuron

registerPassiveInputSynapse

toString

toStringWithSynapses