Files
mlpack/doc/html/rectifier__function_8hpp_source.html
T

120 lines
16 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/rectifier_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">rectifier_function.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="rectifier__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="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_ANN_ACTIVATION_FUNCTIONS_RECTIFIER_FUNCTION_HPP</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_ANN_ACTIVATION_FUNCTIONS_RECTIFIER_FUNCTION_HPP</span></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;<span class="preprocessor">#include &lt;<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RectifierFunction.html"> 45</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html">RectifierFunction</a></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RectifierFunction.html#a655a369c005a8eebc415b960423e04a2"> 54</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#a655a369c005a8eebc415b960423e04a2">Fn</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> x)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> std::max(0.0, 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;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RectifierFunction.html#a63665b9b29ec6d24a5ac251b9944e581"> 66</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#a63665b9b29ec6d24a5ac251b9944e581">Fn</a>(<span class="keyword">const</span> arma::Mat&lt;eT&gt;&amp; x, arma::Mat&lt;eT&gt;&amp; y)</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; y = arma::max(arma::zeros&lt;arma::Mat&lt;eT&gt; &gt;(x.n_rows, x.n_cols), x);</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="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RectifierFunction.html#acd2addd43cd8b4c33903f93ae67a6875"> 78</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#acd2addd43cd8b4c33903f93ae67a6875">Fn</a>(<span class="keyword">const</span> arma::Cube&lt;eT&gt;&amp; x, arma::Cube&lt;eT&gt;&amp; y)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; y = x;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> s = 0; s &lt; x.n_slices; s++)</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#a655a369c005a8eebc415b960423e04a2">Fn</a>(x.slice(s), y.slice(s));</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RectifierFunction.html#a76c46575a38ebcf05fc9272359b31da0"> 91</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#a76c46575a38ebcf05fc9272359b31da0">Deriv</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> y)</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> y &gt; 0;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> InputType, <span class="keyword">typename</span> OutputType&gt;</div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RectifierFunction.html#a60a0ea962465670e6dce16ad76c800ef"> 103</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#a60a0ea962465670e6dce16ad76c800ef">Deriv</a>(<span class="keyword">const</span> InputType&amp; y, OutputType&amp; x)</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; x = y;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</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="l00108"></a><span class="lineno"> 108</span>&#160; x(i) = <a class="code" href="classmlpack_1_1ann_1_1RectifierFunction.html#a76c46575a38ebcf05fc9272359b31da0">Deriv</a>(y(i));</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;}; <span class="comment">// class RectifierFunction</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;} <span class="comment">// namespace ann</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1ann_1_1RectifierFunction_html_a60a0ea962465670e6dce16ad76c800ef"><div class="ttname"><a href="classmlpack_1_1ann_1_1RectifierFunction.html#a60a0ea962465670e6dce16ad76c800ef">mlpack::ann::RectifierFunction::Deriv</a></div><div class="ttdeci">static void Deriv(const InputType &amp;y, OutputType &amp;x)</div><div class="ttdoc">Computes the first derivatives of the rectifier function. </div><div class="ttdef"><b>Definition:</b> <a href="rectifier__function_8hpp_source.html#l00103">rectifier_function.hpp:103</a></div></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_1RectifierFunction_html_a63665b9b29ec6d24a5ac251b9944e581"><div class="ttname"><a href="classmlpack_1_1ann_1_1RectifierFunction.html#a63665b9b29ec6d24a5ac251b9944e581">mlpack::ann::RectifierFunction::Fn</a></div><div class="ttdeci">static void Fn(const arma::Mat&lt; eT &gt; &amp;x, arma::Mat&lt; eT &gt; &amp;y)</div><div class="ttdoc">Computes the rectifier function using a dense matrix as input. </div><div class="ttdef"><b>Definition:</b> <a href="rectifier__function_8hpp_source.html#l00066">rectifier_function.hpp:66</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RectifierFunction_html_acd2addd43cd8b4c33903f93ae67a6875"><div class="ttname"><a href="classmlpack_1_1ann_1_1RectifierFunction.html#acd2addd43cd8b4c33903f93ae67a6875">mlpack::ann::RectifierFunction::Fn</a></div><div class="ttdeci">static void Fn(const arma::Cube&lt; eT &gt; &amp;x, arma::Cube&lt; eT &gt; &amp;y)</div><div class="ttdoc">Computes the rectifier function using a 3rd-order tensor as input. </div><div class="ttdef"><b>Definition:</b> <a href="rectifier__function_8hpp_source.html#l00078">rectifier_function.hpp:78</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RectifierFunction_html_a76c46575a38ebcf05fc9272359b31da0"><div class="ttname"><a href="classmlpack_1_1ann_1_1RectifierFunction.html#a76c46575a38ebcf05fc9272359b31da0">mlpack::ann::RectifierFunction::Deriv</a></div><div class="ttdeci">static double Deriv(const double y)</div><div class="ttdoc">Computes the first derivative of the rectifier function. </div><div class="ttdef"><b>Definition:</b> <a href="rectifier__function_8hpp_source.html#l00091">rectifier_function.hpp:91</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RectifierFunction_html_a655a369c005a8eebc415b960423e04a2"><div class="ttname"><a href="classmlpack_1_1ann_1_1RectifierFunction.html#a655a369c005a8eebc415b960423e04a2">mlpack::ann::RectifierFunction::Fn</a></div><div class="ttdeci">static double Fn(const double x)</div><div class="ttdoc">Computes the rectifier function. </div><div class="ttdef"><b>Definition:</b> <a href="rectifier__function_8hpp_source.html#l00054">rectifier_function.hpp:54</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RectifierFunction_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1RectifierFunction.html">mlpack::ann::RectifierFunction</a></div><div class="ttdoc">The rectifier function, defined by. </div><div class="ttdef"><b>Definition:</b> <a href="rectifier__function_8hpp_source.html#l00045">rectifier_function.hpp:45</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>