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
|
/*! \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_DOTI_H
#define ROCSPARSE_DOTI_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
extern "C" {
/*! \ingroup level1_module
* \brief Compute the dot product of a sparse vector with a dense vector.
*
* \details
* \p rocsparse_doti computes the dot product of the sparse vector \f$x\f$ with the
* dense vector \f$y\f$, such that
* \f[
* \text{result} := y^T x
* \f]
*
* \code{.c}
* result = 0
* for(i = 0; i < nnz; ++i)
* {
* result += x_val[i] * y[x_ind[i]];
* }
* \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]
* nnz number of non-zero entries of vector \f$x\f$.
* @param[in]
* x_val array of \p nnz values.
* @param[in]
* x_ind array of \p nnz elements containing the indices of the non-zero
* values of \f$x\f$.
* @param[in]
* y array of values in dense format.
* @param[out]
* result pointer to the result, can be host or device memory
* @param[in]
* idx_base \ref rocsparse_index_base_zero or \ref rocsparse_index_base_one.
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_value \p idx_base is invalid.
* \retval rocsparse_status_invalid_size \p nnz is invalid.
* \retval rocsparse_status_invalid_pointer \p x_val, \p x_ind, \p y or \p result
* pointer is invalid.
* \retval rocsparse_status_memory_error the buffer for the dot product reduction
* could not be allocated.
* \retval rocsparse_status_internal_error an internal error occurred.
*
* \par Example
* \code{.c}
* // Number of non-zeros of the sparse vector
* rocsparse_int nnz = 3;
*
* // Sparse index vector
* rocsparse_int hx_ind[3] = {0, 3, 5};
*
* // Sparse value vector
* float hx_val[3] = {1.0f, 2.0f, 3.0f};
*
* // Dense vector
* float hy[9] = {1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f};
*
* // Index base
* rocsparse_index_base idx_base = rocsparse_index_base_zero;
*
* // Offload data to device
* rocsparse_int* dx_ind;
* float* dx_val;
* float* dy;
*
* hipMalloc((void**)&dx_ind, sizeof(rocsparse_int) * nnz);
* hipMalloc((void**)&dx_val, sizeof(float) * nnz);
* hipMalloc((void**)&dy, sizeof(float) * 9);
*
* hipMemcpy(dx_ind, hx_ind, sizeof(rocsparse_int) * nnz, hipMemcpyHostToDevice);
* hipMemcpy(dx_val, hx_val, sizeof(float) * nnz, hipMemcpyHostToDevice);
* hipMemcpy(dy, hy, sizeof(float) * 9, hipMemcpyHostToDevice);
*
* // rocSPARSE handle
* rocsparse_handle handle;
* rocsparse_create_handle(&handle);
*
* // Call sdoti to compute the dot product
* float dot;
* rocsparse_sdoti(handle, nnz, dx_val, dx_ind, dy, &dot, idx_base);
*
* // Clear rocSPARSE
* rocsparse_destroy_handle(handle);
*
* // Clear device memory
* hipFree(dx_ind);
* hipFree(dx_val);
* hipFree(dy);
* \endcode
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sdoti(rocsparse_handle handle,
rocsparse_int nnz,
const float* x_val,
const rocsparse_int* x_ind,
const float* y,
float* result,
rocsparse_index_base idx_base);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_ddoti(rocsparse_handle handle,
rocsparse_int nnz,
const double* x_val,
const rocsparse_int* x_ind,
const double* y,
double* result,
rocsparse_index_base idx_base);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cdoti(rocsparse_handle handle,
rocsparse_int nnz,
const rocsparse_float_complex* x_val,
const rocsparse_int* x_ind,
const rocsparse_float_complex* y,
rocsparse_float_complex* result,
rocsparse_index_base idx_base);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zdoti(rocsparse_handle handle,
rocsparse_int nnz,
const rocsparse_double_complex* x_val,
const rocsparse_int* x_ind,
const rocsparse_double_complex* y,
rocsparse_double_complex* result,
rocsparse_index_base idx_base);
/**@}*/
}
#endif // ROCSPARSE_DOTI_H
|
