124 lines
20 KiB
HTML
124 lines
20 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/amf/init_rules/given_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
|
|
 <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_5d79f627790f2a48f4f1d0c9d0b8c107.html">amf</a></li><li class="navelem"><a class="el" href="dir_874bc73a472bc56857d75119e41021a1.html">init_rules</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">given_init.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="given__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> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef MLPACK_METHODS_AMF_INIT_RULES_GIVEN_INIT_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define MLPACK_METHODS_AMF_INIT_RULES_GIVEN_INIT_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="prereqs_8hpp.html">mlpack/prereqs.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>amf {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html">GivenInitialization</a></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="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// Empty constructor required for the InitializeRule template.</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#aa7ffbd014ade54c1be4803fcc472c59d"> 31</a></span>  <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#aa7ffbd014ade54c1be4803fcc472c59d">GivenInitialization</a>() { }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Initialize the GivenInitialization object with the given matrices.</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#a4649fc68042d5d09ae8e75da83ee982d"> 34</a></span>  <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a4649fc68042d5d09ae8e75da83ee982d">GivenInitialization</a>(<span class="keyword">const</span> arma::mat& <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>, <span class="keyword">const</span> arma::mat& <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>) : w(w), h(h) { }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// Initialize the GivenInitialization object, taking control of the given</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// matrices.</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#ae2d7c453039daaa217b08e0de2e06a15"> 38</a></span>  <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ae2d7c453039daaa217b08e0de2e06a15">GivenInitialization</a>(<span class="keyword">const</span> arma::mat&& <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>, <span class="keyword">const</span> arma::mat&& <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>) :</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>(<a class="code" href="namespacestd.html">std</a>::move(<a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>)),</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>(<a class="code" href="namespacestd.html">std</a>::move(<a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>))</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  { }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#a45da0b6c8429a47a235e04cacf35e4fb"> 52</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a45da0b6c8429a47a235e04cacf35e4fb">Initialize</a>(<span class="keyword">const</span> MatType& <span class="comment">/* V */</span>,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <span class="comment">/* r */</span>,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  arma::mat& W,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  arma::mat& H)</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>  <span class="comment">// Initialize to the given matrices.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  W = <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  H = <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Archive></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#a9d1355411d04bd0d9e89db4030d26558"> 64</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a9d1355411d04bd0d9e89db4030d26558">Serialize</a>(Archive& ar, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="comment">/* version */</span>)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  ar & <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">data::CreateNVP</a>(<a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>, <span class="stringliteral">"w"</span>);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  ar & <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">data::CreateNVP</a>(<a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>, <span class="stringliteral">"h"</span>);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37"> 72</a></span>  arma::mat <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">w</a>;</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d"> 74</a></span>  arma::mat <a class="code" href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">h</a>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> } <span class="comment">// namespace amf</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html_a45da0b6c8429a47a235e04cacf35e4fb"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#a45da0b6c8429a47a235e04cacf35e4fb">mlpack::amf::GivenInitialization::Initialize</a></div><div class="ttdeci">void Initialize(const MatType &, const size_t, arma::mat &W, arma::mat &H)</div><div class="ttdoc">Fill W and H with random uniform noise. </div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00052">given_init.hpp:52</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html_ac222fb52e3c87c7c5ea59c537055cc8d"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#ac222fb52e3c87c7c5ea59c537055cc8d">mlpack::amf::GivenInitialization::h</a></div><div class="ttdeci">arma::mat h</div><div class="ttdoc">The H matrix for initialization. </div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00074">given_init.hpp:74</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="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="namespacemlpack_1_1data_html_a785ee98e0070286ef86eeeea85a74018"><div class="ttname"><a href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">mlpack::data::CreateNVP</a></div><div class="ttdeci">FirstShim< T > CreateNVP(T &t, const std::string &name, typename std::enable_if_t< HasSerialize< T >::value > *=0)</div><div class="ttdoc">Call this function to produce a name-value pair; this is similar to BOOST_SERIALIZATION_NVP(), but should be used for types that have a Serialize() function (or contain a type that has a Serialize() function) instead of a serialize() function. </div><div class="ttdef"><b>Definition:</b> <a href="serialization__shim_8hpp_source.html#l00094">serialization_shim.hpp:94</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_1amf_1_1GivenInitialization_html_a9d1355411d04bd0d9e89db4030d26558"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#a9d1355411d04bd0d9e89db4030d26558">mlpack::amf::GivenInitialization::Serialize</a></div><div class="ttdeci">void Serialize(Archive &ar, const unsigned int)</div><div class="ttdoc">Serialize the object (in this case, there is nothing to serialize). </div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00064">given_init.hpp:64</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html">mlpack::amf::GivenInitialization</a></div><div class="ttdoc">This initialization rule for AMF simply fills the W and H matrices with the matrices given to the con...</div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00027">given_init.hpp:27</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html_aa7ffbd014ade54c1be4803fcc472c59d"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#aa7ffbd014ade54c1be4803fcc472c59d">mlpack::amf::GivenInitialization::GivenInitialization</a></div><div class="ttdeci">GivenInitialization()</div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00031">given_init.hpp:31</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html_ae2d7c453039daaa217b08e0de2e06a15"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#ae2d7c453039daaa217b08e0de2e06a15">mlpack::amf::GivenInitialization::GivenInitialization</a></div><div class="ttdeci">GivenInitialization(const arma::mat &&w, const arma::mat &&h)</div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00038">given_init.hpp:38</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html_a1facce6b44885555a72fdd8037b1bb37"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#a1facce6b44885555a72fdd8037b1bb37">mlpack::amf::GivenInitialization::w</a></div><div class="ttdeci">arma::mat w</div><div class="ttdoc">The W matrix for initialization. </div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00072">given_init.hpp:72</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1GivenInitialization_html_a4649fc68042d5d09ae8e75da83ee982d"><div class="ttname"><a href="classmlpack_1_1amf_1_1GivenInitialization.html#a4649fc68042d5d09ae8e75da83ee982d">mlpack::amf::GivenInitialization::GivenInitialization</a></div><div class="ttdeci">GivenInitialization(const arma::mat &w, const arma::mat &h)</div><div class="ttdef"><b>Definition:</b> <a href="given__init_8hpp_source.html#l00034">given_init.hpp:34</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>
|