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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
|
/*! \file */
/* ************************************************************************
* Copyright (C) 2023-2024 Advanced Micro Devices, Inc. All rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the Software), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* ************************************************************************ */
#ifndef ROCSPARSE_BSRMV_H
#define ROCSPARSE_BSRMV_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using BSR storage format
*
* \details
* \p rocsparse_bsrmv_ex_analysis performs the analysis step for rocsparse_sbsrmv(),
* rocsparse_dbsrmv(), rocsparse_cbsrmv() and rocsparse_zbsrmv(). It is expected that
* this function will be executed only once for a given matrix and particular operation
* type. The gathered analysis meta data can be cleared by rocsparse_bsrmv_ex_clear().
*
* \note
* If the matrix sparsity pattern changes, the gathered information will become invalid.
*
* \note
* This function is blocking with respect to the host.
*
* \note
* This routine does not support execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* dir matrix storage of BSR blocks.
* @param[in]
* trans matrix operation type.
* @param[in]
* mb number of block rows of the sparse BSR matrix.
* @param[in]
* nb number of block columns of the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero blocks of the sparse BSR matrix.
* @param[in]
* descr descriptor of the sparse BSR matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* bsr_val array of \p nnzb blocks of the sparse BSR matrix.
* @param[in]
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of
* the sparse BSR matrix.
* @param[in]
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse
* BSR matrix.
* @param[in]
* block_dim block dimension of the sparse BSR matrix.
* @param[out]
* info structure that holds the information collected during the analysis step.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_size \p mb, \p nb or \p nnzb is invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p bsr_val, \p bsr_row_ptr,
* \p bsr_col_ind or \p info pointer is invalid.
* \retval rocsparse_status_memory_error the buffer for the gathered information
* could not be allocated.
* \retval rocsparse_status_internal_error an internal error occurred.
* \retval rocsparse_status_not_implemented
* \p trans != \ref rocsparse_operation_none or
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*/
/**@{*/
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_sbsrmv_analysis instead.")))
ROCSPARSE_EXPORT rocsparse_status
rocsparse_sbsrmv_ex_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const float* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_dbsrmv_analysis instead.")))
ROCSPARSE_EXPORT rocsparse_status
rocsparse_dbsrmv_ex_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const double* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_cbsrmv_analysis instead.")))
ROCSPARSE_EXPORT rocsparse_status
rocsparse_cbsrmv_ex_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_zbsrmv_analysis instead.")))
ROCSPARSE_EXPORT rocsparse_status
rocsparse_zbsrmv_ex_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
/**@}*/
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using BSR storage format
*
* \details
* \p rocsparse_bsrmv_ex multiplies the scalar \f$\alpha\f$ with a sparse
* \f$(mb \cdot \text{block_dim}) \times (nb \cdot \text{block_dim})\f$
* matrix, defined in BSR storage format, and the dense vector \f$x\f$ and adds the
* result to the dense vector \f$y\f$ that is multiplied by the scalar \f$\beta\f$,
* such that
* \f[
* y := \alpha \cdot op(A) \cdot x + \beta \cdot y,
* \f]
* with
* \f[
* op(A) = \left\{
* \begin{array}{ll}
* A, & \text{if trans == rocsparse_operation_none} \\
* A^T, & \text{if trans == rocsparse_operation_transpose} \\
* A^H, & \text{if trans == rocsparse_operation_conjugate_transpose}
* \end{array}
* \right.
* \f]
*
* \note
* This function is non blocking and executed asynchronously with respect to the host.
* It may return before the actual computation has finished.
*
* \note
* Currently, only \p trans == \ref rocsparse_operation_none is supported.
*
* \note
* This routine supports execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* dir matrix storage of BSR blocks.
* @param[in]
* trans matrix operation type.
* @param[in]
* mb number of block rows of the sparse BSR matrix.
* @param[in]
* nb number of block columns of the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero blocks of the sparse BSR matrix.
* @param[in]
* alpha scalar \f$\alpha\f$.
* @param[in]
* descr descriptor of the sparse BSR matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* bsr_val array of \p nnzb blocks of the sparse BSR matrix.
* @param[in]
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of
* the sparse BSR matrix.
* @param[in]
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse
* BSR matrix.
* @param[in]
* block_dim block dimension of the sparse BSR matrix.
* @param[in]
* x array of \p nb*block_dim elements (\f$op(A) = A\f$) or \p mb*block_dim
* elements (\f$op(A) = A^T\f$ or \f$op(A) = A^H\f$).
* @param[in]
* beta scalar \f$\beta\f$.
* @param[inout]
* y array of \p mb*block_dim elements (\f$op(A) = A\f$) or \p nb*block_dim
* elements (\f$op(A) = A^T\f$ or \f$op(A) = A^H\f$).
* @param[out]
* info structure that holds the information collected during the analysis step.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_size \p mb, \p nb, \p nnzb or \p block_dim is
* invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p bsr_val,
* \p bsr_row_ind, \p bsr_col_ind, \p x, \p beta or \p y pointer is invalid.
* \retval rocsparse_status_arch_mismatch the device is not supported.
* \retval rocsparse_status_not_implemented
* \p trans != \ref rocsparse_operation_none or
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*/
/**@{*/
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_sbsrmv instead."))) ROCSPARSE_EXPORT rocsparse_status
rocsparse_sbsrmv_ex(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const float* alpha,
const rocsparse_mat_descr descr,
const float* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const float* x,
const float* beta,
float* y);
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_dbsrmv instead."))) ROCSPARSE_EXPORT rocsparse_status
rocsparse_dbsrmv_ex(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const double* alpha,
const rocsparse_mat_descr descr,
const double* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const double* x,
const double* beta,
double* y);
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_cbsrmv instead."))) ROCSPARSE_EXPORT rocsparse_status
rocsparse_cbsrmv_ex(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_float_complex* alpha,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const rocsparse_float_complex* x,
const rocsparse_float_complex* beta,
rocsparse_float_complex* y);
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_zbsrmv instead."))) ROCSPARSE_EXPORT rocsparse_status
rocsparse_zbsrmv_ex(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_double_complex* alpha,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const rocsparse_double_complex* x,
const rocsparse_double_complex* beta,
rocsparse_double_complex* y);
/**@}*/
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using BSR storage format
*
* \details
* \p rocsparse_bsrmv_ex_clear deallocates all memory that was allocated by
* rocsparse_sbsrmv_ex_analysis(), rocsparse_dbsrmv_ex_analysis(), rocsparse_cbsrmv_ex_analysis()
* or rocsparse_zbsrmv_ex_analysis(). This is especially useful, if memory is an issue and
* the analysis data is not required anymore for further computation, e.g. when
* switching to another sparse matrix format.
*
* \note
* Calling \p rocsparse_bsrmv_ex_clear is optional. All allocated resources will be
* cleared, when the opaque \ref rocsparse_mat_info struct is destroyed using
* rocsparse_destroy_mat_info().
*
* \note
* This routine does not support execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[inout]
* info structure that holds the information collected during analysis step.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_pointer \p info pointer is invalid.
* \retval rocsparse_status_memory_error the buffer for the gathered information
* could not be deallocated.
* \retval rocsparse_status_internal_error an internal error occurred.
* */
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
"Use rocsparse_bsrmv_clear instead."))) ROCSPARSE_EXPORT rocsparse_status
rocsparse_bsrmv_ex_clear(rocsparse_handle handle, rocsparse_mat_info info);
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using BSR storage format
*
* \details
* \p rocsparse_bsrmv_analysis performs the analysis step for rocsparse_sbsrmv(),
* rocsparse_dbsrmv(), rocsparse_cbsrmv() and rocsparse_zbsrmv(). It is expected that
* this function will be executed only once for a given matrix and particular operation
* type. The gathered analysis meta data can be cleared by rocsparse_bsrmv_clear().
*
* \note
* If the matrix sparsity pattern changes, the gathered information will become invalid.
*
* \note
* This function is non blocking and executed asynchronously with respect to the host.
* It may return before the actual computation has finished.
*
* \note
* This routine does not support execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* dir matrix storage of BSR blocks.
* @param[in]
* trans matrix operation type.
* @param[in]
* mb number of block rows of the sparse BSR matrix.
* @param[in]
* nb number of block columns of the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero blocks of the sparse BSR matrix.
* @param[in]
* descr descriptor of the sparse BSR matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* bsr_val array of \p nnzb blocks of the sparse BSR matrix.
* @param[in]
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of
* the sparse BSR matrix.
* @param[in]
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse
* BSR matrix.
* @param[in]
* block_dim block dimension of the sparse BSR matrix.
* @param[out]
* info structure that holds the information collected during the analysis step.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_size \p mb, \p nb or \p nnzb is invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p bsr_val, \p bsr_row_ptr,
* \p bsr_col_ind or \p info pointer is invalid.
* \retval rocsparse_status_memory_error the buffer for the gathered information
* could not be allocated.
* \retval rocsparse_status_internal_error an internal error occurred.
* \retval rocsparse_status_not_implemented
* \p trans != \ref rocsparse_operation_none or
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sbsrmv_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const float* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dbsrmv_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const double* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cbsrmv_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zbsrmv_analysis(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info);
/**@}*/
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using BSR storage format
*
* \details
* \p rocsparse_bsrmv multiplies the scalar \f$\alpha\f$ with a sparse
* \f$(mb \cdot \text{block_dim}) \times (nb \cdot \text{block_dim})\f$
* matrix, defined in BSR storage format, and the dense vector \f$x\f$ and adds the
* result to the dense vector \f$y\f$ that is multiplied by the scalar \f$\beta\f$,
* such that
* \f[
* y := \alpha \cdot op(A) \cdot x + \beta \cdot y,
* \f]
* with
* \f[
* op(A) = \left\{
* \begin{array}{ll}
* A, & \text{if trans == rocsparse_operation_none} \\
* A^T, & \text{if trans == rocsparse_operation_transpose} \\
* A^H, & \text{if trans == rocsparse_operation_conjugate_transpose}
* \end{array}
* \right.
* \f]
*
* \note
* This function is non blocking and executed asynchronously with respect to the host.
* It may return before the actual computation has finished.
*
* \note
* Currently, only \p trans == \ref rocsparse_operation_none is supported.
*
* \note
* This routine supports execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* dir matrix storage of BSR blocks.
* @param[in]
* trans matrix operation type.
* @param[in]
* mb number of block rows of the sparse BSR matrix.
* @param[in]
* nb number of block columns of the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero blocks of the sparse BSR matrix.
* @param[in]
* alpha scalar \f$\alpha\f$.
* @param[in]
* descr descriptor of the sparse BSR matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* bsr_val array of \p nnzb blocks of the sparse BSR matrix.
* @param[in]
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of
* the sparse BSR matrix.
* @param[in]
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse
* BSR matrix.
* @param[in]
* block_dim block dimension of the sparse BSR matrix.
* @param[in]
* x array of \p nb*block_dim elements (\f$op(A) = A\f$) or \p mb*block_dim
* elements (\f$op(A) = A^T\f$ or \f$op(A) = A^H\f$).
* @param[in]
* beta scalar \f$\beta\f$.
* @param[inout]
* y array of \p mb*block_dim elements (\f$op(A) = A\f$) or \p nb*block_dim
* elements (\f$op(A) = A^T\f$ or \f$op(A) = A^H\f$).
* @param[out]
* info structure that holds the information collected during the analysis step.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_size \p mb, \p nb, \p nnzb or \p block_dim is
* invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p bsr_val,
* \p bsr_row_ind, \p bsr_col_ind, \p x, \p beta or \p y pointer is invalid.
* \retval rocsparse_status_arch_mismatch the device is not supported.
* \retval rocsparse_status_not_implemented
* \p trans != \ref rocsparse_operation_none or
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*
* \par Example
* This example performs a sparse matrix vector multiplication in BSR format.
* \code{.c}
* // rocSPARSE handle
* rocsparse_handle handle;
* rocsparse_create_handle(&handle);
*
* // alpha * ( 1.0 0.0 2.0 ) * ( 1.0 ) + beta * ( 4.0 ) = ( 31.1 )
* // ( 3.0 0.0 4.0 ) * ( 2.0 ) ( 5.0 ) = ( 62.0 )
* // ( 5.0 6.0 0.0 ) * ( 3.0 ) ( 6.0 ) = ( 70.7 )
* // ( 7.0 0.0 8.0 ) * ( 7.0 ) = ( 123.8 )
*
* // BSR block dimension
* rocsparse_int bsr_dim = 2;
*
* // Number of block rows and columns
* rocsparse_int mb = 2;
* rocsparse_int nb = 2;
*
* // Number of non-zero blocks
* rocsparse_int nnzb = 4;
*
* // BSR row pointers
* rocsparse_int hbsr_row_ptr[3] = {0, 2, 4};
*
* // BSR column indices
* rocsparse_int hbsr_col_ind[4] = {0, 1, 0, 1};
*
* // BSR values
* double hbsr_val[16]
* = {1.0, 3.0, 0.0, 0.0, 2.0, 4.0, 0.0, 0.0, 5.0, 7.0, 6.0, 0.0, 0.0, 8.0, 0.0, 0.0};
*
* // Block storage in column major
* rocsparse_direction dir = rocsparse_direction_column;
*
* // Transposition of the matrix
* rocsparse_operation trans = rocsparse_operation_none;
*
* // Scalar alpha and beta
* double alpha = 3.7;
* double beta = 1.3;
*
* // x and y
* double hx[4] = {1.0, 2.0, 3.0, 0.0};
* double hy[4] = {4.0, 5.0, 6.0, 7.0};
*
* // Matrix descriptor
* rocsparse_mat_descr descr;
* rocsparse_create_mat_descr(&descr);
*
* // Offload data to device
* rocsparse_int* dbsr_row_ptr;
* rocsparse_int* dbsr_col_ind;
* double* dbsr_val;
* double* dx;
* double* dy;
*
* hipMalloc((void**)&dbsr_row_ptr, sizeof(rocsparse_int) * (mb + 1));
* hipMalloc((void**)&dbsr_col_ind, sizeof(rocsparse_int) * nnzb);
* hipMalloc((void**)&dbsr_val, sizeof(double) * nnzb * bsr_dim * bsr_dim);
* hipMalloc((void**)&dx, sizeof(double) * nb * bsr_dim);
* hipMalloc((void**)&dy, sizeof(double) * mb * bsr_dim);
*
* hipMemcpy(dbsr_row_ptr, hbsr_row_ptr, sizeof(rocsparse_int) * (mb + 1), hipMemcpyHostToDevice);
* hipMemcpy(dbsr_col_ind, hbsr_col_ind, sizeof(rocsparse_int) * nnzb, hipMemcpyHostToDevice);
* hipMemcpy(dbsr_val, hbsr_val, sizeof(double) * nnzb * bsr_dim * bsr_dim, hipMemcpyHostToDevice);
* hipMemcpy(dx, hx, sizeof(double) * nb * bsr_dim, hipMemcpyHostToDevice);
* hipMemcpy(dy, hy, sizeof(double) * mb * bsr_dim, hipMemcpyHostToDevice);
*
* rocsparse_mat_info info;
* rocsparse_create_mat_info(&info);
*
* // Call dbsrmv_analysis (Optional)
* rocsparse_dbsrmv_analysis(handle,
* dir,
* trans,
* mb,
* nb,
* nnzb,
* descr,
* dbsr_val,
* dbsr_row_ptr,
* dbsr_col_ind,
* bsr_dim,
* info);
*
* // Call dbsrmv to perform y = alpha * A x + beta * y
* rocsparse_dbsrmv(handle,
* dir,
* trans,
* mb,
* nb,
* nnzb,
* &alpha,
* descr,
* dbsr_val,
* dbsr_row_ptr,
* dbsr_col_ind,
* bsr_dim,
* info,
* dx,
* &beta,
* dy);
*
* // Copy result back to host
* hipMemcpy(hy, dy, sizeof(double) * mb * bsr_dim, hipMemcpyDeviceToHost);
*
* // Clear rocSPARSE
* rocsparse_destroy_mat_descr(descr);
* rocsparse_destroy_handle(handle);
* rocsparse_destroy_mat_info(info);
*
* // Clear device memory
* hipFree(dbsr_row_ptr);
* hipFree(dbsr_col_ind);
* hipFree(dbsr_val);
* hipFree(dx);
* hipFree(dy);
* \endcode
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sbsrmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const float* alpha,
const rocsparse_mat_descr descr,
const float* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const float* x,
const float* beta,
float* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dbsrmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const double* alpha,
const rocsparse_mat_descr descr,
const double* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const double* x,
const double* beta,
double* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cbsrmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_float_complex* alpha,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const rocsparse_float_complex* x,
const rocsparse_float_complex* beta,
rocsparse_float_complex* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zbsrmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int mb,
rocsparse_int nb,
rocsparse_int nnzb,
const rocsparse_double_complex* alpha,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
const rocsparse_double_complex* x,
const rocsparse_double_complex* beta,
rocsparse_double_complex* y);
/**@}*/
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using BSR storage format
*
* \details
* \p rocsparse_bsrmv_clear deallocates all memory that was allocated by
* rocsparse_sbsrmv_analysis(), rocsparse_dbsrmv_analysis(), rocsparse_cbsrmv_analysis()
* or rocsparse_zbsrmv_analysis(). This is especially useful, if memory is an issue and
* the analysis data is not required anymore for further computation, e.g. when
* switching to another sparse matrix format.
*
* \note
* Calling \p rocsparse_bsrmv_clear is optional. All allocated resources will be
* cleared, when the opaque \ref rocsparse_mat_info struct is destroyed using
* rocsparse_destroy_mat_info().
*
* \note
* This routine does not support execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[inout]
* info structure that holds the information collected during analysis step.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_pointer \p info pointer is invalid.
* \retval rocsparse_status_memory_error the buffer for the gathered information
* could not be deallocated.
* \retval rocsparse_status_internal_error an internal error occurred.
* */
ROCSPARSE_EXPORT
rocsparse_status rocsparse_bsrmv_clear(rocsparse_handle handle, rocsparse_mat_info info);
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_BSRMV_H */
|
