Files
mlpack/doc/html/oivs__init_8hpp_source.html
T

126 lines
21 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/init_rules/oivs_init.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_b52cc5b391c1a60ddf624b13b597843f.html">init_rules</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">oivs_init.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="oivs__init_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="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_ANN_INIT_RULES_OIVS_INIT_HPP</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_ANN_INIT_RULES_OIVS_INIT_HPP</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="preprocessor">#include &lt;<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="logistic__function_8hpp.html">mlpack/methods/ann/activation_functions/logistic_function.hpp</a>&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ann_2init__rules_2random__init_8hpp.html">random_init.hpp</a>&quot;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">template</span>&lt;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">class </span>ActivationFunction = LogisticFunction</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;&gt;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html"> 59</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html">OivsInitialization</a></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;{</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html#a9f4bbb8b83d194198f8ec33d21c36745"> 69</a></span>&#160; <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a9f4bbb8b83d194198f8ec33d21c36745">OivsInitialization</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> epsilon = 0.1,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a">k</a> = 5,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">gamma</a> = 0.9) :</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a">k</a>(<a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a">k</a>), <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">gamma</a>(<a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">gamma</a>),</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a480e0fb4088de412628cbe805973213d">b</a>(<a class="code" href="namespacestd.html">std</a>::abs(ActivationFunction::Inv(1 - epsilon) -</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; ActivationFunction::Inv(epsilon)))</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; {</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="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html#ae25cb09b1e03b2493bf8efd873dfa90a"> 86</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ae25cb09b1e03b2493bf8efd873dfa90a">Initialize</a>(arma::Mat&lt;eT&gt;&amp; W, <span class="keyword">const</span> <span class="keywordtype">size_t</span> rows, <span class="keyword">const</span> <span class="keywordtype">size_t</span> cols)</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; <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html">RandomInitialization</a> randomInit(-<a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">gamma</a>, <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">gamma</a>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; randomInit.<a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#a80d8b73d04b33ce114cfb4663831747c">Initialize</a>(W, rows, cols);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; W = (<a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a480e0fb4088de412628cbe805973213d">b</a> / (<a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a">k</a> * rows)) * arma::sqrt(W + 1);</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;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html#a06819a0620d1a639b973fd29c980bcc5"> 104</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a06819a0620d1a639b973fd29c980bcc5">Initialize</a>(arma::Cube&lt;eT&gt;&amp; W,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> rows,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> cols,</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> slices)</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; W = arma::Cube&lt;eT&gt;(rows, cols, slices);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; slices; i++)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ae25cb09b1e03b2493bf8efd873dfa90a">Initialize</a>(W.slice(i), rows, cols);</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="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a"> 117</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a">k</a>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27"> 120</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">gamma</a>;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1OivsInitialization.html#a480e0fb4088de412628cbe805973213d"> 123</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1OivsInitialization.html#a480e0fb4088de412628cbe805973213d">b</a>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;}; <span class="comment">// class OivsInitialization</span></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;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;} <span class="comment">// namespace ann</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="ann_2init__rules_2random__init_8hpp_html"><div class="ttname"><a href="ann_2init__rules_2random__init_8hpp.html">random_init.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="logistic__function_8hpp_html"><div class="ttname"><a href="logistic__function_8hpp.html">logistic_function.hpp</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RandomInitialization_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html">mlpack::ann::RandomInitialization</a></div><div class="ttdoc">This class is used to initialize randomly the weight matrix. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00024">random_init.hpp:24</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="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> <a href="prereqs_8hpp_source.html#l00056">prereqs.hpp:56</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html">mlpack::ann::OivsInitialization</a></div><div class="ttdoc">This class is used to initialize the weight matrix with the oivs method. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00059">oivs_init.hpp:59</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html_ae25cb09b1e03b2493bf8efd873dfa90a"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html#ae25cb09b1e03b2493bf8efd873dfa90a">mlpack::ann::OivsInitialization::Initialize</a></div><div class="ttdeci">void Initialize(arma::Mat&lt; eT &gt; &amp;W, const size_t rows, const size_t cols)</div><div class="ttdoc">Initialize the elements of the specified weight matrix with the oivs method. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00086">oivs_init.hpp:86</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html_a06819a0620d1a639b973fd29c980bcc5"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html#a06819a0620d1a639b973fd29c980bcc5">mlpack::ann::OivsInitialization::Initialize</a></div><div class="ttdeci">void Initialize(arma::Cube&lt; eT &gt; &amp;W, const size_t rows, const size_t cols, const size_t slices)</div><div class="ttdoc">Initialize the elements of the specified weight 3rd order tensor with the oivs method. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00104">oivs_init.hpp:104</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html_a376fbe1165b74f8f883710dfff73ca27"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html#a376fbe1165b74f8f883710dfff73ca27">mlpack::ann::OivsInitialization::gamma</a></div><div class="ttdeci">const double gamma</div><div class="ttdoc">Parameter to define the uniform random range. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00120">oivs_init.hpp:120</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html_a480e0fb4088de412628cbe805973213d"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html#a480e0fb4088de412628cbe805973213d">mlpack::ann::OivsInitialization::b</a></div><div class="ttdeci">const double b</div><div class="ttdoc">Parameter to control the activation region. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00123">oivs_init.hpp:123</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html_ab2f65131350aa79eec6203ab5094834a"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html#ab2f65131350aa79eec6203ab5094834a">mlpack::ann::OivsInitialization::k</a></div><div class="ttdeci">const int k</div><div class="ttdoc">Parameter to control the activation region width. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00117">oivs_init.hpp:117</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1OivsInitialization_html_a9f4bbb8b83d194198f8ec33d21c36745"><div class="ttname"><a href="classmlpack_1_1ann_1_1OivsInitialization.html#a9f4bbb8b83d194198f8ec33d21c36745">mlpack::ann::OivsInitialization::OivsInitialization</a></div><div class="ttdeci">OivsInitialization(const double epsilon=0.1, const int k=5, const double gamma=0.9)</div><div class="ttdoc">Initialize the random initialization rule with the given values. </div><div class="ttdef"><b>Definition:</b> <a href="oivs__init_8hpp_source.html#l00069">oivs_init.hpp:69</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RandomInitialization_html_a80d8b73d04b33ce114cfb4663831747c"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html#a80d8b73d04b33ce114cfb4663831747c">mlpack::ann::RandomInitialization::Initialize</a></div><div class="ttdeci">void Initialize(arma::Mat&lt; eT &gt; &amp;W, const size_t rows, const size_t cols)</div><div class="ttdoc">Initialize randomly the elements of the specified weight matrix. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00056">random_init.hpp:56</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>