1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<!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.6"/>
<title>ViennaCL - The Vienna Computing Library: nmf.cpp</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.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 style="padding-left: 0.5em;">
<div id="projectname">ViennaCL - The Vienna Computing Library
 <span id="projectnumber">1.7.1</span>
</div>
<div id="projectbrief">Free open-source GPU-accelerated linear algebra and solver library.</div>
</td>
<td> <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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('nmf_8cpp-example.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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 class="header">
<div class="headertitle">
<div class="title">nmf.cpp</div> </div>
</div><!--header-->
<div class="contents">
<p>This tutorial explains how to use the nonnegative matrix factorization (NMF) functionality in ViennaCL.</p>
<p>The first step is to include the necessary headers and define the floating point type used for the computations: </p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="matrix_8hpp.html">viennacl/matrix.hpp</a>"</span></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="nmf_8hpp.html">viennacl/linalg/nmf.hpp</a>"</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// feel free to change this to 'double' if supported by your hardware.</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keywordtype">float</span> <a name="a0"></a><a class="code" href="tests_2src_2nmf_8cpp.html#ad5c19ca4f47d3f8ec21232a5af2624e5">ScalarType</a>;</div>
</div><!-- fragment --><p> The following routine fills a matrix with uniformly distributed random values from the interval [0,1]. This is used to initialize the matrices to be factored </p>
<div class="fragment"><div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> MajorT></div>
<div class="line"><span class="keywordtype">void</span> <a name="a1"></a><a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(<a name="_a2"></a><a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, MajorT></a> & A)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">for</span> (std::size_t i = 0; i < A.<a name="a3"></a><a class="code" href="classviennacl_1_1matrix__base.html#a24e4f5fa27a1af5ad47e52a97c065d68">size1</a>(); i++)</div>
<div class="line"> <span class="keywordflow">for</span> (std::size_t j = 0; j < A.<a name="a4"></a><a class="code" href="classviennacl_1_1matrix__base.html#a4348766b3b9cb049f7acd6a795272dbe">size2</a>(); ++j)</div>
<div class="line"> A(i, j) = <span class="keyword">static_cast<</span><a class="code" href="fft__1d_8cpp.html#ad5c19ca4f47d3f8ec21232a5af2624e5">ScalarType</a><span class="keyword">></span>(rand()) / <a class="code" href="tests_2src_2nmf_8cpp.html#ad5c19ca4f47d3f8ec21232a5af2624e5">ScalarType</a>(RAND_MAX);</div>
<div class="line">}</div>
</div><!-- fragment --><p> In the main routine we set up a matrix V and compute approximate factors W and H such that <img class="formulaInl" alt="$V \approx W H $" src="form_119.png"/>, where all three matrices carry nonnegative entries only. Since W and H are usually chosen to represent a rank-k-approximation of V, we use a similar low-rank approximation here. </p>
<div class="fragment"><div class="line"><span class="keywordtype">int</span> <a name="a5"></a><a class="code" href="tests_2src_2nmf_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>()</div>
<div class="line">{</div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"------- Tutorial NMF --------"</span> << std::endl;</div>
<div class="line"> std::cout << std::endl;</div>
</div><!-- fragment --><p> Approximate the 7-by-6-matrix V by a 7-by-3-matrix W and a 3-by-6-matrix H </p>
<div class="fragment"><div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m = 7; <span class="comment">//size1 of W and size1 of V</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n = 6; <span class="comment">//size2 of V and size2 of H</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> k = 3; <span class="comment">//size2 of W and size1 of H</span></div>
<div class="line"></div>
<div class="line"><a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, viennacl::column_major></a> V(m, n);</div>
<div class="line"><a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, viennacl::column_major></a> W(m, k);</div>
<div class="line"><a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, viennacl::column_major></a> H(k, n);</div>
</div><!-- fragment --><p> Fill the matrices randomly. Initial guesses for W and H consisting of only zeros won't work. </p>
<div class="fragment"><div class="line"><a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(V);</div>
<div class="line"><a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(W);</div>
<div class="line"><a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(H);</div>
<div class="line"></div>
<div class="line">std::cout << <span class="stringliteral">"Input matrices:"</span> << std::endl;</div>
<div class="line">std::cout << <span class="stringliteral">"V"</span> << V << std::endl;</div>
<div class="line">std::cout << <span class="stringliteral">"W"</span> << W << std::endl;</div>
<div class="line">std::cout << <span class="stringliteral">"H"</span> << H << <span class="stringliteral">"\n"</span> << std::endl;</div>
</div><!-- fragment --><p> Create configuration object to hold (and adjust) the respective parameters. </p>
<div class="fragment"><div class="line"><a name="_a6"></a><a class="code" href="classviennacl_1_1linalg_1_1nmf__config.html">viennacl::linalg::nmf_config</a> conf;</div>
<div class="line">conf.<a name="a7"></a><a class="code" href="classviennacl_1_1linalg_1_1nmf__config.html#ab948223929be79e20a1050146210ec6d">print_relative_error</a>(<span class="keyword">false</span>);</div>
<div class="line">conf.<a name="a8"></a><a class="code" href="classviennacl_1_1linalg_1_1nmf__config.html#a494899ccb2fed620eb7fb69da5fc46c0">max_iterations</a>(50); <span class="comment">// 50 iterations are enough here</span></div>
</div><!-- fragment --><p> Call the NMF routine and print the results </p>
<div class="fragment"><div class="line">std::cout << <span class="stringliteral">"Computing NMF"</span> << std::endl;</div>
<div class="line"><a name="a9"></a><a class="code" href="namespaceviennacl_1_1linalg.html#a1682d7a829cecf20106e407aed749a49">viennacl::linalg::nmf</a>(V, W, H, conf);</div>
<div class="line"></div>
<div class="line">std::cout << <span class="stringliteral">"RESULT:"</span> << std::endl;</div>
<div class="line">std::cout << <span class="stringliteral">"V"</span> << V << std::endl;</div>
<div class="line">std::cout << <span class="stringliteral">"W"</span> << W << std::endl;</div>
<div class="line">std::cout << <span class="stringliteral">"H"</span> << H << <span class="stringliteral">"\n"</span> << std::endl;</div>
</div><!-- fragment --><p> Print the product W*H approximating V for comparison and exit: </p>
<div class="fragment"><div class="line"> std::cout << <span class="stringliteral">"W*H:"</span> << std::endl;</div>
<div class="line"> <a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType></a> resultCorrect = <a name="a10"></a><a class="code" href="namespaceviennacl_1_1linalg.html#aa18d10f8a90e38bd9ff43c650fc670ef">viennacl::linalg::prod</a>(W, H);</div>
<div class="line"> std::cout << resultCorrect << std::endl;</div>
<div class="line"></div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"------- Tutorial completed --------"</span> << std::endl;</div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"></div>
<div class="line">}</div>
</div><!-- fragment --> <h2>Full Example Code</h2>
<div class="fragment"><div class="line"><span class="comment">/* =========================================================================</span></div>
<div class="line"><span class="comment"> Copyright (c) 2010-2016, Institute for Microelectronics,</span></div>
<div class="line"><span class="comment"> Institute for Analysis and Scientific Computing,</span></div>
<div class="line"><span class="comment"> TU Wien.</span></div>
<div class="line"><span class="comment"> Portions of this software are copyright by UChicago Argonne, LLC.</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment"> -----------------</span></div>
<div class="line"><span class="comment"> ViennaCL - The Vienna Computing Library</span></div>
<div class="line"><span class="comment"> -----------------</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment"> Project Head: Karl Rupp rupp@iue.tuwien.ac.at</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment"> (A list of authors and contributors can be found in the PDF manual)</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment"> License: MIT (X11), see file LICENSE in the base directory</span></div>
<div class="line"><span class="comment"> ============================================================================= */</span></div>
<div class="line"></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="matrix_8hpp.html">viennacl/matrix.hpp</a>"</span></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="nmf_8hpp.html">viennacl/linalg/nmf.hpp</a>"</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// feel free to change this to 'double' if supported by your hardware.</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keywordtype">float</span> <a class="code" href="tests_2src_2nmf_8cpp.html#ad5c19ca4f47d3f8ec21232a5af2624e5">ScalarType</a>;</div>
<div class="line"></div>
<div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> MajorT></div>
<div class="line"><span class="keywordtype">void</span> <a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(<a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, MajorT></a> & A)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">for</span> (std::size_t i = 0; i < A.<a class="code" href="classviennacl_1_1matrix__base.html#a24e4f5fa27a1af5ad47e52a97c065d68">size1</a>(); i++)</div>
<div class="line"> <span class="keywordflow">for</span> (std::size_t j = 0; j < A.<a class="code" href="classviennacl_1_1matrix__base.html#a4348766b3b9cb049f7acd6a795272dbe">size2</a>(); ++j)</div>
<div class="line"> A(i, j) = <span class="keyword">static_cast<</span>ScalarType<span class="keyword">></span>(rand()) / <a class="code" href="tests_2src_2nmf_8cpp.html#ad5c19ca4f47d3f8ec21232a5af2624e5">ScalarType</a>(RAND_MAX);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">int</span> <a class="code" href="tests_2src_2nmf_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>()</div>
<div class="line">{</div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"------- Tutorial NMF --------"</span> << std::endl;</div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"></div>
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m = 7; <span class="comment">//size1 of W and size1 of V</span></div>
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n = 6; <span class="comment">//size2 of V and size2 of H</span></div>
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> k = 3; <span class="comment">//size2 of W and size1 of H</span></div>
<div class="line"></div>
<div class="line"> <a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, viennacl::column_major></a> V(m, n);</div>
<div class="line"> <a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, viennacl::column_major></a> W(m, k);</div>
<div class="line"> <a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType, viennacl::column_major></a> H(k, n);</div>
<div class="line"></div>
<div class="line"> <a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(V);</div>
<div class="line"> <a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(W);</div>
<div class="line"> <a class="code" href="tests_2src_2nmf_8cpp.html#ac2617f03bdf9d88e2417e044625987da">fill_random</a>(H);</div>
<div class="line"></div>
<div class="line"> std::cout << <span class="stringliteral">"Input matrices:"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"V"</span> << V << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"W"</span> << W << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"H"</span> << H << <span class="stringliteral">"\n"</span> << std::endl;</div>
<div class="line"></div>
<div class="line"> <a class="code" href="classviennacl_1_1linalg_1_1nmf__config.html">viennacl::linalg::nmf_config</a> conf;</div>
<div class="line"> conf.<a class="code" href="classviennacl_1_1linalg_1_1nmf__config.html#ab948223929be79e20a1050146210ec6d">print_relative_error</a>(<span class="keyword">false</span>);</div>
<div class="line"> conf.<a class="code" href="classviennacl_1_1linalg_1_1nmf__config.html#a494899ccb2fed620eb7fb69da5fc46c0">max_iterations</a>(50); <span class="comment">// 50 iterations are enough here</span></div>
<div class="line"></div>
<div class="line"> std::cout << <span class="stringliteral">"Computing NMF"</span> << std::endl;</div>
<div class="line"> <a class="code" href="namespaceviennacl_1_1linalg.html#a1682d7a829cecf20106e407aed749a49">viennacl::linalg::nmf</a>(V, W, H, conf);</div>
<div class="line"></div>
<div class="line"> std::cout << <span class="stringliteral">"RESULT:"</span> << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"V"</span> << V << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"W"</span> << W << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"H"</span> << H << <span class="stringliteral">"\n"</span> << std::endl;</div>
<div class="line"></div>
<div class="line"> std::cout << <span class="stringliteral">"W*H:"</span> << std::endl;</div>
<div class="line"> <a class="code" href="classviennacl_1_1matrix.html">viennacl::matrix<ScalarType></a> resultCorrect = <a class="code" href="namespaceviennacl_1_1linalg.html#aa18d10f8a90e38bd9ff43c650fc670ef">viennacl::linalg::prod</a>(W, H);</div>
<div class="line"> std::cout << resultCorrect << std::endl;</div>
<div class="line"></div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"> std::cout << <span class="stringliteral">"------- Tutorial completed --------"</span> << std::endl;</div>
<div class="line"> std::cout << std::endl;</div>
<div class="line"></div>
<div class="line">}</div>
</div><!-- fragment --> </div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Wed Jan 20 2016 22:32:38 for ViennaCL - The Vienna Computing Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
|
