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
364 lines
19 KiB
C
364 lines
19 KiB
C
/*! \file */
|
|
/* ************************************************************************
|
|
* Copyright (C) 2023-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 ROCSPARSE_BSRMV_H
|
|
#define ROCSPARSE_BSRMV_H
|
|
|
|
#include "../../rocsparse-types.h"
|
|
#include "rocsparse/rocsparse-export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_bsrmv_analysis performs the analysis step for \ref rocsparse_sbsrmv "rocsparse_Xbsrmv()".
|
|
* It is expected that this function will be executed only once for a given sparsity pattern and particular operation
|
|
* type. The gathered analysis meta data is stored in the \ref rocsparse_mat_info object and can be cleared by
|
|
* \ref rocsparse_bsrmv_clear().
|
|
*
|
|
* If the matrix sparsity pattern changes, the gathered information will become invalid. To perform another
|
|
* sparse matrix multiplication with a matrix having a different sparsity pattern, either destroy
|
|
* the old \p info object and create a new one or clear the existing \p info object using
|
|
* \ref rocsparse_bsrmv_clear(). In both cases, the analysis will need to be called again.
|
|
*
|
|
* \note
|
|
* This function is non-blocking and executed asynchronously with respect to the host.
|
|
* It can 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]
|
|
* dir matrix storage of BSR blocks.
|
|
* @param[in]
|
|
* trans matrix operation type.
|
|
* @param[in]
|
|
* mb number of block rows of the sparse BSR matrix.
|
|
* @param[in]
|
|
* nb number of block columns of the sparse BSR matrix.
|
|
* @param[in]
|
|
* nnzb number of non-zero blocks of the sparse BSR matrix.
|
|
* @param[in]
|
|
* descr descriptor of the sparse BSR matrix. Currently, only
|
|
* \ref rocsparse_matrix_type_general is supported.
|
|
* @param[in]
|
|
* bsr_val array of \p nnzb blocks of the sparse BSR matrix.
|
|
* @param[in]
|
|
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of
|
|
* the sparse BSR matrix.
|
|
* @param[in]
|
|
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse
|
|
* BSR matrix.
|
|
* @param[in]
|
|
* block_dim block dimension of the sparse BSR matrix.
|
|
* @param[out]
|
|
* info structure that holds the information collected during the analysis step.
|
|
*
|
|
* \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 mb, \p nb, or \p nnzb is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p descr, \p bsr_val, \p bsr_row_ptr,
|
|
* \p bsr_col_ind, or \p info pointer is invalid.
|
|
* \retval rocsparse_status_memory_error the buffer for the gathered information
|
|
* could not be allocated.
|
|
* \retval rocsparse_status_internal_error an internal error occurred.
|
|
* \retval rocsparse_status_not_implemented
|
|
* \p trans != \ref rocsparse_operation_none or
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_sbsrmv_analysis(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const rocsparse_mat_descr descr,
|
|
const float* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dbsrmv_analysis(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const rocsparse_mat_descr descr,
|
|
const double* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_cbsrmv_analysis(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zbsrmv_analysis(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info);
|
|
/**@}*/
|
|
|
|
/*! \ingroup level2_module
|
|
* \brief Sparse matrix vector multiplication using the BSR storage format.
|
|
*
|
|
* \details
|
|
* \p rocsparse_bsrmv multiplies the scalar \f$\alpha\f$ with a sparse
|
|
* \f$m \times n\f$ matrix, defined in BSR storage format, and the dense vector \f$x\f$ and adds the
|
|
* result to the dense vector \f$y\f$ that is multiplied by the scalar \f$\beta\f$, such that
|
|
* \f[
|
|
* y := \alpha \cdot op(A) \cdot x + \beta \cdot y,
|
|
* \f]
|
|
* with
|
|
* \f[
|
|
* op(A) = \left\{
|
|
* \begin{array}{ll}
|
|
* A, & \text{if trans == rocsparse_operation_none}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
* and where \f$m = mb \times block\_dim\f$ and \f$n= nb \times block\_dim\f$.
|
|
*
|
|
* The operation above can be done with or without analysis. Running with analysis might result in better performance
|
|
* when computing the matrix vector product but will also incur a performance cost attributed to the additional analysis step.
|
|
* For this reason, running with analysis makes sense when a user plans on computing the matrix vector product many times and
|
|
* therefore can amortize the analysis cost.
|
|
*
|
|
* To run the operation above without analysis, call the \p rocsparse_bsrmv routine while passing
|
|
* \p NULL for the \p info parameter.
|
|
*
|
|
* Running the operation with analysis involves two steps. First, create a \ref rocsparse_mat_info object
|
|
* by calling \ref rocsparse_create_mat_info and then pass this to \ref rocsparse_sbsrmv_analysis "rocsparse_Xbsrmv_analysis()",
|
|
* which will perform analysis on the sparsity pattern of the matrix \f$op(A)\f$. Then complete the operation by
|
|
* calling \p rocsparse_bsrmv. The creation of the \p info object and the call to the analysis routine only need to be performed
|
|
* once for a given sparsity pattern, while the computation can be performed repeatedly as long as the sparsity pattern has
|
|
* not changed. After all calls to \p rocsparse_bsrmv have been made, the \p info object can be destroyed with a call to
|
|
* \ref rocsparse_destroy_mat_info.
|
|
*
|
|
* When running with analysis, users might want to perform multiple sparse matrix
|
|
* multiplications, with each sparse matrix having a different sparsity pattern. Instead of creating and destroying multiple
|
|
* \ref rocsparse_mat_info objects for each unique sparsity pattern, the user can instead create the \p info object once and
|
|
* then call \ref rocsparse_bsrmv_clear, followed by re-running the analysis in between each sparse matrix multiplication.
|
|
*
|
|
* \note
|
|
* This function is non-blocking and executed asynchronously with respect to the host.
|
|
* It can return before the actual computation has finished.
|
|
*
|
|
* \note
|
|
* Currently, only \p trans == \ref rocsparse_operation_none is supported.
|
|
*
|
|
* \note
|
|
* This routine supports execution in a hipGraph context.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the rocSPARSE library context queue.
|
|
* @param[in]
|
|
* dir matrix storage of BSR blocks.
|
|
* @param[in]
|
|
* trans matrix operation type.
|
|
* @param[in]
|
|
* mb number of block rows of the sparse BSR matrix.
|
|
* @param[in]
|
|
* nb number of block columns of the sparse BSR matrix.
|
|
* @param[in]
|
|
* nnzb number of non-zero blocks of the sparse BSR matrix.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* descr descriptor of the sparse BSR matrix. Currently, only
|
|
* \ref rocsparse_matrix_type_general is supported.
|
|
* @param[in]
|
|
* bsr_val array of \p nnzb blocks of the sparse BSR matrix.
|
|
* @param[in]
|
|
* bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of
|
|
* the sparse BSR matrix.
|
|
* @param[in]
|
|
* bsr_col_ind array of \p nnzb elements containing the block column indices of the sparse
|
|
* BSR matrix.
|
|
* @param[in]
|
|
* block_dim block dimension of the sparse BSR matrix.
|
|
* @param[in]
|
|
* x array of \p nb*block_dim elements (\f$op(A) = A\f$) or \p mb*block_dim
|
|
* elements (\f$op(A) = A^T\f$ or \f$op(A) = A^H\f$).
|
|
* @param[in]
|
|
* beta scalar \f$\beta\f$.
|
|
* @param[inout]
|
|
* y array of \p mb*block_dim elements (\f$op(A) = A\f$) or \p nb*block_dim
|
|
* elements (\f$op(A) = A^T\f$ or \f$op(A) = A^H\f$).
|
|
* @param[out]
|
|
* info structure that holds the information collected during the analysis step.
|
|
*
|
|
* \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 mb, \p nb, \p nnzb, or \p block_dim is
|
|
* invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p bsr_val,
|
|
* \p bsr_row_ind, \p bsr_col_ind, \p x, \p beta, or \p y pointer is invalid.
|
|
* \retval rocsparse_status_arch_mismatch the device is not supported.
|
|
* \retval rocsparse_status_not_implemented
|
|
* \p trans != \ref rocsparse_operation_none or
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
|
|
*
|
|
* \par Example
|
|
* This example performs a sparse matrix vector multiplication in BSR format.
|
|
* \snippet example_rocsparse_bsrmv.cpp doc example
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_sbsrmv(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const float* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const float* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info,
|
|
const float* x,
|
|
const float* beta,
|
|
float* y);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dbsrmv(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const double* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const double* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info,
|
|
const double* x,
|
|
const double* beta,
|
|
double* y);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_cbsrmv(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const rocsparse_float_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info,
|
|
const rocsparse_float_complex* x,
|
|
const rocsparse_float_complex* beta,
|
|
rocsparse_float_complex* y);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zbsrmv(rocsparse_handle handle,
|
|
rocsparse_direction dir,
|
|
rocsparse_operation trans,
|
|
rocsparse_int mb,
|
|
rocsparse_int nb,
|
|
rocsparse_int nnzb,
|
|
const rocsparse_double_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* bsr_val,
|
|
const rocsparse_int* bsr_row_ptr,
|
|
const rocsparse_int* bsr_col_ind,
|
|
rocsparse_int block_dim,
|
|
rocsparse_mat_info info,
|
|
const rocsparse_double_complex* x,
|
|
const rocsparse_double_complex* beta,
|
|
rocsparse_double_complex* y);
|
|
/**@}*/
|
|
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_bsrmv_clear deallocates all memory that was allocated by
|
|
* \ref rocsparse_sbsrmv_analysis "rocsparse_Xbsrmv_analysis()". This is especially useful
|
|
* if memory is an issue and the analysis data is not required anymore for further computation,
|
|
* for example, when switching to another sparse matrix format.
|
|
*
|
|
* Calling \p rocsparse_bsrmv_clear is optional. All allocated resources will be
|
|
* cleared when the opaque \ref rocsparse_mat_info object is destroyed using
|
|
* \ref rocsparse_destroy_mat_info().
|
|
*
|
|
* \note
|
|
* This routine does not support execution in a hipGraph context.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the rocSPARSE library context queue.
|
|
* @param[inout]
|
|
* info structure that holds the information collected during analysis step.
|
|
*
|
|
* \retval rocsparse_status_success the operation completed successfully.
|
|
* \retval rocsparse_status_invalid_handle the library context was not initialized.
|
|
* \retval rocsparse_status_invalid_pointer \p info pointer is invalid.
|
|
* \retval rocsparse_status_memory_error the buffer for the gathered information
|
|
* could not be deallocated.
|
|
* \retval rocsparse_status_internal_error an internal error occurred.
|
|
* */
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_bsrmv_clear(rocsparse_handle handle, rocsparse_mat_info info);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ROCSPARSE_BSRMV_H */
|