File: auxiliary.rst

package info (click to toggle)
rocsparse 6.4.3-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,428 kB
  • sloc: cpp: 234,069; f90: 9,307; sh: 2,262; python: 1,939; makefile: 1,585; ansic: 440; xml: 26
file content (480 lines) | stat: -rw-r--r-- 10,600 bytes parent folder | download
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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
.. meta::
  :description: rocSPARSE documentation and API reference library
  :keywords: rocSPARSE, ROCm, API, documentation

.. _rocsparse_auxiliary_functions_:

********************************************************************
Sparse auxiliary functions
********************************************************************

This module holds all sparse auxiliary functions.

The functions that are contained in the auxiliary module describe all available helper functions that are required for subsequent library calls.

The functions in this module do not support execution in a hipGraph context.

.. _rocsparse_create_handle_:

rocsparse_create_handle()
-------------------------

.. doxygenfunction:: rocsparse_create_handle

.. _rocsparse_destroy_handle_:

rocsparse_destroy_handle()
--------------------------

.. doxygenfunction:: rocsparse_destroy_handle

.. _rocsparse_set_stream_:

rocsparse_set_stream()
----------------------

.. doxygenfunction:: rocsparse_set_stream

rocsparse_get_stream()
----------------------

.. doxygenfunction:: rocsparse_get_stream

rocsparse_set_pointer_mode()
----------------------------

.. doxygenfunction:: rocsparse_set_pointer_mode

rocsparse_get_pointer_mode()
----------------------------

.. doxygenfunction:: rocsparse_get_pointer_mode

rocsparse_get_version()
-----------------------

.. doxygenfunction:: rocsparse_get_version

rocsparse_get_git_rev()
-----------------------

.. doxygenfunction:: rocsparse_get_git_rev

rocsparse_create_mat_descr()
----------------------------

.. doxygenfunction:: rocsparse_create_mat_descr

rocsparse_destroy_mat_descr()
-----------------------------

.. doxygenfunction:: rocsparse_destroy_mat_descr

rocsparse_copy_mat_descr()
--------------------------

.. doxygenfunction:: rocsparse_copy_mat_descr

rocsparse_set_mat_index_base()
------------------------------

.. doxygenfunction:: rocsparse_set_mat_index_base

rocsparse_get_mat_index_base()
------------------------------

.. doxygenfunction:: rocsparse_get_mat_index_base

rocsparse_set_mat_type()
------------------------

.. doxygenfunction:: rocsparse_set_mat_type

rocsparse_get_mat_type()
------------------------

.. doxygenfunction:: rocsparse_get_mat_type

rocsparse_set_mat_fill_mode()
-----------------------------

.. doxygenfunction:: rocsparse_set_mat_fill_mode

rocsparse_get_mat_fill_mode()
-----------------------------

.. doxygenfunction:: rocsparse_get_mat_fill_mode

rocsparse_set_mat_diag_type()
-----------------------------

.. doxygenfunction:: rocsparse_set_mat_diag_type

rocsparse_get_mat_diag_type()
-----------------------------

.. doxygenfunction:: rocsparse_get_mat_diag_type

rocsparse_set_mat_storage_mode()
--------------------------------

.. doxygenfunction:: rocsparse_set_mat_storage_mode

rocsparse_get_mat_storage_mode()
--------------------------------

.. doxygenfunction:: rocsparse_get_mat_storage_mode

.. _rocsparse_create_hyb_mat_:

rocsparse_create_hyb_mat()
--------------------------

.. doxygenfunction:: rocsparse_create_hyb_mat

rocsparse_destroy_hyb_mat()
---------------------------

.. doxygenfunction:: rocsparse_destroy_hyb_mat

rocsparse_copy_hyb_mat()
------------------------

.. doxygenfunction:: rocsparse_copy_hyb_mat

rocsparse_create_mat_info()
---------------------------

.. doxygenfunction:: rocsparse_create_mat_info

rocsparse_copy_mat_info()
-------------------------

.. doxygenfunction:: rocsparse_copy_mat_info

