121 lines
18 KiB
HTML
121 lines
18 KiB
HTML
<!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.11"/>
|
|
<title>mlpack: src/mlpack/methods/ann/activation_functions/logistic_function.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="extra-stylesheet.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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">mlpack
|
|
 <span id="projectnumber">master</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44a936ef30fc126706c6284a2fc0c990.html">mlpack</a></li><li class="navelem"><a class="el" href="dir_3cfbf900288ec2fe8dd2c2c8482f216e.html">methods</a></li><li class="navelem"><a class="el" href="dir_04cdefcc9a97fb221ee3f2d7fb8aab76.html">ann</a></li><li class="navelem"><a class="el" href="dir_a05b89e13e21ccb1d653eec334a23617.html">activation_functions</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">logistic_function.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="logistic__function_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef MLPACK_METHODS_ANN_ACTIVATION_FUNCTIONS_LOGISTIC_FUNCTION_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define MLPACK_METHODS_ANN_ACTIVATION_FUNCTIONS_LOGISTIC_FUNCTION_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html">LogisticFunction</a></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>  <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">template</span><<span class="keyword">typename</span> eT></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html#af75b6672b3baf430bc58e712d0b1a82f"> 39</a></span>  <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html#af75b6672b3baf430bc58e712d0b1a82f">Fn</a>(<span class="keyword">const</span> eT x)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">if</span> (x < arma::Datum<eT>::log_max)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (x > -arma::Datum<eT>::log_max)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span> 1.0 / (1.0 + std::exp(-x));</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> 0.0;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> 1.0;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">template</span><<span class="keyword">typename</span> InputVecType, <span class="keyword">typename</span> OutputVecType></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html#a2200886c6c3e4ccf646d09654b17723c"> 59</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html#a2200886c6c3e4ccf646d09654b17723c">Fn</a>(<span class="keyword">const</span> InputVecType& x, OutputVecType& y)</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  y = (1.0 / (1 + arma::exp(-x)));</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html#a068a36a9f089525012e4d60c8ca35557"> 70</a></span>  <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html#a068a36a9f089525012e4d60c8ca35557">Deriv</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> y)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> y * (1.0 - y);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">template</span><<span class="keyword">typename</span> InputVecType, <span class="keyword">typename</span> OutputVecType></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html#a75b4c43eb03549807d17027d0d3dd7f6"> 82</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html#a75b4c43eb03549807d17027d0d3dd7f6">Deriv</a>(<span class="keyword">const</span> InputVecType& y, OutputVecType& x)</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>  x = y % (1.0 - y);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html#ac9ad2166977be46593e31bdd8aa9b5e9"> 93</a></span>  <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html#ac9ad2166977be46593e31bdd8aa9b5e9">Inv</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> y)</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> arma::trunc_log(y / (1 - y));</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">template</span><<span class="keyword">typename</span> InputVecType, <span class="keyword">typename</span> OutputVecType></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LogisticFunction.html#a90c45e5ee5838cf6b4157a6f68f30c80"> 105</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1LogisticFunction.html#a90c45e5ee5838cf6b4157a6f68f30c80">Inv</a>(<span class="keyword">const</span> InputVecType& y, OutputVecType& x)</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  {</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  x = arma::trunc_log(y / (1 - y));</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> }; <span class="comment">// class LogisticFunction</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> } <span class="comment">// namespace ann</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespacemlpack_html"><div class="ttname"><a href="namespacemlpack.html">mlpack</a></div><div class="ttdoc">Linear algebra utility functions, generally performed on matrices or vectors. </div><div class="ttdef"><b>Definition:</b> <a href="binarize_8hpp_source.html#l00018">binarize.hpp:18</a></div></div>
|
|
<div class="ttc" id="prereqs_8hpp_html"><div class="ttname"><a href="prereqs_8hpp.html">prereqs.hpp</a></div><div class="ttdoc">The core includes that mlpack expects; standard C++ includes and Armadillo. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html_a75b4c43eb03549807d17027d0d3dd7f6"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html#a75b4c43eb03549807d17027d0d3dd7f6">mlpack::ann::LogisticFunction::Deriv</a></div><div class="ttdeci">static void Deriv(const InputVecType &y, OutputVecType &x)</div><div class="ttdoc">Computes the first derivatives of the logistic function. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00082">logistic_function.hpp:82</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html_a90c45e5ee5838cf6b4157a6f68f30c80"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html#a90c45e5ee5838cf6b4157a6f68f30c80">mlpack::ann::LogisticFunction::Inv</a></div><div class="ttdeci">static void Inv(const InputVecType &y, OutputVecType &x)</div><div class="ttdoc">Computes the inverse of the logistic function. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00105">logistic_function.hpp:105</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html">mlpack::ann::LogisticFunction</a></div><div class="ttdoc">The logistic function, defined by. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00029">logistic_function.hpp:29</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html_af75b6672b3baf430bc58e712d0b1a82f"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html#af75b6672b3baf430bc58e712d0b1a82f">mlpack::ann::LogisticFunction::Fn</a></div><div class="ttdeci">static double Fn(const eT x)</div><div class="ttdoc">Computes the logistic function. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00039">logistic_function.hpp:39</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html_a2200886c6c3e4ccf646d09654b17723c"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html#a2200886c6c3e4ccf646d09654b17723c">mlpack::ann::LogisticFunction::Fn</a></div><div class="ttdeci">static void Fn(const InputVecType &x, OutputVecType &y)</div><div class="ttdoc">Computes the logistic function. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00059">logistic_function.hpp:59</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html_ac9ad2166977be46593e31bdd8aa9b5e9"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html#ac9ad2166977be46593e31bdd8aa9b5e9">mlpack::ann::LogisticFunction::Inv</a></div><div class="ttdeci">static double Inv(const double y)</div><div class="ttdoc">Computes the inverse of the logistic function. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00093">logistic_function.hpp:93</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LogisticFunction_html_a068a36a9f089525012e4d60c8ca35557"><div class="ttname"><a href="classmlpack_1_1ann_1_1LogisticFunction.html#a068a36a9f089525012e4d60c8ca35557">mlpack::ann::LogisticFunction::Deriv</a></div><div class="ttdeci">static double Deriv(const double y)</div><div class="ttdoc">Computes the first derivative of the logistic function. </div><div class="ttdef"><b>Definition:</b> <a href="logistic__function_8hpp_source.html#l00070">logistic_function.hpp:70</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
<script type="text/javascript">
|
|
var x = document.getElementsByClassName("formulaDsp");
|
|
var i;
|
|
for (i = 0; i < x.length; i++)
|
|
{
|
|
x[i].width /= 4;
|
|
}
|
|
</script>
|
|
</html>
|