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
|
/*! \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_GEMVI_H
#define ROCSPARSE_GEMVI_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup level2_module
* \brief Dense matrix sparse vector multiplication
*
* \details
* \p rocsparse_gemvi_buffer_size returns the size of the temporary storage buffer
* required by rocsparse_sgemvi(), rocsparse_dgemvi(), rocsparse_cgemvi() or
* rocsparse_zgemvi(). The temporary storage buffer must be allocated by the user.
*
* \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 dense matrix.
* @param[in]
* n number of columns of the dense matrix.
* @param[in]
* nnz number of non-zero entries in the sparse vector.
* @param[out]
* buffer_size temporary storage buffer size.
*
* \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 buffer_size pointer is invalid.
* \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_sgemvi_buffer_size(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
size_t* buffer_size);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dgemvi_buffer_size(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
size_t* buffer_size);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cgemvi_buffer_size(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
size_t* buffer_size);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zgemvi_buffer_size(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
size_t* buffer_size);
/**@}*/
/*! \ingroup level2_module
* \brief Dense matrix sparse vector multiplication
*
* \details
* \p rocsparse_gemvi multiplies the scalar \f$\alpha\f$ with a dense \f$m \times n\f$
* matrix \f$A\f$ and the sparse 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]
*
* \p rocsparse_gemvi requires a user allocated temporary buffer. Its size is returned
* by rocsparse_sgemvi_buffer_size(), rocsparse_dgemvi_buffer_size(),
* rocsparse_cgemvi_buffer_size() or rocsparse_zgemvi_buffer_size().
*
* \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]
* trans matrix operation type.
* @param[in]
* m number of rows of the dense matrix.
* @param[in]
* n number of columns of the dense matrix.
* @param[in]
* alpha scalar \f$\alpha\f$.
* @param[in]
* A pointer to the dense matrix.
* @param[in]
* lda leading dimension of the dense matrix
* @param[in]
* nnz number of non-zero entries in the sparse vector
* @param[in]
* x_val array of \p nnz elements containing the values of the sparse vector
* @param[in]
* x_ind array of \p nnz elements containing the indices of the sparse vector
* @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$).
* @param[in]
* idx_base rocsparse_index_base_zero or rocsparse_index_base_one.
* @param[in]
* temp_buffer temporary storage buffer
*
* \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, \p lda or \p nnz is invalid.
* \retval rocsparse_status_invalid_pointer \p alpha, \p A, \p x_val, \p x_ind,
* \p beta, \p y or \p temp_buffer pointer is invalid.
* \retval rocsparse_status_not_implemented
* \p trans != \ref rocsparse_operation_none or
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*
* \par Example
* \code{.c}
* // rocSPARSE handle
* rocsparse_handle handle;
* rocsparse_create_handle(&handle);
*
* rocsparse_mat_descr descr;
* rocsparse_create_mat_descr(&descr);
*
* // Number of rows and columns
* rocsparse_int m = 3;
* rocsparse_int n = 5;
*
* // Dense matrix A in column-major
* rocsparse_int lda = m;
* double hA[15] = {9, 14, 19, 10, 15, 20, 11, 16, 21, 12, 17, 22, 13, 18, 23};
*
* // Number of non-zero entries
* rocsparse_int nnz = 3;
*
* // Vector x indices
* rocsparse_int hx_ind[3] = {0, 1, 3};
*
* // Vector x values
* double hx_val[3] = {1, 2, 3};
*
* // Vector y values
* double hy[3] = {4, 5, 6};
*
* // Scalar alpha and beta
* double alpha = 3.7;
* double beta = 1.3;
*
* // Matrix operation
* rocsparse_operation trans = rocsparse_operation_none;
*
* // Index base
* rocsparse_index_base base = rocsparse_index_base_zero;
*
* // Offload data to device
* double* dA;
* rocsparse_int* dx_ind;
* double* dx_val;
* double* dy;
* hipMalloc((void**)&dA, sizeof(double) * m * n);
* hipMalloc((void**)&dx_ind, sizeof(rocsparse_int) * nnz);
* hipMalloc((void**)&dx_val, sizeof(double) * nnz);
* hipMalloc((void**)&dy, sizeof(double) * m);
*
* hipMemcpy(dA, hA, sizeof(double) * m * n, hipMemcpyHostToDevice);
* hipMemcpy(dx_ind, hx_ind, sizeof(rocsparse_int) * nnz, hipMemcpyHostToDevice);
* hipMemcpy(dx_val, hx_val, sizeof(double) * nnz, hipMemcpyHostToDevice);
* hipMemcpy(dy, hy, sizeof(double) * m, hipMemcpyHostToDevice);
*
* // Obtain buffer size
* size_t buffer_size;
* rocsparse_dgemvi_buffer_size(handle, trans, m, n, nnz, &buffer_size);
*
* void* buffer;
* hipMalloc(&buffer, buffer_size);
*
* // Call dgemvi
* rocsparse_dgemvi(handle, trans, m, n, &alpha, dA, lda, nnz, dx_val, dx_ind, &beta, dy, base, buffer);
*
* // Copy result back to host
* hipMemcpy(hy, dy, sizeof(double) * m, hipMemcpyDeviceToHost);
*
* // Clear rocSPARSE
* rocsparse_destroy_handle(handle);
*
* // Clear device memory
* hipFree(dA);
* hipFree(dx_ind);
* hipFree(dx_val);
* hipFree(dy);
* hipFree(buffer);
* \endcode
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sgemvi(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
const float* alpha,
const float* A,
rocsparse_int lda,
rocsparse_int nnz,
const float* x_val,
const rocsparse_int* x_ind,
const float* beta,
float* y,
rocsparse_index_base idx_base,
void* temp_buffer);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dgemvi(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
const double* alpha,
const double* A,
rocsparse_int lda,
rocsparse_int nnz,
const double* x_val,
const rocsparse_int* x_ind,
const double* beta,
double* y,
rocsparse_index_base idx_base,
void* temp_buffer);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cgemvi(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
const rocsparse_float_complex* alpha,
const rocsparse_float_complex* A,
rocsparse_int lda,
rocsparse_int nnz,
const rocsparse_float_complex* x_val,
const rocsparse_int* x_ind,
const rocsparse_float_complex* beta,
rocsparse_float_complex* y,
rocsparse_index_base idx_base,
void* temp_buffer);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zgemvi(rocsparse_handle handle,
rocsparse_operation trans,
rocsparse_int m,
rocsparse_int n,
const rocsparse_double_complex* alpha,
const rocsparse_double_complex* A,
rocsparse_int lda,
rocsparse_int nnz,
const rocsparse_double_complex* x_val,
const rocsparse_int* x_ind,
const rocsparse_double_complex* beta,
rocsparse_double_complex* y,
rocsparse_index_base idx_base,
void* temp_buffer);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_GEMVI_H */
|
