Homec4science
Diffusion CS116-2017-Romain-GROS (master) Browse

NeuroProject/Doxygen/html/neurone_8hpp_source.html
63b4e1659f19master

Last Change
Raw File

neurone_8hpp_source.html
View Options

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Neuro Project: Src/neurone.hpp 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="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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<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="epfllogo.jpg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Neuro Project
</div>
<div id="projectbrief">Simulation of a 12&#39;500 neurones network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_413f4e031a85da0d68269c6fd2f76e1c.html">Src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">neurone.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;random&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;ringbuffer.hpp&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef NEURONE_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define NEURONE_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">enum</span> Status {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;Excitatory, </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;Inhibitory};</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classNeurone.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="classNeurone.html">Neurone</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; private : </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; Status status_;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">double</span> membrane_potential_;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; std::vector&lt;int&gt; spikes_times_;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">double</span> clock_rest_time_;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="classRingBuffer.html">RingBuffer</a> buffer_;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">double</span> I_ext_;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; std::vector&lt;Neurone*&gt; targets_;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> test_;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; public :</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="classNeurone.html#ac43bda9d15bbc5060e2550be6167291b">Neurone</a>(Status status);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="classNeurone.html#aeb6fa39da618a5e19cc91911630fbdc1">~Neurone</a>();</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classNeurone.html#a0d5c79a29ea017a500aceb4e2edb3fea">update</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> t);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classNeurone.html#a45c69953948f40d714f232d1d46934e1">setIext</a>(<span class="keywordtype">double</span> I);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">double</span> <a class="code" href="classNeurone.html#a87ffde06579689af191fb05b48419021">getMembranePotential</a> () <span class="keyword">const</span> ;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classNeurone.html#ad9ba0a24bef21fd9b3cb824a681c48be">Spike</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> t);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classNeurone.html#a1c029deb909e23adc7a47293cb49fa30">isInRest</a>();</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; std::vector&lt;int&gt; <a class="code" href="classNeurone.html#a7c07e491785174e6b26c25afbe121fa0">getSpikeTimes</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classNeurone.html#adef9ed5e19f5166f7339bf1a613a1aaa">receive</a>(<span class="keywordtype">int</span> D, Status status);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordtype">double</span> <a class="code" href="classNeurone.html#a0a2aa0defd3610af1df3633ac0623c8d">outsideInput</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classNeurone.html#afd54d04c7418973877460e05f7a008b7">MakeConnections</a>(std::vector&lt;Neurone*&gt;&amp; neurones, <span class="keywordtype">int</span> neuroneNumber);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordtype">double</span> <a class="code" href="classNeurone.html#ab70cb99fedbb2d8de7e4350b93211a63">BackgroundInput</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; Status <a class="code" href="classNeurone.html#aab13094b98ba14fadf90f38792a073e3">getStatus</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classNeurone.html#ad10fd01ba452b45851eef861a2ca2002">sendInformation</a> (<span class="keywordtype">int</span> t) <span class="keyword">const</span> ;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classNeurone.html#a365ad85f2065d89070eb4c0815a63864">setTestMode</a>();</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classNeurone.html#ae68369276cba4167a40da6a782bc3c72">addConnection</a>(std::vector&lt;Neurone*&gt;&amp; neurones, <span class="keywordtype">int</span> targetNumber);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classNeurone.html#a3cdf3f01fbb7ae694be31cff9c88aaa8">countConnection</a>(<span class="keywordtype">int</span> i,std::vector&lt;Neurone*&gt;&amp; neurones, <span class="keywordtype">int</span>&amp; InCounteur, <span class="keywordtype">int</span>&amp; ExCounteur);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;};</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;</div><div class="ttc" id="classNeurone_html_adef9ed5e19f5166f7339bf1a613a1aaa"><div class="ttname"><a href="classNeurone.html#adef9ed5e19f5166f7339bf1a613a1aaa">Neurone::receive</a></div><div class="ttdeci">void receive(int D, Status status)</div><div class="ttdoc">Receive a spike from another neurone. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:92</div></div>
<div class="ttc" id="classNeurone_html_a45c69953948f40d714f232d1d46934e1"><div class="ttname"><a href="classNeurone.html#a45c69953948f40d714f232d1d46934e1">Neurone::setIext</a></div><div class="ttdeci">void setIext(double I)</div><div class="ttdoc">Set the external input current. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:108</div></div>
<div class="ttc" id="classNeurone_html_a0a2aa0defd3610af1df3633ac0623c8d"><div class="ttname"><a href="classNeurone.html#a0a2aa0defd3610af1df3633ac0623c8d">Neurone::outsideInput</a></div><div class="ttdeci">double outsideInput() const</div><div class="ttdoc">Return the outside input (from other neurones) for the current time. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:102</div></div>
<div class="ttc" id="classNeurone_html_a0d5c79a29ea017a500aceb4e2edb3fea"><div class="ttname"><a href="classNeurone.html#a0d5c79a29ea017a500aceb4e2edb3fea">Neurone::update</a></div><div class="ttdeci">bool update(unsigned int t)</div><div class="ttdoc">Update the neurone (change the membrane potential, make it spike if the treshold is reached and manag...</div><div class="ttdef"><b>Definition:</b> neurone.cpp:19</div></div>
<div class="ttc" id="classNeurone_html_aeb6fa39da618a5e19cc91911630fbdc1"><div class="ttname"><a href="classNeurone.html#aeb6fa39da618a5e19cc91911630fbdc1">Neurone::~Neurone</a></div><div class="ttdeci">~Neurone()</div><div class="ttdoc">Neurone destructor. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:15</div></div>
<div class="ttc" id="classNeurone_html_ad9ba0a24bef21fd9b3cb824a681c48be"><div class="ttname"><a href="classNeurone.html#ad9ba0a24bef21fd9b3cb824a681c48be">Neurone::Spike</a></div><div class="ttdeci">bool Spike(unsigned int t)</div><div class="ttdoc">Test if the treshold is reached, if it is, make the neurone spike and reinitialize the membrane poten...</div><div class="ttdef"><b>Definition:</b> neurone.cpp:70</div></div>
<div class="ttc" id="classNeurone_html_ad10fd01ba452b45851eef861a2ca2002"><div class="ttname"><a href="classNeurone.html#ad10fd01ba452b45851eef861a2ca2002">Neurone::sendInformation</a></div><div class="ttdeci">void sendInformation(int t) const</div><div class="ttdoc">Send to every targetted neurone the spike information (used only if it spikes). </div><div class="ttdef"><b>Definition:</b> neurone.cpp:149</div></div>
<div class="ttc" id="classNeurone_html_ac43bda9d15bbc5060e2550be6167291b"><div class="ttname"><a href="classNeurone.html#ac43bda9d15bbc5060e2550be6167291b">Neurone::Neurone</a></div><div class="ttdeci">Neurone(Status status)</div><div class="ttdoc">Neurone constructor (the initiation constants are in constant.h). </div><div class="ttdef"><b>Definition:</b> neurone.cpp:7</div></div>
<div class="ttc" id="classNeurone_html_ae68369276cba4167a40da6a782bc3c72"><div class="ttname"><a href="classNeurone.html#ae68369276cba4167a40da6a782bc3c72">Neurone::addConnection</a></div><div class="ttdeci">void addConnection(std::vector&lt; Neurone *&gt; &amp;neurones, int targetNumber)</div><div class="ttdoc">Add one connection (one new targetted neurone) </div><div class="ttdef"><b>Definition:</b> neurone.cpp:161</div></div>
<div class="ttc" id="classNeurone_html_ab70cb99fedbb2d8de7e4350b93211a63"><div class="ttname"><a href="classNeurone.html#ab70cb99fedbb2d8de7e4350b93211a63">Neurone::BackgroundInput</a></div><div class="ttdeci">double BackgroundInput() const</div><div class="ttdoc">Returns the current induced by the background. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:135</div></div>
<div class="ttc" id="classNeurone_html_a3cdf3f01fbb7ae694be31cff9c88aaa8"><div class="ttname"><a href="classNeurone.html#a3cdf3f01fbb7ae694be31cff9c88aaa8">Neurone::countConnection</a></div><div class="ttdeci">int countConnection(int i, std::vector&lt; Neurone *&gt; &amp;neurones, int &amp;InCounteur, int &amp;ExCounteur)</div><div class="ttdoc">TestMode. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:166</div></div>
<div class="ttc" id="classNeurone_html_a365ad85f2065d89070eb4c0815a63864"><div class="ttname"><a href="classNeurone.html#a365ad85f2065d89070eb4c0815a63864">Neurone::setTestMode</a></div><div class="ttdeci">void setTestMode()</div><div class="ttdoc">Set test mode to true. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:156</div></div>
<div class="ttc" id="classNeurone_html_a7c07e491785174e6b26c25afbe121fa0"><div class="ttname"><a href="classNeurone.html#a7c07e491785174e6b26c25afbe121fa0">Neurone::getSpikeTimes</a></div><div class="ttdeci">std::vector&lt; int &gt; getSpikeTimes() const</div><div class="ttdoc">Getter for the spike times. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:87</div></div>
<div class="ttc" id="classNeurone_html_aab13094b98ba14fadf90f38792a073e3"><div class="ttname"><a href="classNeurone.html#aab13094b98ba14fadf90f38792a073e3">Neurone::getStatus</a></div><div class="ttdeci">Status getStatus() const</div><div class="ttdoc">Getter for the status of the neurone. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:144</div></div>
<div class="ttc" id="classNeurone_html_afd54d04c7418973877460e05f7a008b7"><div class="ttname"><a href="classNeurone.html#afd54d04c7418973877460e05f7a008b7">Neurone::MakeConnections</a></div><div class="ttdeci">void MakeConnections(std::vector&lt; Neurone *&gt; &amp;neurones, int neuroneNumber)</div><div class="ttdoc">Make connections with others neurones. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:113</div></div>
<div class="ttc" id="classRingBuffer_html"><div class="ttname"><a href="classRingBuffer.html">RingBuffer</a></div><div class="ttdoc">Contains every informations of potential variation due to other neurones. One vector&amp;#39;s case represent...</div><div class="ttdef"><b>Definition:</b> ringbuffer.hpp:14</div></div>
<div class="ttc" id="classNeurone_html"><div class="ttname"><a href="classNeurone.html">Neurone</a></div><div class="ttdoc">Represents a neurone. It can spike, interact with other neurones... </div><div class="ttdef"><b>Definition:</b> neurone.hpp:24</div></div>
<div class="ttc" id="classNeurone_html_a1c029deb909e23adc7a47293cb49fa30"><div class="ttname"><a href="classNeurone.html#a1c029deb909e23adc7a47293cb49fa30">Neurone::isInRest</a></div><div class="ttdeci">bool isInRest()</div><div class="ttdoc">Test if the neuron is in rest. If it is, subtract an unit of time to the rest time. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:58</div></div>
<div class="ttc" id="classNeurone_html_a87ffde06579689af191fb05b48419021"><div class="ttname"><a href="classNeurone.html#a87ffde06579689af191fb05b48419021">Neurone::getMembranePotential</a></div><div class="ttdeci">double getMembranePotential() const</div><div class="ttdoc">Getter for the membrane potential. </div><div class="ttdef"><b>Definition:</b> neurone.cpp:51</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 5 2017 22:38:41 for Neuro Project by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
c4science · Help