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/visitor/gradient_update_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
|
|
 <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_b555923761b25372c22bbdf14676b4b4.html">visitor</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">gradient_update_visitor.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="gradient__update__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> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef MLPACK_METHODS_ANN_VISITOR_GRADIENT_UPDATE_VISITOR_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define MLPACK_METHODS_ANN_VISITOR_GRADIENT_UPDATE_VISITOR_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="layer__traits_8hpp.html">mlpack/methods/ann/layer/layer_traits.hpp</a>></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="layer__types_8hpp.html">mlpack/methods/ann/layer/layer_types.hpp</a>></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <boost/variant.hpp></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <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> <span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html">GradientUpdateVisitor</a> : <span class="keyword">public</span> boost::static_visitor<size_t></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a6e5ce22ff04dca4d44eacc2ea63d4c96">GradientUpdateVisitor</a>(arma::mat&& <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a48397f0fb495f95cfc729169b57de47a">gradient</a>, <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a1b7fcf17f70434bab8401df7cf1bf943">offset</a> = 0);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">template</span><<span class="keyword">typename</span> LayerType></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#ad555d1208aed11f6cabd07c88deb15ae">operator()</a>(LayerType* layer) <span class="keyword">const</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a48397f0fb495f95cfc729169b57de47a"> 39</a></span>  arma::mat&& <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a48397f0fb495f95cfc729169b57de47a">gradient</a>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a1b7fcf17f70434bab8401df7cf1bf943"> 42</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a1b7fcf17f70434bab8401df7cf1bf943">offset</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">typename</span> std::enable_if<</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  HasGradientCheck<T, arma::mat&(T::*)()>::value &&</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  !HasModelCheck<T, std::vector<LayerTypes>&(T::*)()>::value, <span class="keywordtype">size_t</span>>::type</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a2cd2ca0c23f012a30c513ef7071dcb52">LayerGradients</a>(T* layer, arma::mat& input) <span class="keyword">const</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">typename</span> std::enable_if<</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  !HasGradientCheck<T, arma::mat&(T::*)()>::value &&</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  HasModelCheck<T, std::vector<LayerTypes>&(T::*)()>::value, <span class="keywordtype">size_t</span>>::type</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a2cd2ca0c23f012a30c513ef7071dcb52">LayerGradients</a>(T* layer, arma::mat& input) <span class="keyword">const</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">typename</span> std::enable_if<</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  HasGradientCheck<T, arma::mat&(T::*)()>::value &&</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  HasModelCheck<T, std::vector<LayerTypes>&(T::*)()>::value, <span class="keywordtype">size_t</span>>::type</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a2cd2ca0c23f012a30c513ef7071dcb52">LayerGradients</a>(T* layer, arma::mat& input) <span class="keyword">const</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> P></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">typename</span> std::enable_if<</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  !HasGradientCheck<T, P&(T::*)()>::value &&</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  !HasModelCheck<T, std::vector<LayerTypes>&(T::*)()>::value, <span class="keywordtype">size_t</span>>::type</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a2cd2ca0c23f012a30c513ef7071dcb52">LayerGradients</a>(T* layer, P& input) <span class="keyword">const</span>;</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="l00075"></a><span class="lineno"> 75</span> } <span class="comment">// namespace ann</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#include "gradient_update_visitor_impl.hpp"</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1ann_1_1GradientUpdateVisitor_html_a6e5ce22ff04dca4d44eacc2ea63d4c96"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a6e5ce22ff04dca4d44eacc2ea63d4c96">mlpack::ann::GradientUpdateVisitor::GradientUpdateVisitor</a></div><div class="ttdeci">GradientUpdateVisitor(arma::mat &&gradient, size_t offset=0)</div><div class="ttdoc">Update the gradient parameter given the gradient set. </div></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="classmlpack_1_1ann_1_1GradientUpdateVisitor_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html">mlpack::ann::GradientUpdateVisitor</a></div><div class="ttdoc">GradientUpdateVisitor update the gradient parameter given the gradient set. </div><div class="ttdef"><b>Definition:</b> <a href="gradient__update__visitor_8hpp_source.html#l00027">gradient_update_visitor.hpp:27</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_1GradientUpdateVisitor_html_a2cd2ca0c23f012a30c513ef7071dcb52"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a2cd2ca0c23f012a30c513ef7071dcb52">mlpack::ann::GradientUpdateVisitor::LayerGradients</a></div><div class="ttdeci">std::enable_if< HasGradientCheck< T, arma::mat &(T::*)()>::value &&!HasModelCheck< T, std::vector< LayerTypes > &(T::*)()>::value, size_t >::type LayerGradients(T *layer, arma::mat &input) const </div><div class="ttdoc">Update the gradient if the module implements the Gradient() function. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1GradientUpdateVisitor_html_a1b7fcf17f70434bab8401df7cf1bf943"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a1b7fcf17f70434bab8401df7cf1bf943">mlpack::ann::GradientUpdateVisitor::offset</a></div><div class="ttdeci">size_t offset</div><div class="ttdoc">The gradient offset. </div><div class="ttdef"><b>Definition:</b> <a href="gradient__update__visitor_8hpp_source.html#l00042">gradient_update_visitor.hpp:42</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1GradientUpdateVisitor_html_ad555d1208aed11f6cabd07c88deb15ae"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#ad555d1208aed11f6cabd07c88deb15ae">mlpack::ann::GradientUpdateVisitor::operator()</a></div><div class="ttdeci">size_t operator()(LayerType *layer) const </div><div class="ttdoc">Update the gradient parameter. </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_1GradientUpdateVisitor_html_a48397f0fb495f95cfc729169b57de47a"><div class="ttname"><a href="classmlpack_1_1ann_1_1GradientUpdateVisitor.html#a48397f0fb495f95cfc729169b57de47a">mlpack::ann::GradientUpdateVisitor::gradient</a></div><div class="ttdeci">arma::mat && gradient</div><div class="ttdoc">The gradient set. </div><div class="ttdef"><b>Definition:</b> <a href="gradient__update__visitor_8hpp_source.html#l00039">gradient_update_visitor.hpp:39</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>
|