Files
mlpack/doc/html/ann_2init__rules_2random__init_8hpp_source.html
T

122 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/init_rules/random_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">random_init.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="ann_2init__rules_2random__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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_ANN_INIT_RULES_RANDOM_INIT_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_ANN_INIT_RULES_RANDOM_INIT_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="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<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>&#160;<span class="keyword">namespace </span>ann {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html">RandomInitialization</a></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="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html#a759e46080f26bb7ca56a43dbac892255"> 34</a></span>&#160; <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#a759e46080f26bb7ca56a43dbac892255">RandomInitialization</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a> = -1,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a> = 1) :</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a>(<a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a>), <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a>(<a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a>) { }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html#a710c60d81b3b8d069e462a7c6d4fca98"> 45</a></span>&#160; <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#a710c60d81b3b8d069e462a7c6d4fca98">RandomInitialization</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> bound) :</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a>(-<a class="code" href="namespacestd.html">std</a>::abs(bound)), <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a>(<a class="code" href="namespacestd.html">std</a>::abs(bound)) { }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html#a80d8b73d04b33ce114cfb4663831747c"> 56</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#a80d8b73d04b33ce114cfb4663831747c">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="l00057"></a><span class="lineno"> 57</span>&#160; {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; W = <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a> + arma::randu&lt;arma::Mat&lt;eT&gt;&gt;(rows, cols) *</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; (<a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a> - <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</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;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html#a3285c0c7ae0fdf57453e86f610fee91f"> 70</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#a3285c0c7ae0fdf57453e86f610fee91f">Initialize</a>(arma::Cube&lt;eT&gt;&amp; W,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> rows,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> cols,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> slices)</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; W = arma::Cube&lt;eT&gt;(rows, cols, slices);</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; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; slices; i++)</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#a80d8b73d04b33ce114cfb4663831747c">Initialize</a>(W.slice(i), rows, cols);</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;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43"> 83</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c"> 86</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}; <span class="comment">// class RandomInitialization</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;} <span class="comment">// namespace ann</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="preprocessor">#endif</span></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_1RandomInitialization_html_a710c60d81b3b8d069e462a7c6d4fca98"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html#a710c60d81b3b8d069e462a7c6d4fca98">mlpack::ann::RandomInitialization::RandomInitialization</a></div><div class="ttdeci">RandomInitialization(const double bound)</div><div class="ttdoc">Initialize the random initialization rule with the given bound. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00045">random_init.hpp:45</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="classmlpack_1_1ann_1_1RandomInitialization_html_ab511dd4546b50164dc27033a4ec01e0c"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">mlpack::ann::RandomInitialization::upperBound</a></div><div class="ttdeci">const double upperBound</div><div class="ttdoc">The number used as upper bound. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00086">random_init.hpp:86</a></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_1RandomInitialization_html_a3285c0c7ae0fdf57453e86f610fee91f"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html#a3285c0c7ae0fdf57453e86f610fee91f">mlpack::ann::RandomInitialization::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 randomly the elements of the specified weight 3rd order tensor. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00070">random_init.hpp:70</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RandomInitialization_html_a759e46080f26bb7ca56a43dbac892255"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html#a759e46080f26bb7ca56a43dbac892255">mlpack::ann::RandomInitialization::RandomInitialization</a></div><div class="ttdeci">RandomInitialization(const double lowerBound=-1, const double upperBound=1)</div><div class="ttdoc">Initialize the random initialization rule with the given lower bound and upper bound. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00034">random_init.hpp:34</a></div></div>
<div class="ttc" id="classmlpack_1_1ann_1_1RandomInitialization_html_abae29d086c221a9575565960cd77bc43"><div class="ttname"><a href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">mlpack::ann::RandomInitialization::lowerBound</a></div><div class="ttdeci">const double lowerBound</div><div class="ttdoc">The number used as lower bound. </div><div class="ttdef"><b>Definition:</b> <a href="ann_2init__rules_2random__init_8hpp_source.html#l00083">random_init.hpp:83</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>