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
|
/*! \file */
/* ************************************************************************
* Copyright (C) 2023 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_CSRMV_H
#define ROCSPARSE_CSRMV_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using CSR storage format
*
* \details
* \p rocsparse_csrmv_analysis performs the analysis step for rocsparse_scsrmv(),
* rocsparse_dcsrmv(), rocsparse_ccsrmv() and rocsparse_zcsrmv(). 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_csrmv_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]
* trans matrix operation type.
* @param[in]
* m number of rows of the sparse CSR matrix.
* @param[in]
* n number of columns of the sparse CSR matrix.
* @param[in]
* nnz number of non-zero entries of the sparse CSR matrix.
* @param[in]
* descr descriptor of the sparse CSR matrix.
* @param[in]
* csr_val array of \p nnz elements of the sparse CSR matrix.
* @param[in]
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
* sparse CSR matrix.
* @param[in]
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
* CSR 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 m, \p n or \p nnz is invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p csr_val, \p csr_row_ptr,
* \p csr_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 if \ref rocsparse_matrix_type is not one of
* \ref rocsparse_matrix_type_general, \ref rocsparse_matrix_type_symmetric, or
* \ref rocsparse_matrix_type_triangular.
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_scsrmv_analysis(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_mat_descr descr,
const float* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dcsrmv_analysis(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_mat_descr descr,
const double* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_ccsrmv_analysis(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zcsrmv_analysis(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info);
/**@}*/
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using CSR storage format
*
* \details
* \p rocsparse_csrmv_clear deallocates all memory that was allocated by
* rocsparse_scsrmv_analysis(), rocsparse_dcsrmv_analysis(), rocsparse_ccsrmv_analysis()
* or rocsparse_zcsrmv_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_csrmv_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_csrmv_clear(rocsparse_handle handle, rocsparse_mat_info info);
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication using CSR storage format
*
* \details
* \p rocsparse_csrmv multiplies the scalar \f$\alpha\f$ with a sparse \f$m \times n\f$
* matrix, defined in CSR 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]
*
* The \p info parameter is optional and contains information collected by
* rocsparse_scsrmv_analysis(), rocsparse_dcsrmv_analysis(), rocsparse_ccsrmv_analysis()
* or rocsparse_zcsrmv_analysis(). If present, the information will be used to speed up
* the \p csrmv computation. If \p info == \p NULL, general \p csrmv routine will be
* used instead.
*
* \code{.c}
* for(i = 0; i < m; ++i)
* {
* y[i] = beta * y[i];
*
* for(j = csr_row_ptr[i]; j < csr_row_ptr[i + 1]; ++j)
* {
* y[i] = y[i] + alpha * csr_val[j] * x[csr_col_ind[j]];
* }
* }
* \endcode
*
* \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 supports execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* trans matrix operation type.
* @param[in]
* m number of rows of the sparse CSR matrix.
* @param[in]
* n number of columns of the sparse CSR matrix.
* @param[in]
* nnz number of non-zero entries of the sparse CSR matrix.
* @param[in]
* alpha scalar \f$\alpha\f$.
* @param[in]
* descr descriptor of the sparse CSR matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* csr_val array of \p nnz elements of the sparse CSR matrix.
* @param[in]
* csr_row_ptr array of \p m+1 elements that point to the start
* of every row of the sparse CSR matrix.
* @param[in]
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
* CSR matrix.
* @param[in]
* info information collected by rocsparse_scsrmv_analysis(),
* rocsparse_dcsrmv_analysis(), rocsparse_ccsrmv_analysis() or
* rocsparse_dcsrmv_analysis(), can be \p NULL if no information is
* available.
* @param[in]
* x array of \p n elements (\f$op(A) == A\f$) or \p m 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 m elements (\f$op(A) == A\f$) or \p n elements
* (\f$op(A) == A^T\f$ or \f$op(A) == A^H\f$).
*
* \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 m, \p n or \p nnz is invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p csr_val,
* \p csr_row_ptr, \p csr_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
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*
* \par Example
* This example performs a sparse matrix vector multiplication in CSR format
* using additional meta data to improve performance.
* \code{.c}
* // Create matrix info structure
* rocsparse_mat_info info;
* rocsparse_create_mat_info(&info);
*
* // Perform analysis step to obtain meta data
* rocsparse_scsrmv_analysis(handle,
* rocsparse_operation_none,
* m,
* n,
* nnz,
* descr,
* csr_val,
* csr_row_ptr,
* csr_col_ind,
* info);
*
* // Compute y = Ax
* rocsparse_scsrmv(handle,
* rocsparse_operation_none,
* m,
* n,
* nnz,
* &alpha,
* descr,
* csr_val,
* csr_row_ptr,
* csr_col_ind,
* info,
* x,
* &beta,
* y);
*
* // Do more work
* // ...
*
* // Clean up
* rocsparse_destroy_mat_info(info);
* \endcode
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_scsrmv(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const float* alpha,
const rocsparse_mat_descr descr,
const float* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info,
const float* x,
const float* beta,
float* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dcsrmv(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const double* alpha,
const rocsparse_mat_descr descr,
const double* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info,
const double* x,
const double* beta,
double* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_ccsrmv(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_float_complex* alpha,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info,
const rocsparse_float_complex* x,
const rocsparse_float_complex* beta,
rocsparse_float_complex* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zcsrmv(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_double_complex* alpha,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_mat_info info,
const rocsparse_double_complex* x,
const rocsparse_double_complex* beta,
rocsparse_double_complex* y);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_CSRMV_H */
|
