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
|
/*! \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_SPARSE_TO_SPARSE_H
#define ROCSPARSE_SPARSE_TO_SPARSE_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup generic_module
* \brief Sparse matrix to sparse matrix conversion.
*
* \details
* \p rocsparse_sparse_to_sparse_buffer_size calculates the required buffer size in bytes for a given stage \p stage.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* descr descriptor of the sparse_to_sparse algorithm.
* @param[in]
* source source sparse matrix descriptor.
* @param[in]
* target target sparse matrix descriptor.
* @param[in]
* stage stage of the sparse_to_sparse computation.
* @param[out]
* buffer_size_in_bytes size in bytes of the \p buffer
*
* \retval rocsparse_status_success the operation completed successfully.
* \retval rocsparse_status_invalid_handle the library context was not initialized.
* \retval rocsparse_status_invalid_value if any required enumeration is invalid.
* \retval rocsparse_status_invalid_pointer \p mat_A, \p mat_B, or \p buffer_size_in_bytes
* pointer is invalid.
*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sparse_to_sparse_buffer_size(rocsparse_handle handle,
rocsparse_sparse_to_sparse_descr descr,
rocsparse_const_spmat_descr source,
rocsparse_spmat_descr target,
rocsparse_sparse_to_sparse_stage stage,
size_t* buffer_size_in_bytes);
/*! \ingroup generic_module
* \brief Sparse matrix to sparse matrix conversion.
*
* \details
* \p rocsparse_sparse_to_sparse performs the conversion of a sparse matrix to a sparse matrix.
*
* \note
* The required allocation size (in bytes) to \p buffer_size_in_bytes must be obtained from \ref rocsparse_sparse_to_sparse_buffer_size
* for each stage, indeed the required buffer size can be different between stages.
*
* \note
* The format \ref rocsparse_format_bell is not supported.
*
* @param[in]
* handle handle to the rocsparse library context queue.
* @param[in]
* descr descriptor of the sparse_to_sparse algorithm.
* @param[in]
* source sparse matrix descriptor.
* @param[in]
* target sparse matrix descriptor.
* @param[in]
* stage stage of the sparse_to_sparse computation.
* @param[in]
* buffer_size_in_bytes size in bytes of the \p buffer
* @param[in]
* buffer temporary storage buffer allocated by the user.
*
* \retval rocsparse_status_success the operation completed successfully.
* \par Example
* This example converts a CSR matrix into an ELL matrix.
* \code{.c}
*
* // It assumes the CSR arrays (ptr, ind, val) have already been allocated and filled.
* // Build Source
* rocsparse_spmat_descr source;
* rocsparse_create_csr_descr(&source, M, N, nnz, ptr, ind, val, rocsparse_indextype_i32, rocsparse_indextype_i32, rocsparse_index_base_zero, rocsparse_datatype_f32_r);
*
* // Build target
* void * ell_ind, * ell_val;
* int64_t ell_width = 0;
* rocsparse_spmat_descr target;
* rocsparse_create_ell_descr(&target, M, N, ell_ind, ell_val, ell_width, rocsparse_indextype_i32, rocsparse_index_base_zero, rocsparse_datatype_f32_r);
*
* // Create descriptor
* rocsparse_sparse_to_sparse_descr descr;
* rocsparse_sparse_to_sparse_create_descr(&descr, source, target, rocsparse_sparse_to_sparse_alg_default);
*
* // Analysis phase
* rocsparse_sparse_to_sparse_buffer_size(handle, descr, source, target, rocsparse_sparse_to_sparse_stage_analysis, &buffer_size);
* hipMalloc(&buffer,buffer_size);
* rocsparse_sparse_to_sparse(handle, descr, source, target, rocsparse_sparse_to_sparse_stage_analysis, buffer_size, buffer);
* hipFree(buffer);
*
* //
* // the user is responsible to allocate target arrays after the analysis phase.
* //
* { int64_t rows, cols, ell_width;
* void * ind, * val;
* rocsparse_indextype idx_type;
* rocsparse_index_base idx_base;
* rocsparse_datatype data_type;
*
* rocsparse_ell_get(target,
* &rows,
* &cols,
* &ind,
* &val,
* &ell_width,
* &idx_type,
* &idx_base,
* &data_type);
* hipMalloc(&ell_ind,ell_width * M * sizeof(int32_t));
* hipMalloc(&ell_val,ell_width * M * sizeof(float)));
* rocsparse_ell_set_pointers(target, ell_ind, ell_val); }
*
* // Calculation phase
* rocsparse_sparse_to_sparse_buffer_size(handle, descr, source, target, rocsparse_sparse_to_sparse_stage_compute, &buffer_size);
* hipMalloc(&buffer,buffer_size);
* rocsparse_sparse_to_sparse(handle, descr, source, target, rocsparse_sparse_to_sparse_stage_compute, buffer_size, buffer);
* hipFree(buffer);
* \endcode
*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sparse_to_sparse(rocsparse_handle handle,
rocsparse_sparse_to_sparse_descr descr,
rocsparse_const_spmat_descr source,
rocsparse_spmat_descr target,
rocsparse_sparse_to_sparse_stage stage,
size_t buffer_size_in_bytes,
void* buffer);
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_SPARSE_TO_sparse_H */
|
