Files
mlpack/doc/html/gradient__zero__visitor_8hpp_source.html
T

119 lines
13 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/visitor/gradient_zero_visitor.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_b555923761b25372c22bbdf14676b4b4.html">visitor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">gradient_zero_visitor.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="gradient__zero__visitor_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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_ANN_VISITOR_GRADIENT_ZERO_VISITOR_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_ANN_VISITOR_GRADIENT_ZERO_VISITOR_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="layer__traits_8hpp.html">mlpack/methods/ann/layer/layer_traits.hpp</a>&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="layer__types_8hpp.html">mlpack/methods/ann/layer/layer_types.hpp</a>&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;boost/variant.hpp&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * GradientZeroVisitor set the gradient to zero for the given module.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1GradientZeroVisitor.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1GradientZeroVisitor.html">GradientZeroVisitor</a> : <span class="keyword">public</span> boost::static_visitor&lt;void&gt;</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">public</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a09e7548acc3857b406069cd9e33143c2">GradientZeroVisitor</a>();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> LayerType&gt;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a90cddfd68148a5fa4d2917a5726733eb">operator()</a>(LayerType* layer) <span class="keyword">const</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">typename</span> std::enable_if&lt;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; HasGradientCheck&lt;T, arma::mat&amp;(T::*)()&gt;::value, <span class="keywordtype">void</span>&gt;::type</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a073aede65616589c8b13377bd4a849c1">LayerGradients</a>(T* layer, arma::mat&amp; input) <span class="keyword">const</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> P&gt;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">typename</span> std::enable_if&lt;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; !HasGradientCheck&lt;T, P&amp;(T::*)()&gt;::value, <span class="keywordtype">void</span>&gt;::type</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a073aede65616589c8b13377bd4a849c1">LayerGradients</a>(T* layer, P&amp; input) <span class="keyword">const</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;};</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;} <span class="comment">// namespace ann</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">// Include implementation.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#include &quot;gradient_zero_visitor_impl.hpp&quot;</span></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="preprocessor">#endif</span></div><div class="ttc" id="layer__traits_8hpp_html"><div class="ttname"><a href="layer__traits_8hpp.html">layer_traits.hpp</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="classmlpack_1_1ann_1_1GradientZeroVisitor_html_a073aede65616589c8b13377bd4a849c1"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a073aede65616589c8b13377bd4a849c1">mlpack::ann::GradientZeroVisitor::LayerGradients</a></div><div class="ttdeci">std::enable_if&lt; HasGradientCheck&lt; T, arma::mat &amp;(T::*)()&gt;::value, void &gt;::type LayerGradients(T *layer, arma::mat &amp;input) const </div><div class="ttdoc">Set the gradient to zero if the module implements the Gradient() function. </div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1GradientZeroVisitor_html_a09e7548acc3857b406069cd9e33143c2"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a09e7548acc3857b406069cd9e33143c2">mlpack::ann::GradientZeroVisitor::GradientZeroVisitor</a></div><div class="ttdeci">GradientZeroVisitor()</div><div class="ttdoc">Set the gradient to zero for the given module. </div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1GradientZeroVisitor_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientZeroVisitor.html">mlpack::ann::GradientZeroVisitor</a></div><div class="ttdef"><b>Definition:</b> <a href="gradient__zero__visitor_8hpp_source.html#l00027">gradient_zero_visitor.hpp:27</a></div></div>
<div class="ttc" id="layer__types_8hpp_html"><div class="ttname"><a href="layer__types_8hpp.html">layer_types.hpp</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1GradientZeroVisitor_html_a90cddfd68148a5fa4d2917a5726733eb"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientZeroVisitor.html#a90cddfd68148a5fa4d2917a5726733eb">mlpack::ann::GradientZeroVisitor::operator()</a></div><div class="ttdeci">void operator()(LayerType *layer) const </div><div class="ttdoc">Set the gradient to zero. </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>