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
358 lines
14 KiB
C
358 lines
14 KiB
C
/*! \file */
|
|
/* ************************************************************************
|
|
* Copyright (C) 2025 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 HIPSPARSE_CSR2BSR_H
|
|
#define HIPSPARSE_CSR2BSR_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \ingroup conv_module
|
|
* \brief
|
|
* This function computes the number of non-zero block columns per row and the total number of non-zero blocks in a sparse
|
|
* BSR matrix, given a sparse CSR matrix as input.
|
|
*
|
|
* \details
|
|
* Consider the matrix:
|
|
* \f[
|
|
* \begin{bmatrix}
|
|
* 1 & 0 & 0 & 2 \\
|
|
* 3 & 4 & 0 & 0 \\
|
|
* 5 & 0 & 6 & 7 \\
|
|
* 1 & 2 & 3 & 4
|
|
* \end{bmatrix}
|
|
* \f]
|
|
*
|
|
* stored as a sparse CSR matrix. This function computes both the BSR row pointer array as well as the total number
|
|
* of non-zero blocks that results when converting the CSR matrix to the BSR format. Assuming a block dimension of 2,
|
|
* the above matrix, after conversion to the BSR format, looks like:
|
|
*
|
|
* \f[
|
|
* \left[
|
|
* \begin{array}{c | c}
|
|
* \begin{array}{c c}
|
|
* 1 & 0 \\
|
|
* 3 & 4
|
|
* \end{array} &
|
|
* \begin{array}{c c}
|
|
* 0 & 2 \\
|
|
* 0 & 0
|
|
* \end{array} \\
|
|
* \hline
|
|
* \begin{array}{c c}
|
|
* 5 & 0 \\
|
|
* 1 & 2
|
|
* \end{array} &
|
|
* \begin{array}{c c}
|
|
* 6 & 7 \\
|
|
* 3 & 4
|
|
* \end{array} \\
|
|
* \end{array}
|
|
* \right]
|
|
* \f]
|
|
*
|
|
* and the resulting BSR row pointer array and total non-zero blocks after \p hipsparseXcsr2bsrNnz has been called
|
|
* looks like:
|
|
*
|
|
* \f[
|
|
* \begin{align}
|
|
* \text{bsrRowPtrC} &= \begin{bmatrix} 0 & 2 & 4 \end{bmatrix} \\
|
|
* \text{bsrNnzb} &= 4
|
|
* \end{align}
|
|
* \f]
|
|
*
|
|
* In general, when converting a CSR matrix of size \p m x \p n to a BSR matrix, the resulting BSR matrix will have size
|
|
* \p mb x \p nb where \p mb and \p nb equal:
|
|
*
|
|
* \f[
|
|
* \begin{align}
|
|
* \text{mb} &= \text{(m - 1) / blockDim + 1} \\
|
|
* \text{nb} &= \text{(n - 1) / blockDim + 1}
|
|
* \end{align}
|
|
* \f]
|
|
*
|
|
* In particular, it can be the case that \p blockDim does not divide evenly into \p m and/or \p n. In these cases, the
|
|
* CSR matrix is expanded in size to fit full BSR blocks. For example, using the original CSR matrix and block
|
|
* dimension 3 instead of 2, the function \p hipsparseXcsr2bsrNnz computes the BSR row pointer array and total number of
|
|
* non-zero blocks for the BSR matrix:
|
|
*
|
|
* \f[
|
|
* \left[
|
|
* \begin{array}{c | c}
|
|
* \begin{array}{c c c}
|
|
* 1 & 0 & 0 \\
|
|
* 3 & 4 & 0 \\
|
|
* 5 & 0 & 6
|
|
* \end{array} &
|
|
* \begin{array}{c c c}
|
|
* 2 & 0 & 0 \\
|
|
* 0 & 0 & 0 \\
|
|
* 7 & 0 & 0
|
|
* \end{array} \\
|
|
* \hline
|
|
* \begin{array}{c c c}
|
|
* 1 & 2 & 3 \\
|
|
* 0 & 0 & 0 \\
|
|
* 0 & 0 & 0
|
|
* \end{array} &
|
|
* \begin{array}{c c c}
|
|
* 4 & 0 & 0 \\
|
|
* 0 & 0 & 0 \\
|
|
* 0 & 0 & 0
|
|
* \end{array} \\
|
|
* \end{array}
|
|
* \right]
|
|
* \f]
|
|
*
|
|
* See hipsparseScsr2bsr() for a full code example.
|
|
*
|
|
* \note
|
|
* The routine supports asynchronous execution if the pointer mode is set to device.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the hipSPARSE library context queue.
|
|
* @param[in]
|
|
* dirA direction that specifies whether to count non-zero elements by \ref HIPSPARSE_DIRECTION_ROW or by
|
|
* \ref HIPSPARSE_DIRECTION_COLUMN.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix. Must be non-negative.
|
|
* @param[in]
|
|
* n number of columns of the sparse CSR matrix.
|
|
* @param[in]
|
|
* descrA descriptor of the sparse CSR matrix. Currently, only \ref HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
|
|
* @param[in]
|
|
* csrRowPtrA integer array containing \p m+1 elements that points to the start of each row of the CSR matrix.
|
|
* @param[in]
|
|
* csrColIndA integer array of the column indices for each non-zero element in the CSR matrix.
|
|
* @param[in]
|
|
* blockDim the block dimension of the BSR matrix, which is between \f$1\f$ and \f$\min(m, n)\f$.
|
|
* @param[in]
|
|
* descrC descriptor of the sparse BSR matrix. Currently, only \ref HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
|
|
* @param[out]
|
|
* bsrRowPtrC integer array containing \p mb+1 elements that point to the start of each block row of the BSR matrix.
|
|
* @param[out]
|
|
* bsrNnzb total number of non-zero elements in device or host memory.
|
|
*
|
|
* \retval HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
|
|
* \retval HIPSPARSE_STATUS_INVALID_VALUE \p handle, \p m, \p n, \p blockDim, \p csrRowPtrA, \p csrColIndA,
|
|
* \p bsrRowPtrC, or \p bsrNnzb pointer is invalid.
|
|
*/
|
|
HIPSPARSE_EXPORT
|
|
hipsparseStatus_t hipsparseXcsr2bsrNnz(hipsparseHandle_t handle,
|
|
hipsparseDirection_t dirA,
|
|
int m,
|
|
int n,
|
|
const hipsparseMatDescr_t descrA,
|
|
const int* csrRowPtrA,
|
|
const int* csrColIndA,
|
|
int blockDim,
|
|
const hipsparseMatDescr_t descrC,
|
|
int* bsrRowPtrC,
|
|
int* bsrNnzb);
|
|
|
|
/*! \ingroup conv_module
|
|
* \brief Convert a sparse CSR matrix into a sparse BSR matrix.
|
|
*
|
|
* \details
|
|
* \p hipsparseXcsr2bsr completes the conversion of a CSR matrix into a BSR matrix.
|
|
* It is assumed that \p bsrValC, \p bsrColIndC, and \p bsrRowPtrC are allocated. The
|
|
* allocation size for \p bsrRowPtr is computed as \p mb+1, where \p mb is the number of
|
|
* block rows in the BSR matrix defined as:
|
|
*
|
|
* \f[
|
|
* \begin{align}
|
|
* \text{mb} &= \text{(m - 1) / blockDim + 1}
|
|
* \end{align}
|
|
* \f]
|
|
*
|
|
* The allocation size for \p bsrColIndC, that is, \p bsrNnzb, is computed using
|
|
* \ref hipsparseXcsr2bsrNnz(), which also fills the \p bsrRowPtrC array. The allocation size
|
|
* for \p bsrValC is then equal to:
|
|
*
|
|
* \f[
|
|
* \text{bsrNnzb * blockDim * blockDim}
|
|
* \f]
|
|
*
|
|
* For example, given the CSR matrix:
|
|
* \f[
|
|
* \begin{bmatrix}
|
|
* 1 & 0 & 0 & 2 \\
|
|
* 3 & 4 & 0 & 0 \\
|
|
* 5 & 0 & 6 & 7 \\
|
|
* 1 & 2 & 3 & 4
|
|
* \end{bmatrix}
|
|
* \f]
|
|
*
|
|
* The resulting BSR matrix using block dimension 2 would look like:
|
|
* \f[
|
|
* \left[
|
|
* \begin{array}{c | c}
|
|
* \begin{array}{c c}
|
|
* 1 & 0 \\
|
|
* 3 & 4
|
|
* \end{array} &
|
|
* \begin{array}{c c}
|
|
* 0 & 2 \\
|
|
* 0 & 0
|
|
* \end{array} \\
|
|
* \hline
|
|
* \begin{array}{c c}
|
|
* 5 & 0 \\
|
|
* 1 & 2
|
|
* \end{array} &
|
|
* \begin{array}{c c}
|
|
* 6 & 7 \\
|
|
* 3 & 4
|
|
* \end{array} \\
|
|
* \end{array}
|
|
* \right]
|
|
* \f]
|
|
*
|
|
* The call to \ref hipsparseXcsr2bsrNnz results in the BSR row pointer array:
|
|
* \f[
|
|
* \begin{align}
|
|
* \text{bsrRowPtrC} &= \begin{bmatrix} 0 & 2 & 4 \end{bmatrix} \\
|
|
* \end{align}
|
|
* \f]
|
|
*
|
|
* and the call to \p hipsparseXcsr2bsr completes the conversion resulting in the BSR column indices and values arrays:
|
|
* \f[
|
|
* \begin{align}
|
|
* \text{bsrColIndC} &= \begin{bmatrix} 0 & 1 & 0 & 1 \end{bmatrix} \\
|
|
* \text{bsrValC} &= \begin{bmatrix} 1 & 0 & 3 & 4 & 0 & 2 & 0 & 0 & 5 & 0 & 1 & 2 & 6 & 7 & 3 & 4 \end{bmatrix} \\
|
|
* \end{align}
|
|
* \f]
|
|
*
|
|
* The \p dirA parameter determines the order of the BSR block values. The example above uses row order. Using column ordering
|
|
* would result instead in the BSR values array:
|
|
*
|
|
* \f[
|
|
* \text{bsrValC} &= \begin{bmatrix} 1 & 3 & 0 & 4 & 0 & 0 & 2 & 0 & 5 & 1 & 0 & 2 & 6 & 3 & 7 & 4 \end{bmatrix} \\
|
|
* \f]
|
|
*
|
|
* \note
|
|
* \p hipsparseXcsr2bsr requires extra temporary storage that is allocated internally if
|
|
* \p blockDim > 16.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the hipSPARSE library context queue.
|
|
* @param[in]
|
|
* dirA the storage format of the blocks, \ref HIPSPARSE_DIRECTION_ROW or \ref HIPSPARSE_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]
|
|
* descrA descriptor of the sparse CSR matrix. Currently, only
|
|
* \ref HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
|
|
* @param[in]
|
|
* csrValA array of \p nnz elements containing the values of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csrRowPtrA array of \p m+1 elements that point to the start of every row of the
|
|
* sparse CSR matrix.
|
|
* @param[in]
|
|
* csrColIndA array of \p nnz elements containing the column indices of the sparse CSR matrix.
|
|
* @param[in]
|
|
* blockDim size of the blocks in the sparse BSR matrix.
|
|
* @param[in]
|
|
* descrC descriptor of the sparse BSR matrix. Currently, only
|
|
* \ref HIPSPARSE_MATRIX_TYPE_GENERAL is supported.
|
|
* @param[out]
|
|
* bsrValC array of \p nnzb*blockDim*blockDim containing the values of the sparse BSR matrix.
|
|
* @param[out]
|
|
* bsrRowPtrC array of \p mb+1 elements that point to the start of every block row of the
|
|
* sparse BSR matrix.
|
|
* @param[out]
|
|
* bsrColIndC array of \p nnzb elements containing the block column indices of the sparse BSR matrix.
|
|
*
|
|
* \retval HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
|
|
* \retval HIPSPARSE_STATUS_INVALID_VALUE \p handle, \p m, \p n, \p blockDim, \p bsrValC, \p bsrRowPtrC,
|
|
* \p bsrColIndC, \p csrValA, \p csrRowPtrA, or \p csrColIndA pointer is invalid.
|
|
*/
|
|
/**@{*/
|
|
HIPSPARSE_EXPORT
|
|
hipsparseStatus_t hipsparseScsr2bsr(hipsparseHandle_t handle,
|
|
hipsparseDirection_t dirA,
|
|
int m,
|
|
int n,
|
|
const hipsparseMatDescr_t descrA,
|
|
const float* csrValA,
|
|
const int* csrRowPtrA,
|
|
const int* csrColIndA,
|
|
int blockDim,
|
|
const hipsparseMatDescr_t descrC,
|
|
float* bsrValC,
|
|
int* bsrRowPtrC,
|
|
int* bsrColIndC);
|
|
HIPSPARSE_EXPORT
|
|
hipsparseStatus_t hipsparseDcsr2bsr(hipsparseHandle_t handle,
|
|
hipsparseDirection_t dirA,
|
|
int m,
|
|
int n,
|
|
const hipsparseMatDescr_t descrA,
|
|
const double* csrValA,
|
|
const int* csrRowPtrA,
|
|
const int* csrColIndA,
|
|
int blockDim,
|
|
const hipsparseMatDescr_t descrC,
|
|
double* bsrValC,
|
|
int* bsrRowPtrC,
|
|
int* bsrColIndC);
|
|
HIPSPARSE_EXPORT
|
|
hipsparseStatus_t hipsparseCcsr2bsr(hipsparseHandle_t handle,
|
|
hipsparseDirection_t dirA,
|
|
int m,
|
|
int n,
|
|
const hipsparseMatDescr_t descrA,
|
|
const hipComplex* csrValA,
|
|
const int* csrRowPtrA,
|
|
const int* csrColIndA,
|
|
int blockDim,
|
|
const hipsparseMatDescr_t descrC,
|
|
hipComplex* bsrValC,
|
|
int* bsrRowPtrC,
|
|
int* bsrColIndC);
|
|
|
|
HIPSPARSE_EXPORT
|
|
hipsparseStatus_t hipsparseZcsr2bsr(hipsparseHandle_t handle,
|
|
hipsparseDirection_t dirA,
|
|
int m,
|
|
int n,
|
|
const hipsparseMatDescr_t descrA,
|
|
const hipDoubleComplex* csrValA,
|
|
const int* csrRowPtrA,
|
|
const int* csrColIndA,
|
|
int blockDim,
|
|
const hipsparseMatDescr_t descrC,
|
|
hipDoubleComplex* bsrValC,
|
|
int* bsrRowPtrC,
|
|
int* bsrColIndC);
|
|
/**@}*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HIPSPARSE_CSR2BSR_H */
|