-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSpike_8h_source.html
More file actions
193 lines (191 loc) · 17.3 KB
/
Copy pathSpike_8h_source.html
File metadata and controls
193 lines (191 loc) · 17.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TAC V0.0.4 @ 2021.04.07: Spike.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="TACdoxy.css" rel="stylesheet" type="text/css">
<!-- -->
<script type="text/javascript" src="TAC_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better know about our user community by answering the following short survey: <a href="https://forms.gle/wpyrxWi18ox9Z5ae9">https://forms.gle/wpyrxWi18ox9Z5ae9</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="TAC_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://jvegh@bitbucket.org/jvegh/timeawarecomputingsimulator">TAC V0.0.4 @ 2021.04.07</a>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Spike_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Spike.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Spike_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* @author János Végh (jvegh)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* @bug No known bugs.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef SPIKE_H</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define SPIKE_H</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//#include <iostream> // for bit fields</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//#include <sstream></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//#include <bitset> // std::bitset</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="NeurerConfig_8h.html">NeurerConfig.h</a>"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "Utils.h"</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">using namespace </span>std;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structSpikePoint.html"> 28</a></span> <span class="keyword">struct </span><a class="code" href="structSpikePoint.html">SpikePoint</a>{<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Time; <span class="keywordtype">signed</span> <span class="keywordtype">int</span> Amplitude;};</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">typedef</span> vector<SpikePoint> SpikeVector;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * Performing floating calculations is a serious limiting factor of computing simulation.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * This class uses a special method that the factors are in units of THOUSAND</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * The integer values to be scaled are multiplied by that factor, then divided by THOUSAND</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * If THOUSAND=1024 was selected in the config file, the division is replaced by shifting</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * This leads to 2.4% deviation from the 'true' value, and much quicker operation.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * Spikes may have two forms, depending on a configurable variable.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * If SPIKE_DETAILED is true:</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * a real current pulse is delivered, which is integrated in the synapses,</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * (a broken line, with adjustable time and aplitude factors)</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * otherwise only the major information is delived</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * In both cases the arrival time is delivered, per synapses to the spikes</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * (this is the logical time: the message</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * A spike is sent by AbstractNeurer#Fire to all (postsynaptic) neurons, the synapses of which are listed</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * in AbstractNeurer#m_Axons. The spike message is delivered immediately, but it is put</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * by the destination neuron in a time-ordered queue, where it will seemingly arrive</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * exactly at the wanted time, and will be delivered to the correct synapsys, where</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * it will be processed as described at scSynapticConnect.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classSpike.html"> 66</a></span> <span class="keyword">class </span><a class="code" href="classSpike.html">Spike</a></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classSpike.html">Spike</a>(<span class="keyword">const</span> SpikeVector& SpikeForm, uint16_t AmplitudeFactor=THOUSAND, uint16_t TimeFactor=THOUSAND ):</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  mSpikeTable(SpikeForm)</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ,mAmplitudeFactor(AmplitudeFactor)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  ,mTimeFactor(TimeFactor)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  ,mSpikeLength(SpikeForm.size())</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  uint16_t AmplitudeFactor_Get(<span class="keywordtype">void</span>) {<span class="keywordflow">return</span> mAmplitudeFactor;}</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  uint16_t TimeFactor_Get(<span class="keywordtype">void</span>) {<span class="keywordflow">return</span> mTimeFactor;}</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  uint16_t Time_Get(<span class="keywordtype">int</span> n){assert(n<mSpikeLength); <span class="keywordflow">return</span> (mSpikeTable[n].Time * mTimeFactor)/THOUSAND;}</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint16_t Amplitude_Get(<span class="keywordtype">int</span> n){assert(n<mSpikeLength); <span class="keywordflow">return</span> (mSpikeTable[n].Amplitude * mAmplitudeFactor)/THOUSAND;}</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// void NextSpikePoint_Get(SpikePoint& P);</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  ~<a class="code" href="classSpike.html">Spike</a>(){}</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">const</span> SpikeVector& mSpikeTable; <span class="comment">// Points to a spike table</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classSpike.html#a05a289a53a1e0b3db7bf1a6eed2b8898"> 86</a></span>  uint16_t <a class="code" href="classSpike.html#a05a289a53a1e0b3db7bf1a6eed2b8898">mAmplitudeFactor</a>; </div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classSpike.html#a1cb11b45898dcf4f0b1108b67580eb81"> 87</a></span>  uint16_t <a class="code" href="classSpike.html#a1cb11b45898dcf4f0b1108b67580eb81">mTimeFactor</a>; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">int</span> mSpikeIndex;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">int</span> mSpikeLength; <span class="comment">// Just to know size</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  };</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif // SPIKE_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassSpike_html_a05a289a53a1e0b3db7bf1a6eed2b8898"><div class="ttname"><a href="classSpike.html#a05a289a53a1e0b3db7bf1a6eed2b8898">Spike::mAmplitudeFactor</a></div><div class="ttdeci">uint16_t mAmplitudeFactor</div><div class="ttdoc">Amplitude multiplier of the current spike.</div><div class="ttdef"><b>Definition:</b> Spike.h:86</div></div>
<div class="ttc" id="astructSpikePoint_html"><div class="ttname"><a href="structSpikePoint.html">SpikePoint</a></div><div class="ttdoc">The form of an action potential is stored in 2-item vectors, a simple X-Y value pair The time is give...</div><div class="ttdef"><b>Definition:</b> Spike.h:28</div></div>
<div class="ttc" id="aclassSpike_html_a1cb11b45898dcf4f0b1108b67580eb81"><div class="ttname"><a href="classSpike.html#a1cb11b45898dcf4f0b1108b67580eb81">Spike::mTimeFactor</a></div><div class="ttdeci">uint16_t mTimeFactor</div><div class="ttdoc">Time multiplier of the current spike.</div><div class="ttdef"><b>Definition:</b> Spike.h:87</div></div>
<div class="ttc" id="aNeurerConfig_8h_html"><div class="ttname"><a href="NeurerConfig_8h.html">NeurerConfig.h</a></div><div class="ttdoc">Topology information for the Neurer simulator.</div></div>
<div class="ttc" id="aclassSpike_html"><div class="ttname"><a href="classSpike.html">Spike</a></div><div class="ttdoc">Handles spike tables for the neurons.</div><div class="ttdef"><b>Definition:</b> Spike.h:66</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e05d7e2b1ecd646af5bb94391405f3b5.html">modules</a></li><li class="navelem"><a class="el" href="dir_7be0a3fe48fd35cfcc1704e6e19161b4.html">NEURER</a></li><li class="navelem"><a class="el" href="dir_1f1f812f35fcbc75a32af3eac0b92e65.html">include</a></li><li class="navelem"><a class="el" href="Spike_8h.html">Spike.h</a></li>
<li class="footer">Generated on Wed Apr 7 2021 15:24:23 for TAC V0.0.4 @ 2021.04.07 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>