Files
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
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

344 lines
17 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_CSR2CSC_H
#define HIPSPARSE_CSR2CSC_H
#ifdef __cplusplus
extern "C" {
#endif
#if(!defined(CUDART_VERSION) || CUDART_VERSION < 11000)
/*! \ingroup conv_module
* \brief Convert a sparse CSR matrix into a sparse CSC matrix.
*
* \details
* \p hipsparseXcsr2csc converts a CSR matrix into a CSC matrix. \p hipsparseXcsr2csc
* can also be used to convert a CSC matrix into a CSR matrix. \p copyValues decides
* whether \p cscSortedVal is being filled during conversion (\ref HIPSPARSE_ACTION_NUMERIC)
* or not (\ref HIPSPARSE_ACTION_SYMBOLIC).
*
* For example given the matrix:
* \f[
* \begin{bmatrix}
* 1 & 0 & 0 & 2 \\
* 3 & 4 & 0 & 0 \\
* 5 & 0 & 6 & 7
* \end{bmatrix}
* \f]
*
* Represented using the sparse CSR format as:
* \f[
* \begin{align}
* \text{csrSortedRowPtr} &= \begin{bmatrix} 0 & 2 & 4 & 7 \end{bmatrix} \\
* \text{csrSortedColInd} &= \begin{bmatrix} 0 & 3 & 0 & 1 & 0 & 2 & 3 \end{bmatrix} \\
* \text{csrSortedVal} &= \begin{bmatrix} 1 & 2 & 3 & 4 & 5 & 6 & 7 \end{bmatrix}
* \end{align}
* \f]
*
* this function converts it to the sparse CSC format:
* \f[
* \begin{align}
* \text{cscSortedRowInd} &= \begin{bmatrix} 0 & 1 & 2 & 1 & 2 & 0 & 2 \end{bmatrix} \\
* \text{cscSortedColPtr} &= \begin{bmatrix} 0 & 3 & 4 & 5 & 7 \end{bmatrix} \\
* \text{cscSortedVal} &= \begin{bmatrix} 1 & 3 & 5 & 4 & 6 & 2 & 7 \end{bmatrix}
* \end{align}
* \f]
*
* The CSC arrays \p cscSortedRowInd, \p cscSortedColPtr, and \p cscSortedVal must be allocated by the
* user prior to calling \p hipsparseXcsr2csc().
*
* \note
* The resulting matrix can also be seen as the transpose of the input matrix.
*
* \note
* This function is non-blocking and executed asynchronously with respect to the host.
* It can return before the actual computation has finished.
*
* \deprecated
* This function is deprecated when using the CUDA backend (CUDA 10.0+) and will be
* removed in CUDA 11.0. This deprecation does not apply to the ROCm backend.
*
* @param[in]
* handle handle to the hipSPARSE library context queue.
* @param[in]
* m number of rows of the sparse CSR matrix, which must be non-negative.
* @param[in]
* n number of columns of the sparse CSR matrix, which must be non-negative.
* @param[in]
* nnz number of non-zero entries of the sparse CSR matrix, which must be non-negative.
* @param[in]
* csrSortedVal array of \p nnz elements of the sparse CSR matrix.
* @param[in]
* csrSortedRowPtr array of \p m+1 elements that point to the start of every row of the
* sparse CSR matrix.
* @param[in]
* csrSortedColInd array of \p nnz elements containing the column indices of the sparse
* CSR matrix.
* @param[out]
* cscSortedVal array of \p nnz elements of the sparse CSC matrix.
* @param[out]
* cscSortedRowInd array of \p nnz elements containing the row indices of the sparse CSC
* matrix.
* @param[out]
* cscSortedColPtr array of \p n+1 elements that point to the start of every column of the
* sparse CSC matrix.
* @param[in]
* copyValues \ref HIPSPARSE_ACTION_SYMBOLIC or \ref HIPSPARSE_ACTION_NUMERIC.
* @param[in]
* idxBase index base. \ref HIPSPARSE_INDEX_BASE_ZERO for zero-based indexing or
* \ref HIPSPARSE_INDEX_BASE_ONE for one-based indexing.
*
* \retval HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
* \retval HIPSPARSE_STATUS_NOT_INITIALIZED \p handle is not initialized.
* \retval HIPSPARSE_STATUS_INVALID_VALUE \p handle is nullptr, \p m, \p n, or \p nnz is negative,
* \p csrSortedVal, \p csrSortedRowPtr, \p csrSortedColInd, \p cscSortedVal, \p cscSortedRowInd,
* or \p cscSortedColPtr is nullptr when \p nnz is greater than zero, \p copyValues is neither
* \ref HIPSPARSE_ACTION_SYMBOLIC nor \ref HIPSPARSE_ACTION_NUMERIC, or \p idxBase is neither
* \ref HIPSPARSE_INDEX_BASE_ZERO nor \ref HIPSPARSE_INDEX_BASE_ONE.
* \retval HIPSPARSE_STATUS_ARCH_MISMATCH the device is not supported.
* \retval HIPSPARSE_STATUS_INTERNAL_ERROR an internal error occurred.
*
*/
/**@{*/
DEPRECATED_CUDA_10000("The routine will be removed in CUDA 11")
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseScsr2csc(hipsparseHandle_t handle,
int m,
int n,
int nnz,
const float* csrSortedVal,
const int* csrSortedRowPtr,
const int* csrSortedColInd,
float* cscSortedVal,
int* cscSortedRowInd,
int* cscSortedColPtr,
hipsparseAction_t copyValues,
hipsparseIndexBase_t idxBase);
DEPRECATED_CUDA_10000("The routine will be removed in CUDA 11")
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseDcsr2csc(hipsparseHandle_t handle,
int m,
int n,
int nnz,
const double* csrSortedVal,
const int* csrSortedRowPtr,
const int* csrSortedColInd,
double* cscSortedVal,
int* cscSortedRowInd,
int* cscSortedColPtr,
hipsparseAction_t copyValues,
hipsparseIndexBase_t idxBase);
DEPRECATED_CUDA_10000("The routine will be removed in CUDA 11")
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseCcsr2csc(hipsparseHandle_t handle,
int m,
int n,
int nnz,
const hipComplex* csrSortedVal,
const int* csrSortedRowPtr,
const int* csrSortedColInd,
hipComplex* cscSortedVal,
int* cscSortedRowInd,
int* cscSortedColPtr,
hipsparseAction_t copyValues,
hipsparseIndexBase_t idxBase);
DEPRECATED_CUDA_10000("The routine will be removed in CUDA 11")
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseZcsr2csc(hipsparseHandle_t handle,
int m,
int n,
int nnz,
const hipDoubleComplex* csrSortedVal,
const int* csrSortedRowPtr,
const int* csrSortedColInd,
hipDoubleComplex* cscSortedVal,
int* cscSortedRowInd,
int* cscSortedColPtr,
hipsparseAction_t copyValues,
hipsparseIndexBase_t idxBase);
/**@}*/
#endif
#if(!defined(CUDART_VERSION) || CUDART_VERSION >= 10010)
/*! \ingroup conv_module
* \brief This function computes the size of the user-allocated temporary storage buffer used
* when converting a sparse CSR matrix into a sparse CSC matrix.
*
* \details
* \p hipsparseCsr2cscEx2_bufferSize calculates the required user allocated temporary buffer needed
* by \ref hipsparseCsr2cscEx2 to convert a CSR matrix into a CSC matrix. \ref hipsparseCsr2cscEx2
* can also be used to convert a CSC matrix into a CSR matrix. \p copyValues decides
* whether \p cscVal is being filled during conversion (\ref HIPSPARSE_ACTION_NUMERIC)
* or not (\ref HIPSPARSE_ACTION_SYMBOLIC).
*
* \note
* The resulting matrix can also be seen as the transpose of the input matrix.
*
* \note
* This function is non-blocking and executed asynchronously with respect to the host.
* It can return before the actual computation has finished.
*
* @param[in]
* handle handle to the hipSPARSE library context queue.
* @param[in]
* m number of rows of the sparse CSR matrix.
* @param[in]
* n number of columns of the sparse CSR matrix.
* @param[in]
* nnz number of non-zero entries of the sparse CSR matrix.
* @param[in]
* csrVal array of \p nnz elements of the sparse CSR matrix.
* @param[in]
* csrRowPtr array of \p m+1 elements that point to the start of every row of the
* sparse CSR matrix.
* @param[in]
* csrColInd array of \p nnz elements containing the column indices of the sparse
* CSR matrix.
* @param[in]
* cscVal array of \p nnz elements of the sparse CSC matrix.
* @param[in]
* cscColPtr array of \p n+1 elements that point to the start of every column of the
* sparse CSC matrix.
* @param[in]
* cscRowInd array of \p nnz elements containing the row indices of the sparse
* CSC matrix.
* @param[in]
* valType The data type of the values arrays \p csrVal and \p cscVal. Can be HIP_R_32F,
* HIP_R_64F, HIP_C_32F, or HIP_C_64F.
* @param[in]
* copyValues \ref HIPSPARSE_ACTION_SYMBOLIC or \ref HIPSPARSE_ACTION_NUMERIC.
* @param[in]
* idxBase \ref HIPSPARSE_INDEX_BASE_ZERO or \ref HIPSPARSE_INDEX_BASE_ONE.
* @param[in]
* alg HIPSPARSE_CSR2CSC_ALG_DEFAULT, HIPSPARSE_CSR2CSC_ALG1, or HIPSPARSE_CSR2CSC_ALG2.
* @param[out]
* pBufferSizeInBytes number of bytes of the temporary storage buffer required by
* hipsparseCsr2cscEx2().
*
* \retval HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
* \retval HIPSPARSE_STATUS_INVALID_VALUE \p handle, \p m, \p n, \p nnz, \p csrRowPtr, \p csrColInd, or
* \p pBufferSizeInBytes pointer is invalid.
* \retval HIPSPARSE_STATUS_INTERNAL_ERROR an internal error occurred.
*/
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseCsr2cscEx2_bufferSize(hipsparseHandle_t handle,
int m,
int n,
int nnz,
const void* csrVal,
const int* csrRowPtr,
const int* csrColInd,
void* cscVal,
int* cscColPtr,
int* cscRowInd,
hipDataType valType,
hipsparseAction_t copyValues,
hipsparseIndexBase_t idxBase,
hipsparseCsr2CscAlg_t alg,
size_t* pBufferSizeInBytes);
#endif
#if(!defined(CUDART_VERSION) || CUDART_VERSION >= 10010)
/*! \ingroup conv_module
* \brief Convert a sparse CSR matrix into a sparse CSC matrix.
*
* \details
* \p hipsparseCsr2cscEx2 converts a CSR matrix into a CSC matrix. \p hipsparseCsr2cscEx2
* can also be used to convert a CSC matrix into a CSR matrix. \p copyValues decides
* whether \p cscVal is being filled during conversion (\ref HIPSPARSE_ACTION_NUMERIC)
* or not (\ref HIPSPARSE_ACTION_SYMBOLIC).
*
* \note
* The resulting matrix can also be seen as the transpose of the input matrix.
*
* \note
* This function is non-blocking and executed asynchronously with respect to the host.
* It can return before the actual computation has finished.
*
* @param[in]
* handle handle to the hipSPARSE library context queue.
* @param[in]
* m number of rows of the sparse CSR matrix.
* @param[in]
* n number of columns of the sparse CSR matrix.
* @param[in]
* nnz number of non-zero entries of the sparse CSR matrix.
* @param[in]
* csrVal array of \p nnz elements of the sparse CSR matrix.
* @param[in]
* csrRowPtr array of \p m+1 elements that point to the start of every row of the
* sparse CSR matrix.
* @param[in]
* csrColInd array of \p nnz elements containing the column indices of the sparse
* CSR matrix.
* @param[in]
* cscVal array of \p nnz elements of the sparse CSC matrix.
* @param[in]
* cscColPtr array of \p n+1 elements that point to the start of every column of the
* sparse CSC matrix.
* @param[in]
* cscRowInd array of \p nnz elements containing the row indices of the sparse
* CSC matrix.
* @param[in]
* valType The data type of the values arrays \p csrVal and \p cscVal. Can be HIP_R_32F,
* HIP_R_64F, HIP_C_32F, or HIP_C_64F.
* @param[in]
* copyValues \ref HIPSPARSE_ACTION_SYMBOLIC or \ref HIPSPARSE_ACTION_NUMERIC.
* @param[in]
* idxBase \ref HIPSPARSE_INDEX_BASE_ZERO or \ref HIPSPARSE_INDEX_BASE_ONE.
* @param[in]
* alg HIPSPARSE_CSR2CSC_ALG_DEFAULT, HIPSPARSE_CSR2CSC_ALG1 or HIPSPARSE_CSR2CSC_ALG2.
* @param[in]
* buffer temporary storage buffer allocated by the user. The size is returned by
* hipsparseCsr2cscEx2_bufferSize().
*
* \retval HIPSPARSE_STATUS_SUCCESS the operation completed successfully.
* \retval HIPSPARSE_STATUS_INVALID_VALUE \p handle, \p m, \p n, \p nnz, \p csrRowPtr, \p csrColInd, or
* \p pBufferSizeInBytes pointer is invalid.
* \retval HIPSPARSE_STATUS_INTERNAL_ERROR an internal error occurred.
*/
HIPSPARSE_EXPORT
hipsparseStatus_t hipsparseCsr2cscEx2(hipsparseHandle_t handle,
int m,
int n,
int nnz,
const void* csrVal,
const int* csrRowPtr,
const int* csrColInd,
void* cscVal,
int* cscColPtr,
int* cscRowInd,
hipDataType valType,
hipsparseAction_t copyValues,
hipsparseIndexBase_t idxBase,
hipsparseCsr2CscAlg_t alg,
void* buffer);
#endif
#ifdef __cplusplus
}
#endif
#endif /* HIPSPARSE_CSR2CSC_H */