Files
TheRock/rocm-libraries/projects/rocsparse/library/include/internal/conversion/rocsparse_csr2hyb.h
T
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

149 lines
7.1 KiB
C

/*! \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_CSR2HYB_H
#define ROCSPARSE_CSR2HYB_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup conv_module
* \brief Convert a sparse CSR matrix into a sparse HYB matrix.
*
* \details
* \p rocsparse_csr2hyb converts a CSR matrix into a HYB matrix. It is assumed
* that \p hyb has been initialized with \ref rocsparse_create_hyb_mat().
*
* \note
* This function requires a significant amount of storage for the HYB matrix,
* depending on the matrix structure.
*
* \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]
* m number of rows of the sparse CSR matrix.
* @param[in]
* n number of columns of the sparse CSR matrix.
* @param[in]
* descr descriptor of the sparse CSR matrix. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* csr_val array 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 containing the column indices of the sparse CSR matrix.
* @param[out]
* hyb sparse matrix in HYB format.
* @param[in]
* user_ell_width width of the ELL part of the HYB matrix (only required if
* \p partition_type == \ref rocsparse_hyb_partition_user).
* @param[in]
* partition_type \ref rocsparse_hyb_partition_auto (recommended),
* \ref rocsparse_hyb_partition_user, or
* \ref rocsparse_hyb_partition_max.
*
* \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 user_ell_width is invalid.
* \retval rocsparse_status_invalid_value \p partition_type is invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p hyb, \p csr_val,
* \p csr_row_ptr, or \p csr_col_ind pointer is invalid.
* \retval rocsparse_status_memory_error the buffer for the HYB matrix could not be
* allocated.
* \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
* This example converts a CSR matrix into a HYB matrix using user-defined partitioning.
* \snippet example_rocsparse_csr2hyb.cpp doc example
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_scsr2hyb(rocsparse_handle handle,
rocsparse_int m,
rocsparse_int n,
const rocsparse_mat_descr descr,
const float* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_hyb_mat hyb,
rocsparse_int user_ell_width,
rocsparse_hyb_partition partition_type);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dcsr2hyb(rocsparse_handle handle,
rocsparse_int m,
rocsparse_int n,
const rocsparse_mat_descr descr,
const double* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_hyb_mat hyb,
rocsparse_int user_ell_width,
rocsparse_hyb_partition partition_type);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_ccsr2hyb(rocsparse_handle handle,
rocsparse_int m,
rocsparse_int n,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_hyb_mat hyb,
rocsparse_int user_ell_width,
rocsparse_hyb_partition partition_type);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zcsr2hyb(rocsparse_handle handle,
rocsparse_int m,
rocsparse_int n,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
rocsparse_hyb_mat hyb,
rocsparse_int user_ell_width,
rocsparse_hyb_partition partition_type);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_CSR2HYB_H */