forked from arrayfire/arrayfire-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharrayfire.sparse.html
More file actions
382 lines (334 loc) · 18.6 KB
/
arrayfire.sparse.html
File metadata and controls
382 lines (334 loc) · 18.6 KB
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>arrayfire.sparse module — ArrayFire Python documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-arrayfire.sparse">
<span id="arrayfire-sparse-module"></span><h1>arrayfire.sparse module<a class="headerlink" href="#module-arrayfire.sparse" title="Permalink to this headline">¶</a></h1>
<p>Functions to create and manipulate sparse matrices.</p>
<dl class="py function">
<dt id="arrayfire.sparse.convert_sparse">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">convert_sparse</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#convert_sparse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.convert_sparse" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert sparse matrix from one format to another.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>storage</strong><span class="classifier">arrayfire.STORAGE.</span></dt><dd></dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>Sparse matrix converted to the appropriate type.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.convert_sparse_to_dense">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">convert_sparse_to_dense</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#convert_sparse_to_dense"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.convert_sparse_to_dense" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a dense matrix from a sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>A dense matrix.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.create_sparse">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">create_sparse</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">values</span></em>, <em class="sig-param"><span class="pre">row_idx</span></em>, <em class="sig-param"><span class="pre">col_idx</span></em>, <em class="sig-param"><span class="pre">nrows</span></em>, <em class="sig-param"><span class="pre">ncols</span></em>, <em class="sig-param"><span class="pre">storage=<STORAGE.CSR:</span> <span class="pre">1></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#create_sparse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.create_sparse" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a sparse matrix from it’s constituent parts.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>values</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>Contains the non zero elements of the sparse array.</p></li>
</ul>
</dd>
<dt><strong>row_idx</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>Contains row indices of the sparse array.</p></li>
</ul>
</dd>
<dt><strong>col_idx</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>Contains column indices of the sparse array.</p></li>
</ul>
</dd>
<dt><strong>nrows</strong><span class="classifier">int.</span></dt><dd><ul class="simple">
<li><p>specifies the number of rows in sparse matrix.</p></li>
</ul>
</dd>
<dt><strong>ncols</strong><span class="classifier">int.</span></dt><dd><ul class="simple">
<li><p>specifies the number of columns in sparse matrix.</p></li>
</ul>
</dd>
<dt><strong>storage</strong><span class="classifier">optional: arrayfire.STORAGE. default: arrayfire.STORAGE.CSR.</span></dt><dd><ul class="simple">
<li><p>Can be one of arrayfire.STORAGE.CSR, arrayfire.STORAGE.COO.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>A sparse matrix.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.create_sparse_from_dense">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">create_sparse_from_dense</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">dense</span></em>, <em class="sig-param"><span class="pre">storage=<STORAGE.CSR:</span> <span class="pre">1></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#create_sparse_from_dense"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.create_sparse_from_dense" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a sparse matrix from a dense matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>dense</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A dense matrix.</p></li>
</ul>
</dd>
<dt><strong>storage</strong><span class="classifier">optional: arrayfire.STORAGE. default: arrayfire.STORAGE.CSR.</span></dt><dd><ul class="simple">
<li><p>Can be one of arrayfire.STORAGE.CSR, arrayfire.STORAGE.COO.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>A sparse matrix.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.create_sparse_from_host">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">create_sparse_from_host</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">values</span></em>, <em class="sig-param"><span class="pre">row_idx</span></em>, <em class="sig-param"><span class="pre">col_idx</span></em>, <em class="sig-param"><span class="pre">nrows</span></em>, <em class="sig-param"><span class="pre">ncols</span></em>, <em class="sig-param"><span class="pre">storage=<STORAGE.CSR:</span> <span class="pre">1></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#create_sparse_from_host"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.create_sparse_from_host" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a sparse matrix from it’s constituent parts.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>values</strong><span class="classifier">Any datatype that can be converted to array.</span></dt><dd><ul class="simple">
<li><p>Contains the non zero elements of the sparse array.</p></li>
</ul>
</dd>
<dt><strong>row_idx</strong><span class="classifier">Any datatype that can be converted to array.</span></dt><dd><ul class="simple">
<li><p>Contains row indices of the sparse array.</p></li>
</ul>
</dd>
<dt><strong>col_idx</strong><span class="classifier">Any datatype that can be converted to array.</span></dt><dd><ul class="simple">
<li><p>Contains column indices of the sparse array.</p></li>
</ul>
</dd>
<dt><strong>nrows</strong><span class="classifier">int.</span></dt><dd><ul class="simple">
<li><p>specifies the number of rows in sparse matrix.</p></li>
</ul>
</dd>
<dt><strong>ncols</strong><span class="classifier">int.</span></dt><dd><ul class="simple">
<li><p>specifies the number of columns in sparse matrix.</p></li>
</ul>
</dd>
<dt><strong>storage</strong><span class="classifier">optional: arrayfire.STORAGE. default: arrayfire.STORAGE.CSR.</span></dt><dd><ul class="simple">
<li><p>Can be one of arrayfire.STORAGE.CSR, arrayfire.STORAGE.COO.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>A sparse matrix.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.sparse_get_col_idx">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">sparse_get_col_idx</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#sparse_get_col_idx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.sparse_get_col_idx" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the column indices from sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>arrayfire array containing the non zero elements.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.sparse_get_info">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">sparse_get_info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#sparse_get_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.sparse_get_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the constituent arrays and storage info from a sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>(values, row_idx, col_idx, storage) where</dt><dd></dd>
<dt><strong>values</strong><span class="classifier">arrayfire.Array containing non zero elements from sparse matrix</span></dt><dd></dd>
<dt><strong>row_idx</strong><span class="classifier">arrayfire.Array containing the row indices</span></dt><dd></dd>
<dt><strong>col_idx</strong><span class="classifier">arrayfire.Array containing the column indices</span></dt><dd></dd>
<dt><strong>storage</strong><span class="classifier">sparse storage</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.sparse_get_nnz">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">sparse_get_nnz</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#sparse_get_nnz"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.sparse_get_nnz" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the column indices from sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>Number of non zero elements in the sparse matrix.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.sparse_get_row_idx">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">sparse_get_row_idx</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#sparse_get_row_idx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.sparse_get_row_idx" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the row indices from sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>arrayfire array containing the non zero elements.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.sparse_get_storage">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">sparse_get_storage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#sparse_get_storage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.sparse_get_storage" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the column indices from sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>Number of non zero elements in the sparse matrix.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.sparse.sparse_get_values">
<code class="sig-prename descclassname"><span class="pre">arrayfire.sparse.</span></code><code class="sig-name descname"><span class="pre">sparse_get_values</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sparse</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/sparse.html#sparse_get_values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.sparse.sparse_get_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the non zero values from sparse matrix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>sparse</strong><span class="classifier">af.Array.</span></dt><dd><ul class="simple">
<li><p>A sparse matrix.</p></li>
</ul>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>arrayfire array containing the non zero elements.</dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/arrayfire_logo_symbol.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="index.html">ArrayFire</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2020, ArrayFire.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/arrayfire.sparse.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>