Files
mlpack/doc/html/softsign__function_8hpp_source.html
T

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/softsign_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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;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">softsign_function.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="softsign__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>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_ANN_ACTIVATION_FUNCTIONS_SOFTSIGN_FUNCTION_HPP</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_ANN_ACTIVATION_FUNCTIONS_SOFTSIGN_FUNCTION_HPP</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html"> 47</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html">SoftsignFunction</a></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a81f0bb62d6a0444d560381a08b040be1"> 56</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a81f0bb62d6a0444d560381a08b040be1">Fn</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> x)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">if</span> (x &lt; DBL_MAX)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> x &gt; -DBL_MAX ? x / (1.0 + std::abs(x)) : -1.0;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> 1.0;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> InputVecType, <span class="keyword">typename</span> OutputVecType&gt;</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a221ebebb848999a72fcf145761b15543"> 70</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a221ebebb848999a72fcf145761b15543">Fn</a>(<span class="keyword">const</span> InputVecType&amp; x, OutputVecType&amp; y)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; y = x;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; x.n_elem; i++)</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; y(i) = <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a81f0bb62d6a0444d560381a08b040be1">Fn</a>(x(i));</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html#aea0f1eb069eda7f64b9e749da5aa23b5"> 84</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#aea0f1eb069eda7f64b9e749da5aa23b5">Deriv</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> y)</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> std::pow(1.0 - std::abs(y), 2);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> InputVecType, <span class="keyword">typename</span> OutputVecType&gt;</div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3b045cbc3b85f85208cdffcb1879d0e9"> 96</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3b045cbc3b85f85208cdffcb1879d0e9">Deriv</a>(<span class="keyword">const</span> InputVecType&amp; y, OutputVecType&amp; x)</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; x = arma::pow(1.0 - arma::abs(y), 2);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3a49259480827ac7de3ab69eb10591d2"> 107</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3a49259480827ac7de3ab69eb10591d2">Inv</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> y)</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">if</span> (y &gt; 0)</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">return</span> y &lt; 1 ? -y / (y - 1) : DBL_MAX;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">return</span> y &gt; -1 ? y / (1 + y) : -DBL_MAX;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> InputVecType, <span class="keyword">typename</span> OutputVecType&gt;</div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1SoftsignFunction.html#ad840a1eec3cd4518e3eefc3b908efabf"> 122</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#ad840a1eec3cd4518e3eefc3b908efabf">Inv</a>(<span class="keyword">const</span> InputVecType&amp; y, OutputVecType&amp; x)</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; x = y;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; y.n_elem; i++)</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; x(i) = <a class="code" href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3a49259480827ac7de3ab69eb10591d2">Inv</a>(y(i));</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;}; <span class="comment">// class SoftsignFunction</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;} <span class="comment">// namespace ann</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<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="classmlpack_1_1ann_1_1SoftsignFunction_html_a81f0bb62d6a0444d560381a08b040be1"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html#a81f0bb62d6a0444d560381a08b040be1">mlpack::ann::SoftsignFunction::Fn</a></div><div class="ttdeci">static double Fn(const double x)</div><div class="ttdoc">Computes the softsign function. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00056">softsign_function.hpp:56</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_1SoftsignFunction_html_aea0f1eb069eda7f64b9e749da5aa23b5"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html#aea0f1eb069eda7f64b9e749da5aa23b5">mlpack::ann::SoftsignFunction::Deriv</a></div><div class="ttdeci">static double Deriv(const double y)</div><div class="ttdoc">Computes the first derivative of the softsign function. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00084">softsign_function.hpp:84</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1SoftsignFunction_html_ad840a1eec3cd4518e3eefc3b908efabf"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html#ad840a1eec3cd4518e3eefc3b908efabf">mlpack::ann::SoftsignFunction::Inv</a></div><div class="ttdeci">static void Inv(const InputVecType &amp;y, OutputVecType &amp;x)</div><div class="ttdoc">Computes the inverse of the softsign function. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00122">softsign_function.hpp:122</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1SoftsignFunction_html_a3b045cbc3b85f85208cdffcb1879d0e9"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3b045cbc3b85f85208cdffcb1879d0e9">mlpack::ann::SoftsignFunction::Deriv</a></div><div class="ttdeci">static void Deriv(const InputVecType &amp;y, OutputVecType &amp;x)</div><div class="ttdoc">Computes the first derivatives of the softsign function. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00096">softsign_function.hpp:96</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1SoftsignFunction_html_a3a49259480827ac7de3ab69eb10591d2"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html#a3a49259480827ac7de3ab69eb10591d2">mlpack::ann::SoftsignFunction::Inv</a></div><div class="ttdeci">static double Inv(const double y)</div><div class="ttdoc">Computes the inverse of the softsign function. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00107">softsign_function.hpp:107</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1SoftsignFunction_html_a221ebebb848999a72fcf145761b15543"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html#a221ebebb848999a72fcf145761b15543">mlpack::ann::SoftsignFunction::Fn</a></div><div class="ttdeci">static void Fn(const InputVecType &amp;x, OutputVecType &amp;y)</div><div class="ttdoc">Computes the softsign function. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00070">softsign_function.hpp:70</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1SoftsignFunction_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1SoftsignFunction.html">mlpack::ann::SoftsignFunction</a></div><div class="ttdoc">The softsign function, defined by. </div><div class="ttdef"><b>Definition:</b> <a href="softsign__function_8hpp_source.html#l00047">softsign_function.hpp:47</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>