122 lines
22 KiB
HTML
122 lines
22 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/layer/layer_traits.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_104798ce316d01262d69b00f4c94ed15.html">layer</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">layer_traits.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="layer__traits_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_LAYER_LAYER_TRAITS_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define MLPACK_METHODS_ANN_LAYER_LAYER_TRAITS_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="sfinae__utility_8hpp.html">mlpack/core/util/sfinae_utility.hpp</a>></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">template</span><<span class="keyword">typename</span> LayerType></div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LayerTraits.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1LayerTraits.html">LayerTraits</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="l00035"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LayerTraits.html#ae59f0b8b021bb3c9515d62d0b342cd5e"> 35</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1ann_1_1LayerTraits.html#ae59f0b8b021bb3c9515d62d0b342cd5e">IsBinary</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LayerTraits.html#aede9e2e7678345c9d4d378809db5083b"> 40</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1ann_1_1LayerTraits.html#aede9e2e7678345c9d4d378809db5083b">IsOutputLayer</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LayerTraits.html#a0cd328b5c9e05eb779a710d8d9528906"> 45</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1ann_1_1LayerTraits.html#a0cd328b5c9e05eb779a710d8d9528906">IsBiasLayer</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">/*</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * This is true if the layer is a LSTM layer.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> **/</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LayerTraits.html#a206304ba47bc640109e302e96643bb54"> 50</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1ann_1_1LayerTraits.html#a206304ba47bc640109e302e96643bb54">IsLSTMLayer</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">/*</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * This is true if the layer is a connection layer.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> **/</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1LayerTraits.html#a4bb0f7474b3c8dcc32205f3e412fdf7d"> 55</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1ann_1_1LayerTraits.html#a4bb0f7474b3c8dcc32205f3e412fdf7d">IsConnection</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// This gives us a HasGradientCheck<T, U> type (where U is a function pointer)</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// we can use with SFINAE to catch when a type has a Gradient(...) function.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Gradient, HasGradientCheck);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// This gives us a HasDeterministicCheck<T, U> type (where U is a function</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// pointer) we can use with SFINAE to catch when a type has a Deterministic()</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// function.</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Deterministic, HasDeterministicCheck);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// This gives us a HasParametersCheck<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// can use with SFINAE to catch when a type has a Weights() function.</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Parameters, HasParametersCheck);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// This gives us a HasAddCheck<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// can use with SFINAE to catch when a type has a Weights() function.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(<a class="code" href="classmlpack_1_1ann_1_1Add.html">Add</a>, HasAddCheck);</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">// This gives us a HasModelCheck<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// can use with SFINAE to catch when a type has a Weights() function.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Model, HasModelCheck);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// This gives us a HasLocationCheck<T, U> type (where U is a function pointer)</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// we can use with SFINAE to catch when a type has a Location() function.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Location, HasLocationCheck);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// This gives us a HasResetCheck<T, U> type (where U is a function pointer)</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// we can use with SFINAE to catch when a type has a Location() function.</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Reset, HasResetCheck);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// This gives us a HasRewardCheck<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// can use with SFINAE to catch when a type has a Reward() function.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(Reward, HasRewardCheck);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// This gives us a HasInputWidth<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// can use with SFINAE to catch when a type has a InputWidth() function.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(InputWidth, HasInputWidth);</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="comment">// This gives us a HasInputHeight<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">// can use with SFINAE to catch when a type has a InputHeight() function.</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(InputHeight, HasInputHeight);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// This gives us a HasRho<T, U> type (where U is a function pointer) we</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// can use with SFINAE to catch when a type has a Rho() function.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <a class="code" href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">HAS_MEM_FUNC</a>(InputHeight, HasRho);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> } <span class="comment">// namespace ann</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1ann_1_1Add_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1Add.html">mlpack::ann::Add</a></div><div class="ttdoc">Implementation of the Add module class. </div><div class="ttdef"><b>Definition:</b> <a href="add_8hpp_source.html#l00034">add.hpp:34</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_1LayerTraits_html_ae59f0b8b021bb3c9515d62d0b342cd5e"><div class="ttname"><a href="classmlpack_1_1ann_1_1LayerTraits.html#ae59f0b8b021bb3c9515d62d0b342cd5e">mlpack::ann::LayerTraits::IsBinary</a></div><div class="ttdeci">static const bool IsBinary</div><div class="ttdoc">This is true if the layer is a binary layer. </div><div class="ttdef"><b>Definition:</b> <a href="layer__traits_8hpp_source.html#l00035">layer_traits.hpp:35</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LayerTraits_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1LayerTraits.html">mlpack::ann::LayerTraits</a></div><div class="ttdoc">This is a template class that can provide information about various layers. </div><div class="ttdef"><b>Definition:</b> <a href="layer__traits_8hpp_source.html#l00029">layer_traits.hpp:29</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LayerTraits_html_a0cd328b5c9e05eb779a710d8d9528906"><div class="ttname"><a href="classmlpack_1_1ann_1_1LayerTraits.html#a0cd328b5c9e05eb779a710d8d9528906">mlpack::ann::LayerTraits::IsBiasLayer</a></div><div class="ttdeci">static const bool IsBiasLayer</div><div class="ttdoc">This is true if the layer is a bias layer. </div><div class="ttdef"><b>Definition:</b> <a href="layer__traits_8hpp_source.html#l00045">layer_traits.hpp:45</a></div></div>
|
|
<div class="ttc" id="sfinae__utility_8hpp_html"><div class="ttname"><a href="sfinae__utility_8hpp.html">sfinae_utility.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LayerTraits_html_a206304ba47bc640109e302e96643bb54"><div class="ttname"><a href="classmlpack_1_1ann_1_1LayerTraits.html#a206304ba47bc640109e302e96643bb54">mlpack::ann::LayerTraits::IsLSTMLayer</a></div><div class="ttdeci">static const bool IsLSTMLayer</div><div class="ttdef"><b>Definition:</b> <a href="layer__traits_8hpp_source.html#l00050">layer_traits.hpp:50</a></div></div>
|
|
<div class="ttc" id="namespacemlpack_1_1ann_html_ac1b6745deedbcee048f2387da27389d4"><div class="ttname"><a href="namespacemlpack_1_1ann.html#ac1b6745deedbcee048f2387da27389d4">mlpack::ann::HAS_MEM_FUNC</a></div><div class="ttdeci">HAS_MEM_FUNC(Gradient, HasGradientCheck)</div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LayerTraits_html_a4bb0f7474b3c8dcc32205f3e412fdf7d"><div class="ttname"><a href="classmlpack_1_1ann_1_1LayerTraits.html#a4bb0f7474b3c8dcc32205f3e412fdf7d">mlpack::ann::LayerTraits::IsConnection</a></div><div class="ttdeci">static const bool IsConnection</div><div class="ttdef"><b>Definition:</b> <a href="layer__traits_8hpp_source.html#l00055">layer_traits.hpp:55</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1ann_1_1LayerTraits_html_aede9e2e7678345c9d4d378809db5083b"><div class="ttname"><a href="classmlpack_1_1ann_1_1LayerTraits.html#aede9e2e7678345c9d4d378809db5083b">mlpack::ann::LayerTraits::IsOutputLayer</a></div><div class="ttdeci">static const bool IsOutputLayer</div><div class="ttdoc">This is true if the layer is an output layer. </div><div class="ttdef"><b>Definition:</b> <a href="layer__traits_8hpp_source.html#l00040">layer_traits.hpp:40</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>
|