120 lines
18 KiB
HTML
120 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/amf/update_rules/nmf_als.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_als.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="nmf__als_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_ALS_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_ALS_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="l00041"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFALSUpdate.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1amf_1_1NMFALSUpdate.html">NMFALSUpdate</a></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a4d1783987920c1882aaf4189b4f474bd"> 45</a></span>  <a class="code" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a4d1783987920c1882aaf4189b4f474bd">NMFALSUpdate</a>() { }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</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_1NMFALSUpdate.html#aa356ae918bac789c7e7f9ac1bf94a6c8"> 52</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#aa356ae918bac789c7e7f9ac1bf94a6c8">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="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Nothing to do.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a0eb0c482aa6e596e2f3679b40640a72a"> 72</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_1NMFALSUpdate.html#a0eb0c482aa6e596e2f3679b40640a72a">WUpdate</a>(<span class="keyword">const</span> MatType& V,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  arma::mat& W,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> arma::mat& H)</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>  <span class="comment">// The call to inv() sometimes fails; so we are using the psuedoinverse.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// W = (inv(H * H.t()) * H * V.t()).t();</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  W = V * H.t() * pinv(H * H.t());</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="comment">// Set all negative numbers to machine epsilon.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < W.n_elem; i++)</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="keywordflow">if</span> (W(i) < 0.0)</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  W(i) = 0.0;</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>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a95953ee6655a287ff502a358189b4bee"> 105</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_1NMFALSUpdate.html#a95953ee6655a287ff502a358189b4bee">HUpdate</a>(<span class="keyword">const</span> MatType& V,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> arma::mat& W,</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  arma::mat& H)</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  H = pinv(W.t() * W) * W.t() * V;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">// Set all negative numbers to 0.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < H.n_elem; i++)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">if</span> (H(i) < 0.0)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  H(i) = 0.0;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Archive></div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a0a407037255e2191e952e6c8f00f091a"> 123</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a0a407037255e2191e952e6c8f00f091a">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="l00124"></a><span class="lineno"> 124</span> }; <span class="comment">// class NMFALSUpdate</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> } <span class="comment">// namespace amf</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1amf_1_1NMFALSUpdate_html_a0eb0c482aa6e596e2f3679b40640a72a"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a0eb0c482aa6e596e2f3679b40640a72a">mlpack::amf::NMFALSUpdate::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__als_8hpp_source.html#l00072">nmf_als.hpp:72</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="classmlpack_1_1amf_1_1NMFALSUpdate_html_aa356ae918bac789c7e7f9ac1bf94a6c8"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFALSUpdate.html#aa356ae918bac789c7e7f9ac1bf94a6c8">mlpack::amf::NMFALSUpdate::Initialize</a></div><div class="ttdeci">void Initialize(const MatType &, const size_t)</div><div class="ttdoc">Set initial values for the factorization. </div><div class="ttdef"><b>Definition:</b> <a href="nmf__als_8hpp_source.html#l00052">nmf_als.hpp:52</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFALSUpdate_html_a95953ee6655a287ff502a358189b4bee"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a95953ee6655a287ff502a358189b4bee">mlpack::amf::NMFALSUpdate::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__als_8hpp_source.html#l00105">nmf_als.hpp:105</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFALSUpdate_html"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFALSUpdate.html">mlpack::amf::NMFALSUpdate</a></div><div class="ttdoc">This class implements a method titled &#39;Alternating Least Squares&#39; described in the following paper: ...</div><div class="ttdef"><b>Definition:</b> <a href="nmf__als_8hpp_source.html#l00041">nmf_als.hpp:41</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFALSUpdate_html_a4d1783987920c1882aaf4189b4f474bd"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a4d1783987920c1882aaf4189b4f474bd">mlpack::amf::NMFALSUpdate::NMFALSUpdate</a></div><div class="ttdeci">NMFALSUpdate()</div><div class="ttdoc">Empty constructor required for the UpdateRule template. </div><div class="ttdef"><b>Definition:</b> <a href="nmf__als_8hpp_source.html#l00045">nmf_als.hpp:45</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1amf_1_1NMFALSUpdate_html_a0a407037255e2191e952e6c8f00f091a"><div class="ttname"><a href="classmlpack_1_1amf_1_1NMFALSUpdate.html#a0a407037255e2191e952e6c8f00f091a">mlpack::amf::NMFALSUpdate::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__als_8hpp_source.html#l00123">nmf_als.hpp:123</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>
|