blacklight/neuralpp
1
0
Fork 0
mirror of https://github.com/BlackLight/neuralpp.git synced 2024-11-16 06:47:16 +01:00
Code Issues Projects Releases Packages Wiki Activity
neuralpp/doc/html/classneuralpp_1_1Neuron.html
blacklight a7fa05ba40 Is it time to release 1.0 version?
2009-09-04 11:27:14 +02:00

623 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Neural++: neuralpp::Neuron Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceneuralpp.html">neuralpp</a>::<a class="el" href="classneuralpp_1_1Neuron.html">Neuron</a>
</div>
</div>
<div class="contents">
<h1>neuralpp::Neuron Class Reference</h1><!-- doxytag: class="neuralpp::Neuron" -->Class for managing neurons.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="neural_09_09_8hpp-source.html">neural++.hpp</a>&gt;</code>
<p>
<p>
<a href="classneuralpp_1_1Neuron-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#c9bd4f5f618fcf1adcebf1ab63ee0960">Neuron</a> (double(*a)(double), double th=0.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#c9bd4f5f618fcf1adcebf1ab63ee0960"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#d15e96b0316d880953288cc6e2550bec">Neuron</a> (std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt; <a class="el" href="classneuralpp_1_1Neuron.html#bd07357465bb7b29bb344400e9e08710">in</a>, std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt; <a class="el" href="classneuralpp_1_1Neuron.html#982aceef324b7764e778d5949720bc55">out</a>, double(*a)(double), double th=0.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor, that gets also the synapsis linked to the neuron. <a href="#d15e96b0316d880953288cc6e2550bec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#29f2d9dcc4ca34f224d4dc39bb2f180a">synIn</a> (size_t i)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the i-th synapsis connected on the input of the neuron. <a href="#29f2d9dcc4ca34f224d4dc39bb2f180a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#655f1637e1b754461413ac7fc2ffeebe">synOut</a> (size_t i)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the i-th synapsis connected on the output of the neuron. <a href="#655f1637e1b754461413ac7fc2ffeebe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#4d252151c35839975838539d846d70be">push_in</a> (<a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> s)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">It pushes a new input synapsis. <a href="#4d252151c35839975838539d846d70be"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#2c0acb0e6d413c4e0fc9e7939da1a684">push_out</a> (<a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> s)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">It pushes a new output synapsis. <a href="#2c0acb0e6d413c4e0fc9e7939da1a684"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#ddf00ffef030b27ed11901aad08822bd">setActv</a> (double a)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the activation value of the neuron. <a href="#ddf00ffef030b27ed11901aad08822bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#aa6e58f073a76b3481fea9115a4e6ea6">setProp</a> (double p)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the propagation value of the neuron. <a href="#aa6e58f073a76b3481fea9115a4e6ea6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#6fa3e8afc1c6e6e427773ba89a6fcb68">setSynIn</a> (size_t n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#d6ae3a93ecd11c345d931aee4ca248c1">setSynOut</a> (size_t n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#55993867179f0ac7d1e0e2c460ceb611">getActv</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the activation value of the neuron. <a href="#55993867179f0ac7d1e0e2c460ceb611"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#57c022f82213f662e2a263fc134a3fc9">getProp</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the propagation value of the neuron. <a href="#57c022f82213f662e2a263fc134a3fc9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#928d9bf5aed600119c640779e4034f30">propagate</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute the propagation value of the neuron and set it. <a href="#928d9bf5aed600119c640779e4034f30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#ad97f1a082d5f969eb4c69ab454ecfbb">nIn</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of input synapsis for the neuron. <a href="#ad97f1a082d5f969eb4c69ab454ecfbb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#fe458021e3b20d58dc608fb94ae2135b">nOut</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of output synapsis for the neuron. <a href="#fe458021e3b20d58dc608fb94ae2135b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#2e2ccb69277fc3d992a3a3f2360ed154">synClear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove input and output synapsis from a neuron. <a href="#2e2ccb69277fc3d992a3a3f2360ed154"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#eec680c47272b2465e8d8a998c359853">actv_val</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#da75259de98b1a893c736666af6bfdc3">prop_val</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#7b16632868821d73dedcb8edaf6dbbef">threshold</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#bd07357465bb7b29bb344400e9e08710">in</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#982aceef324b7764e778d5949720bc55">out</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classneuralpp_1_1Neuron.html#198ddd0d11a26d0052d52b787d6a0df0">actv_f</a> )(double)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class for managing neurons.
<p>
Don't use this class directly unless you know what you're doing, use <a class="el" href="classneuralpp_1_1NeuralNet.html" title="Main project&#39;s class.">NeuralNet</a> instead <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c9bd4f5f618fcf1adcebf1ab63ee0960"></a><!-- doxytag: member="neuralpp::Neuron::Neuron" ref="c9bd4f5f618fcf1adcebf1ab63ee0960" args="(double(*a)(double), double th=0.0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">neuralpp::Neuron::Neuron </td>
<td>(</td>
<td class="paramtype">double(*)(double)&nbsp;</td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>th</em> = <code>0.0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>Activation function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>th</em>&nbsp;</td><td>Threshold, value in [0,1] that establishes how much a neuron must be 'sensitive' on variations of the input values </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d15e96b0316d880953288cc6e2550bec"></a><!-- doxytag: member="neuralpp::Neuron::Neuron" ref="d15e96b0316d880953288cc6e2550bec" args="(std::vector&lt; Synapsis &gt; in, std::vector&lt; Synapsis &gt; out, double(*a)(double), double th=0.0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">neuralpp::Neuron::Neuron </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt;&nbsp;</td>
<td class="paramname"> <em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt;&nbsp;</td>
<td class="paramname"> <em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double(*)(double)&nbsp;</td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>th</em> = <code>0.0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Alternative constructor, that gets also the synapsis linked to the neuron.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>Input synapses </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>Output synapses </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>Activation function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>th</em>&nbsp;</td><td>Threshold, value in [0,1] that establishes how much a neuron must be 'sensitive' on variations of the input values </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="29f2d9dcc4ca34f224d4dc39bb2f180a"></a><!-- doxytag: member="neuralpp::Neuron::synIn" ref="29f2d9dcc4ca34f224d4dc39bb2f180a" args="(size_t i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a>&amp; neuralpp::Neuron::synIn </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>i</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the i-th synapsis connected on the input of the neuron.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em>&nbsp;</td><td>Index of the input synapsis to get </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the i-th synapsis </dd></dl>
</div>
</div><p>
<a class="anchor" name="655f1637e1b754461413ac7fc2ffeebe"></a><!-- doxytag: member="neuralpp::Neuron::synOut" ref="655f1637e1b754461413ac7fc2ffeebe" args="(size_t i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a>&amp; neuralpp::Neuron::synOut </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>i</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the i-th synapsis connected on the output of the neuron.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em>&nbsp;</td><td>Index of the output synapsis to get </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the i-th synapsis </dd></dl>
</div>
</div><p>
<a class="anchor" name="4d252151c35839975838539d846d70be"></a><!-- doxytag: member="neuralpp::Neuron::push_in" ref="4d252151c35839975838539d846d70be" args="(Synapsis s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::push_in </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a>&nbsp;</td>
<td class="paramname"> <em>s</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
It pushes a new input synapsis.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td><a class="el" href="classneuralpp_1_1Synapsis.html" title="Class for managing synapsis.">Synapsis</a> to be pushed </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2c0acb0e6d413c4e0fc9e7939da1a684"></a><!-- doxytag: member="neuralpp::Neuron::push_out" ref="2c0acb0e6d413c4e0fc9e7939da1a684" args="(Synapsis s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::push_out </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a>&nbsp;</td>
<td class="paramname"> <em>s</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
It pushes a new output synapsis.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td><a class="el" href="classneuralpp_1_1Synapsis.html" title="Class for managing synapsis.">Synapsis</a> to be pushed </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ddf00ffef030b27ed11901aad08822bd"></a><!-- doxytag: member="neuralpp::Neuron::setActv" ref="ddf00ffef030b27ed11901aad08822bd" args="(double a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::setActv </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>a</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the activation value of the neuron.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>Activation value </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="aa6e58f073a76b3481fea9115a4e6ea6"></a><!-- doxytag: member="neuralpp::Neuron::setProp" ref="aa6e58f073a76b3481fea9115a4e6ea6" args="(double p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::setProp </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>p</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the propagation value of the neuron.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>Propagation value </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6fa3e8afc1c6e6e427773ba89a6fcb68"></a><!-- doxytag: member="neuralpp::Neuron::setSynIn" ref="6fa3e8afc1c6e6e427773ba89a6fcb68" args="(size_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::setSynIn </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>n</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="d6ae3a93ecd11c345d931aee4ca248c1"></a><!-- doxytag: member="neuralpp::Neuron::setSynOut" ref="d6ae3a93ecd11c345d931aee4ca248c1" args="(size_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::setSynOut </td>
<td>(</td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>n</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="55993867179f0ac7d1e0e2c460ceb611"></a><!-- doxytag: member="neuralpp::Neuron::getActv" ref="55993867179f0ac7d1e0e2c460ceb611" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double neuralpp::Neuron::getActv </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the activation value of the neuron.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Activation value for the neuron </dd></dl>
</div>
</div><p>
<a class="anchor" name="57c022f82213f662e2a263fc134a3fc9"></a><!-- doxytag: member="neuralpp::Neuron::getProp" ref="57c022f82213f662e2a263fc134a3fc9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double neuralpp::Neuron::getProp </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the propagation value of the neuron.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Propagation value for the neuron </dd></dl>
</div>
</div><p>
<a class="anchor" name="928d9bf5aed600119c640779e4034f30"></a><!-- doxytag: member="neuralpp::Neuron::propagate" ref="928d9bf5aed600119c640779e4034f30" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::propagate </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compute the propagation value of the neuron and set it.
<p>
</div>
</div><p>
<a class="anchor" name="ad97f1a082d5f969eb4c69ab454ecfbb"></a><!-- doxytag: member="neuralpp::Neuron::nIn" ref="ad97f1a082d5f969eb4c69ab454ecfbb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t neuralpp::Neuron::nIn </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of input synapsis for the neuron.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of input synapsis </dd></dl>
</div>
</div><p>
<a class="anchor" name="fe458021e3b20d58dc608fb94ae2135b"></a><!-- doxytag: member="neuralpp::Neuron::nOut" ref="fe458021e3b20d58dc608fb94ae2135b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t neuralpp::Neuron::nOut </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of output synapsis for the neuron.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of output synapsis </dd></dl>
</div>
</div><p>
<a class="anchor" name="2e2ccb69277fc3d992a3a3f2360ed154"></a><!-- doxytag: member="neuralpp::Neuron::synClear" ref="2e2ccb69277fc3d992a3a3f2360ed154" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void neuralpp::Neuron::synClear </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove input and output synapsis from a neuron.
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="eec680c47272b2465e8d8a998c359853"></a><!-- doxytag: member="neuralpp::Neuron::actv_val" ref="eec680c47272b2465e8d8a998c359853" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classneuralpp_1_1Neuron.html#eec680c47272b2465e8d8a998c359853">neuralpp::Neuron::actv_val</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="da75259de98b1a893c736666af6bfdc3"></a><!-- doxytag: member="neuralpp::Neuron::prop_val" ref="da75259de98b1a893c736666af6bfdc3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classneuralpp_1_1Neuron.html#da75259de98b1a893c736666af6bfdc3">neuralpp::Neuron::prop_val</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7b16632868821d73dedcb8edaf6dbbef"></a><!-- doxytag: member="neuralpp::Neuron::threshold" ref="7b16632868821d73dedcb8edaf6dbbef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classneuralpp_1_1Neuron.html#7b16632868821d73dedcb8edaf6dbbef">neuralpp::Neuron::threshold</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="bd07357465bb7b29bb344400e9e08710"></a><!-- doxytag: member="neuralpp::Neuron::in" ref="bd07357465bb7b29bb344400e9e08710" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt; <a class="el" href="classneuralpp_1_1Neuron.html#bd07357465bb7b29bb344400e9e08710">neuralpp::Neuron::in</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="982aceef324b7764e778d5949720bc55"></a><!-- doxytag: member="neuralpp::Neuron::out" ref="982aceef324b7764e778d5949720bc55" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="classneuralpp_1_1Synapsis.html">Synapsis</a> &gt; <a class="el" href="classneuralpp_1_1Neuron.html#982aceef324b7764e778d5949720bc55">neuralpp::Neuron::out</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="198ddd0d11a26d0052d52b787d6a0df0"></a><!-- doxytag: member="neuralpp::Neuron::actv_f" ref="198ddd0d11a26d0052d52b787d6a0df0" args=")(double)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double(* <a class="el" href="classneuralpp_1_1Neuron.html#198ddd0d11a26d0052d52b787d6a0df0">neuralpp::Neuron::actv_f</a>)(double)<code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="neural_09_09_8hpp-source.html">neural++.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 11:25:49 2009 for Neural++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink