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
|
/*! \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_CSCSORT_H
#define ROCSPARSE_CSCSORT_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup conv_module
* \brief Sort a sparse CSC matrix
*
* \details
* \p rocsparse_cscsort_buffer_size returns the size of the temporary storage buffer
* required by rocsparse_cscsort(). 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]
* m number of rows of the sparse CSC matrix.
* @param[in]
* n number of columns of the sparse CSC matrix.
* @param[in]
* nnz number of non-zero entries of the sparse CSC matrix.
* @param[in]
* csc_col_ptr array of \p n+1 elements that point to the start of every column of
* the sparse CSC matrix.
* @param[in]
* csc_row_ind array of \p nnz elements containing the row indices of the sparse
* CSC matrix.
* @param[out]
* buffer_size number of bytes of the temporary storage buffer required by
* rocsparse_cscsort().
*
* \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 csc_col_ptr, \p csc_row_ind or
* \p buffer_size pointer is invalid.
*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cscsort_buffer_size(rocsparse_handle handle,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_int* csc_col_ptr,
const rocsparse_int* csc_row_ind,
size_t* buffer_size);
/*! \ingroup conv_module
* \brief Sort a sparse CSC matrix
*
* \details
* \p rocsparse_cscsort sorts a matrix in CSC format. The sorted permutation vector
* \p perm can be used to obtain sorted \p csc_val array. In this case, \p perm must be
* initialized as the identity permutation, see rocsparse_create_identity_permutation().
*
* \p rocsparse_cscsort requires extra temporary storage buffer that has to be allocated by
* the user. Storage buffer size can be determined by rocsparse_cscsort_buffer_size().
*
* \note
* \p perm can be \p NULL if a sorted permutation vector is not required.
*
* \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]
* m number of rows of the sparse CSC matrix.
* @param[in]
* n number of columns of the sparse CSC matrix.
* @param[in]
* nnz number of non-zero entries of the sparse CSC matrix.
* @param[in]
* descr descriptor of the sparse CSC matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* csc_col_ptr array of \p n+1 elements that point to the start of every column of
* the sparse CSC matrix.
* @param[inout]
* csc_row_ind array of \p nnz elements containing the row indices of the sparse
* CSC matrix.
* @param[inout]
* perm array of \p nnz integers containing the unsorted map indices, can be
* \p NULL.
* @param[in]
* temp_buffer temporary storage buffer allocated by the user, size is returned by
* rocsparse_cscsort_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 descr, \p csc_col_ptr, \p csc_row_ind
* or \p temp_buffer pointer is invalid.
* \retval rocsparse_status_internal_error an internal error occurred.
* \retval rocsparse_status_not_implemented
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*
* \par Example
* The following example sorts a \f$3 \times 3\f$ CSC matrix.
* \code{.c}
* // 1 2 3
* // A = 4 5 6
* // 7 8 9
* rocsparse_int m = 3;
* rocsparse_int n = 3;
* rocsparse_int nnz = 9;
*
* csc_col_ptr[m + 1] = {0, 3, 6, 9}; // device memory
* csc_row_ind[nnz] = {2, 0, 1, 0, 1, 2, 0, 2, 1}; // device memory
* csc_val[nnz] = {7, 1, 4, 2, 5, 8, 3, 9, 6}; // device memory
*
* // Create permutation vector perm as the identity map
* rocsparse_int* perm;
* hipMalloc((void**)&perm, sizeof(rocsparse_int) * nnz);
* rocsparse_create_identity_permutation(handle, nnz, perm);
*
* // Allocate temporary buffer
* size_t buffer_size;
* void* temp_buffer;
* rocsparse_cscsort_buffer_size(handle, m, n, nnz, csc_col_ptr, csc_row_ind, &buffer_size);
* hipMalloc(&temp_buffer, buffer_size);
*
* // Sort the CSC matrix
* rocsparse_cscsort(handle, m, n, nnz, descr, csc_col_ptr, csc_row_ind, perm, temp_buffer);
*
* // Gather sorted csc_val array
* float* csc_val_sorted;
* hipMalloc((void**)&csc_val_sorted, sizeof(float) * nnz);
* rocsparse_sgthr(handle, nnz, csc_val, csc_val_sorted, perm, rocsparse_index_base_zero);
*
* // Clean up
* hipFree(temp_buffer);
* hipFree(perm);
* hipFree(csc_val);
* \endcode
*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cscsort(rocsparse_handle handle,
rocsparse_int m,
rocsparse_int n,
rocsparse_int nnz,
const rocsparse_mat_descr descr,
const rocsparse_int* csc_col_ptr,
rocsparse_int* csc_row_ind,
rocsparse_int* perm,
void* temp_buffer);
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_CSCSORT_H */
|
