From 790ae87bb0c56c529af891d763432bbc286763d2 Mon Sep 17 00:00:00 2001
From: guille <guillermopolito@gmail.com>
Date: Thu, 27 Oct 2016 16:11:49 +0200
Subject: [PATCH] Added Scaladocs to InputNeuron
---
.../emeraude/n2s3/core/actors/InputNeuron.scala | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputNeuron.scala b/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputNeuron.scala
index 5ff7d440..cf99b47c 100644
--- a/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputNeuron.scala
+++ b/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputNeuron.scala
@@ -8,7 +8,8 @@ import fr.univ_lille.cristal.emeraude.n2s3.core.models.properties.SynapticWeight
import fr.univ_lille.cristal.emeraude.n2s3.support.actors.Message
/**
- * Created by guille on 10/14/16.
+ * Simple Neuron Model used inside an [[fr.univ_lille.cristal.emeraude.n2s3.core.InputLayer]]
+ * This neuron model forwards spikes to its connected neurons without any intermediate treatment.
*/
class InputNeuron extends Neuron {
@@ -19,8 +20,16 @@ class InputNeuron extends Neuron {
}
)
+ /**
+ * Cancelled method.
+ * Check the superclass [[Neuron]] and sibblings to see usages.
+ * @throws UnsupportedOperationException
+ */
def defaultConnection = throw new UnsupportedOperationException
+ /**
+ * Re-sends the received message to all output neurons.
+ */
def processSomaMessage(timestamp: Timestamp, message: Message, fromSynapse : Option[Int], ends : NeuronEnds): Unit = {
triggerEventWith(NeuronFireEvent, NeuronFireResponse(timestamp, getNetworkAddress))
ends.sendToAllOutput(timestamp, message)
--
GitLab