derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
238 lines
12 KiB
C
238 lines
12 KiB
C
/*! \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_CSR2BSR_H
|
|
#define ROCSPARSE_CSR2BSR_H
|
|
|
|
#include "../../rocsparse-types.h"
|
|
#include "rocsparse/rocsparse-export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/*! \ingroup conv_module
|
|
* \details
|
|
* This function takes a sparse CSR matrix as input and computes the block row offset array, \p bsr_row_ptr,
|
|
* and the total number of non-zero blocks, \p bsr_nnz, that will result from converting the CSR format input
|
|
* matrix to a BSR format output matrix. This function is the first step in the conversion and is used in
|
|
* conjunction with \ref rocsparse_scsr2bsr "rocsparse_Xcsr2bsr()".
|
|
*
|
|
* \note
|
|
* The routine supports asynchronous execution if the pointer mode is set to device.
|
|
*
|
|
* \note
|
|
* This routine does not support execution in a hipGraph context.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the rocSPARSE library context queue.
|
|
*
|
|
* @param[in]
|
|
* dir direction that specifies whether to count non-zero elements by \ref rocsparse_direction_row or by
|
|
* \ref rocsparse_direction_column.
|
|
*
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix.
|
|
*
|
|
* @param[in]
|
|
* n number of columns of the sparse CSR matrix.
|
|
*
|
|
* @param[in]
|
|
* csr_descr descriptor of the sparse CSR matrix. Currently, only
|
|
* \ref rocsparse_matrix_type_general is supported.
|
|
* @param[in]
|
|
* csr_row_ptr integer array containing \p m+1 elements that point to the start of each row of the CSR matrix.
|
|
*
|
|
* @param[in]
|
|
* csr_col_ind integer array of the column indices for each non-zero element in the CSR matrix.
|
|
*
|
|
* @param[in]
|
|
* block_dim the block dimension of the BSR matrix. Between 1 and min(m, n).
|
|
*
|
|
* @param[in]
|
|
* bsr_descr descriptor of the sparse BSR matrix. Currently, only
|
|
* \ref rocsparse_matrix_type_general is supported.
|
|
* @param[out]
|
|
* bsr_row_ptr integer array containing \p mb+1 elements that point to the start of each block row of the BSR matrix.
|
|
*
|
|
* @param[out]
|
|
* bsr_nnz total number of non-zero elements in device or host memory.
|
|
*
|
|
* \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 block_dim is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p csr_row_ptr, \p csr_col_ind, \p bsr_row_ptr, or \p bsr_nnz
|
|
* pointer is invalid.
|
|
*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_csr2bsr_nnz(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_mat_descr csr_descr,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_int block_dim,
|
|
const rocsparse_mat_descr bsr_descr,
|
|
rocsparse_int* bsr_row_ptr,
|
|
rocsparse_int* bsr_nnz);
|
|
|
|
/*! \ingroup conv_module
|
|
* \brief Convert a sparse CSR matrix into a sparse BSR matrix.
|
|
*
|
|
* \details
|
|
* \p rocsparse_csr2bsr converts a CSR matrix into a BSR matrix. It is assumed
|
|
* that \p bsr_val, \p bsr_col_ind, and \p bsr_row_ptr are allocated. The allocation size
|
|
* for \p bsr_row_ptr is computed as \p mb+1, where \p mb is the number of block rows
|
|
* and \p nb is the number of block columns in the BSR matrix:
|
|
* \f[
|
|
* mb = (m + block\_dim - 1) / block\_dim \\
|
|
* nb = (n + block\_dim - 1) / block\_dim
|
|
* \f]
|
|
* The allocation size for \p bsr_val and \p bsr_col_ind is computed using \ref rocsparse_csr2bsr_nnz(),
|
|
* which also fills in \p bsr_row_ptr.
|
|
*
|
|
* Converting from a sparse CSR matrix to a sparse BSR matrix requires two steps. First,
|
|
* allocate the \p bsr_row_ptr array to have length \p mb+1 and pass this to the function
|
|
* \ref rocsparse_csr2bsr_nnz. This will fill the \p bsr_row_ptr array and also compute the total
|
|
* number of non-zero blocks in the BSR matrix. Now that the total number of non-zero blocks is known,
|
|
* allocate the \p bsr_col_ind and \p bsr_val arrays. Finally, call
|
|
* \p rocsparse_csr2bsr to complete the conversion. See the example below.
|
|
*
|
|
* \p rocsparse_csr2bsr requires extra temporary storage that is allocated internally if \p block_dim>16.
|
|
*
|
|
* \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]
|
|
* dir the storage format of the blocks, \ref rocsparse_direction_row or \ref rocsparse_direction_column.
|
|
* @param[in]
|
|
* m number of rows in the sparse CSR matrix.
|
|
* @param[in]
|
|
* n number of columns in the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_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 containing the values 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]
|
|
* block_dim size of the blocks in the sparse BSR matrix.
|
|
* @param[in]
|
|
* bsr_descr descriptor of the sparse BSR matrix. Currently, only
|
|
* \ref rocsparse_matrix_type_general is supported.
|
|
* @param[out]
|
|
* bsr_val array of \p nnzb*block_dim*block_dim containing the values of the sparse BSR matrix.
|
|
* @param[out]
|
|
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of the
|
|
* sparse BSR matrix.
|
|
* @param[out]
|
|
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse BSR matrix.
|
|
*
|
|
* \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 block_dim is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p bsr_val,
|
|
* \p bsr_row_ptr, \p bsr_col_ind, \p csr_val, \p csr_row_ptr, or
|
|
* \p csr_col_ind pointer is invalid.
|
|
*
|
|
* \par Example
|
|
* This example converts a CSR matrix into an BSR matrix.
|
|
* \snippet example_rocsparse_csr2bsr.cpp doc example
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsr2bsr(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_mat_descr csr_descr,
|
|
const float* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_int block_dim,
|
|
const rocsparse_mat_descr bsr_descr,
|
|
float* bsr_val,
|
|
rocsparse_int* bsr_row_ptr,
|
|
rocsparse_int* bsr_col_ind);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsr2bsr(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_mat_descr csr_descr,
|
|
const double* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_int block_dim,
|
|
const rocsparse_mat_descr bsr_descr,
|
|
double* bsr_val,
|
|
rocsparse_int* bsr_row_ptr,
|
|
rocsparse_int* bsr_col_ind);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsr2bsr(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_mat_descr csr_descr,
|
|
const rocsparse_float_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_int block_dim,
|
|
const rocsparse_mat_descr bsr_descr,
|
|
rocsparse_float_complex* bsr_val,
|
|
rocsparse_int* bsr_row_ptr,
|
|
rocsparse_int* bsr_col_ind);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsr2bsr(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_mat_descr csr_descr,
|
|
const rocsparse_double_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_int block_dim,
|
|
const rocsparse_mat_descr bsr_descr,
|
|
rocsparse_double_complex* bsr_val,
|
|
rocsparse_int* bsr_row_ptr,
|
|
rocsparse_int* bsr_col_ind);
|
|
/**@}*/
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ROCSPARSE_CSR2BSR_H */
|