Files
TheRock/rocm-libraries/projects/rocsparse/library/include/internal/level2/rocsparse_bsrxmv.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

215 lines
11 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_BSRXMV_H
#define ROCSPARSE_BSRXMV_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup level2_module
* \brief Sparse matrix vector multiplication with mask operation using the BSR storage format.
*
* \details
* \p rocsparse_bsrxmv multiplies the scalar \f$\alpha\f$ with a sparse
* \f$m \times n\f$ modified 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 := \left( \alpha \cdot op(A) \cdot x + \beta \cdot y \right)\left( \text{mask} \right),
* \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 \f$\text{mask}\f$ is defined as an array of block row indices.
* The input sparse matrix is defined with a modified BSR storage format where the beginning and the end of each row
* is defined with two arrays, \p bsr_row_ptr and \p bsr_end_ptr (both of size \p mb), rather the usual \p bsr_row_ptr of size \p mb+1.
*
* \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.
* Currently, \p block_dim==1 is not 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]
* size_of_mask number of updated block rows of the array \p y.
* @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_mask_ptr array of \p size_of_mask elements that give the indices of the updated block rows.
*
* @param[in]
* bsr_row_ptr array of \p mb elements that point to the start of every block row of
* the sparse BSR matrix.
* @param[in]
* bsr_end_ptr array of \p mb elements that point to the end 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$).
*
* \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, \p block_dim, or \p size_of_mask is
* invalid.
* \retval rocsparse_status_invalid_value \p size_of_mask is greater than \p mb.
* \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 block_dim==1, \p trans != \ref rocsparse_operation_none or
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sbsrxmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int size_of_mask,
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_mask_ptr,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_end_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
const float* x,
const float* beta,
float* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dbsrxmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int size_of_mask,
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_mask_ptr,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_end_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
const double* x,
const double* beta,
double* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cbsrxmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int size_of_mask,
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_mask_ptr,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_end_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
const rocsparse_float_complex* x,
const rocsparse_float_complex* beta,
rocsparse_float_complex* y);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zbsrxmv(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_operation trans,
rocsparse_int size_of_mask,
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_mask_ptr,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_end_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
const rocsparse_double_complex* x,
const rocsparse_double_complex* beta,
rocsparse_double_complex* y);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif // ROCSPARSE_BSRXMV_H