.. _rocsparse_destroy_mat_info_:

rocsparse_destroy_mat_info()
----------------------------

.. doxygenfunction:: rocsparse_destroy_mat_info

rocsparse_create_color_info()
-----------------------------

.. doxygenfunction:: rocsparse_create_color_info

rocsparse_destroy_color_info()
------------------------------

.. doxygenfunction:: rocsparse_destroy_color_info

rocsparse_copy_color_info()
---------------------------

.. doxygenfunction:: rocsparse_copy_color_info

rocsparse_create_spvec_descr()
------------------------------

.. doxygenfunction:: rocsparse_create_spvec_descr

rocsparse_destroy_spvec_descr()
-------------------------------

.. doxygenfunction:: rocsparse_destroy_spvec_descr

rocsparse_spvec_get()
---------------------

.. doxygenfunction:: rocsparse_spvec_get

rocsparse_spvec_get_index_base()
--------------------------------

.. doxygenfunction:: rocsparse_spvec_get_index_base

rocsparse_spvec_get_values()
----------------------------

.. doxygenfunction:: rocsparse_spvec_get_values

rocsparse_spvec_set_values()
----------------------------

.. doxygenfunction:: rocsparse_spvec_set_values

rocsparse_create_coo_descr
--------------------------

.. doxygenfunction:: rocsparse_create_coo_descr

rocsparse_create_coo_aos_descr
------------------------------

.. doxygenfunction:: rocsparse_create_coo_aos_descr

rocsparse_create_csr_descr
--------------------------

.. doxygenfunction:: rocsparse_create_csr_descr

rocsparse_create_csc_descr
--------------------------

.. doxygenfunction:: rocsparse_create_csc_descr

rocsparse_create_bsr_descr
--------------------------

.. doxygenfunction:: rocsparse_create_bsr_descr

rocsparse_create_ell_descr
--------------------------

.. doxygenfunction:: rocsparse_create_ell_descr

rocsparse_create_bell_descr
---------------------------

.. doxygenfunction:: rocsparse_create_bell_descr

rocsparse_create_const_coo_descr
--------------------------------

.. doxygenfunction:: rocsparse_create_const_coo_descr

rocsparse_create_const_csr_descr
--------------------------------

.. doxygenfunction:: rocsparse_create_const_csr_descr

rocsparse_create_const_csc_descr
--------------------------------

.. doxygenfunction:: rocsparse_create_const_csc_descr

rocsparse_create_const_bell_descr
---------------------------------

.. doxygenfunction:: rocsparse_create_const_bell_descr

rocsparse_destroy_spmat_descr
-----------------------------

.. doxygenfunction:: rocsparse_destroy_spmat_descr

rocsparse_create_sparse_to_sparse_descr
---------------------------------------

.. doxygenfunction:: rocsparse_create_sparse_to_sparse_descr

rocsparse_destroy_sparse_to_sparse_descr
----------------------------------------

.. doxygenfunction:: rocsparse_destroy_sparse_to_sparse_descr

rocsparse_sparse_to_sparse_permissive
-------------------------------------

.. doxygenfunction:: rocsparse_sparse_to_sparse_permissive

rocsparse_create_extract_descr
------------------------------

.. doxygenfunction:: rocsparse_create_extract_descr

rocsparse_destroy_extract_descr
-------------------------------

.. doxygenfunction:: rocsparse_destroy_extract_descr

rocsparse_coo_get
-----------------

.. doxygenfunction:: rocsparse_coo_get

rocsparse_coo_aos_get
---------------------

.. doxygenfunction:: rocsparse_coo_aos_get

rocsparse_csr_get
-----------------

.. doxygenfunction:: rocsparse_csr_get

rocsparse_ell_get
-----------------

.. doxygenfunction:: rocsparse_ell_get

rocsparse_bell_get
------------------

.. doxygenfunction:: rocsparse_bell_get

rocsparse_coo_set_pointers
--------------------------

.. doxygenfunction:: rocsparse_coo_set_pointers

