120 lines
16 KiB
HTML
120 lines
16 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/update_rules/nmf_mult_dist.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_d2d4272c0c3066ecaa6136c65bce4822.html">update_rules</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">nmf_mult_dist.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="nmf__mult__dist_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="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef MLPACK_METHODS_LMF_UPDATE_RULES_NMF_MULT_DIST_UPDATE_RULES_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define MLPACK_METHODS_LMF_UPDATE_RULES_NMF_MULT_DIST_UPDATE_RULES_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>amf {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html">NMFMultiplicativeDistanceUpdate</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Empty constructor required for the UpdateRule template.</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a8c702dd8bd0b59187f2ad57c90e774ad"> 43</a></span>  <a class="code" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a8c702dd8bd0b59187f2ad57c90e774ad">NMFMultiplicativeDistanceUpdate</a>() { }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a2d7b189f18209952d4005442d4e3e14d"> 50</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a2d7b189f18209952d4005442d4e3e14d">Initialize</a>(<span class="keyword">const</span> MatType& <span class="comment">/* dataset */</span>, <span class="keyword">const</span> <span class="keywordtype">size_t</span> <span class="comment">/* rank */</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">// Nothing to do.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a51f2ef4143c9cb8e2faed2009f2b5fce"> 70</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a51f2ef4143c9cb8e2faed2009f2b5fce">WUpdate</a>(<span class="keyword">const</span> MatType& V,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  arma::mat& W,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> arma::mat& H)</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>  W = (W % (V * H.t())) / (W * H * H.t());</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="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a32469c2f51f5b0859aff74db2fe136ab"> 92</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a32469c2f51f5b0859aff74db2fe136ab">HUpdate</a>(<span class="keyword">const</span> MatType& V,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> arma::mat& W,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  arma::mat& H)</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  H = (H % (W.t() * V)) / (W.t() * W * H);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Archive></div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#ab5740a2e871f98b8dc40ec4b88cf2361"> 101</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#ab5740a2e871f98b8dc40ec4b88cf2361">Serialize</a>(Archive& <span class="comment">/* ar */</span>, <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="l00102"></a><span class="lineno"> 102</span> };</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// namespace amf</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate_html_a32469c2f51f5b0859aff74db2fe136ab"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a32469c2f51f5b0859aff74db2fe136ab">mlpack::amf::NMFMultiplicativeDistanceUpdate::HUpdate</a></div><div class="ttdeci">static void HUpdate(const MatType &V, const arma::mat &W, arma::mat &H)</div><div class="ttdoc">The update rule for the encoding matrix H. </div><div class="ttdef"><b>Definition:</b> <a href="nmf__mult__dist_8hpp_source.html#l00092">nmf_mult_dist.hpp:92</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_1amf_1_1NMFMultiplicativeDistanceUpdate_html_a51f2ef4143c9cb8e2faed2009f2b5fce"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a51f2ef4143c9cb8e2faed2009f2b5fce">mlpack::amf::NMFMultiplicativeDistanceUpdate::WUpdate</a></div><div class="ttdeci">static void WUpdate(const MatType &V, arma::mat &W, const arma::mat &H)</div><div class="ttdoc">The update rule for the basis matrix W. </div><div class="ttdef"><b>Definition:</b> <a href="nmf__mult__dist_8hpp_source.html#l00070">nmf_mult_dist.hpp:70</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_1amf_1_1NMFMultiplicativeDistanceUpdate_html_ab5740a2e871f98b8dc40ec4b88cf2361"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#ab5740a2e871f98b8dc40ec4b88cf2361">mlpack::amf::NMFMultiplicativeDistanceUpdate::Serialize</a></div><div class="ttdeci">void Serialize(Archive &, 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="nmf__mult__dist_8hpp_source.html#l00101">nmf_mult_dist.hpp:101</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate_html_a2d7b189f18209952d4005442d4e3e14d"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a2d7b189f18209952d4005442d4e3e14d">mlpack::amf::NMFMultiplicativeDistanceUpdate::Initialize</a></div><div class="ttdeci">void Initialize(const MatType &, const size_t)</div><div class="ttdoc">Initialize the factorization. </div><div class="ttdef"><b>Definition:</b> <a href="nmf__mult__dist_8hpp_source.html#l00050">nmf_mult_dist.hpp:50</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate_html_a8c702dd8bd0b59187f2ad57c90e774ad"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html#a8c702dd8bd0b59187f2ad57c90e774ad">mlpack::amf::NMFMultiplicativeDistanceUpdate::NMFMultiplicativeDistanceUpdate</a></div><div class="ttdeci">NMFMultiplicativeDistanceUpdate()</div><div class="ttdef"><b>Definition:</b> <a href="nmf__mult__dist_8hpp_source.html#l00043">nmf_mult_dist.hpp:43</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate_html"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFMultiplicativeDistanceUpdate.html">mlpack::amf::NMFMultiplicativeDistanceUpdate</a></div><div class="ttdoc">The multiplicative distance update rules for matrices W and H. </div><div class="ttdef"><b>Definition:</b> <a href="nmf__mult__dist_8hpp_source.html#l00039">nmf_mult_dist.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>
|