rocsparse_coo_aos_set_pointers
------------------------------

.. doxygenfunction:: rocsparse_coo_aos_set_pointers

rocsparse_csr_set_pointers
--------------------------

.. doxygenfunction:: rocsparse_csr_set_pointers

rocsparse_csc_set_pointers
--------------------------

.. doxygenfunction:: rocsparse_csc_set_pointers

rocsparse_ell_set_pointers
--------------------------

.. doxygenfunction:: rocsparse_ell_set_pointers

rocsparse_bsr_set_pointers
--------------------------

.. doxygenfunction:: rocsparse_bsr_set_pointers

rocsparse_spmat_get_size
------------------------

.. doxygenfunction:: rocsparse_spmat_get_size

rocsparse_spmat_get_nnz
------------------------

.. doxygenfunction:: rocsparse_spmat_get_nnz

rocsparse_spmat_get_format
--------------------------

.. doxygenfunction:: rocsparse_spmat_get_format

rocsparse_spmat_get_index_base
------------------------------

.. doxygenfunction:: rocsparse_spmat_get_index_base

rocsparse_spmat_get_values
--------------------------

.. doxygenfunction:: rocsparse_spmat_get_values

rocsparse_spmat_set_values
--------------------------

.. doxygenfunction:: rocsparse_spmat_set_values

rocsparse_spmat_get_strided_batch
---------------------------------

.. doxygenfunction:: rocsparse_spmat_get_strided_batch

rocsparse_spmat_set_strided_batch
---------------------------------

.. doxygenfunction:: rocsparse_spmat_set_strided_batch

rocsparse_coo_set_strided_batch
-------------------------------

.. doxygenfunction:: rocsparse_coo_set_strided_batch

rocsparse_csr_set_strided_batch
-------------------------------

.. doxygenfunction:: rocsparse_csr_set_strided_batch

rocsparse_csc_set_strided_batch
-------------------------------

.. doxygenfunction:: rocsparse_csc_set_strided_batch

rocsparse_spmat_get_attribute
-----------------------------

.. doxygenfunction:: rocsparse_spmat_get_attribute

rocsparse_spmat_set_attribute
-----------------------------

.. doxygenfunction:: rocsparse_spmat_set_attribute

rocsparse_create_dnvec_descr
----------------------------

.. doxygenfunction:: rocsparse_create_dnvec_descr

rocsparse_create_const_dnvec_descr
----------------------------------

.. doxygenfunction:: rocsparse_create_const_dnvec_descr

rocsparse_destroy_dnvec_descr
-----------------------------

.. doxygenfunction:: rocsparse_destroy_dnvec_descr

rocsparse_dnvec_get
-------------------

.. doxygenfunction:: rocsparse_dnvec_get

rocsparse_dnvec_get_values
--------------------------

.. doxygenfunction:: rocsparse_dnvec_get_values

rocsparse_dnvec_set_values
--------------------------

.. doxygenfunction:: rocsparse_dnvec_set_values

rocsparse_create_dnmat_descr
----------------------------

.. doxygenfunction:: rocsparse_create_dnmat_descr

rocsparse_create_const_dnmat_descr
----------------------------------

.. doxygenfunction:: rocsparse_create_const_dnmat_descr

rocsparse_destroy_dnmat_descr
-----------------------------

.. doxygenfunction:: rocsparse_destroy_dnmat_descr

rocsparse_dnmat_get
-------------------

.. doxygenfunction:: rocsparse_dnmat_get

rocsparse_dnmat_get_values
--------------------------

.. doxygenfunction:: rocsparse_dnmat_get_values

rocsparse_dnmat_set_values
--------------------------

.. doxygenfunction:: rocsparse_dnmat_set_values

rocsparse_dnmat_get_strided_batch
---------------------------------

.. doxygenfunction:: rocsparse_dnmat_get_strided_batch

rocsparse_dnmat_set_strided_batch
---------------------------------

.. doxygenfunction:: rocsparse_dnmat_set_strided_batch