Files
TheRock/rocm-libraries/projects/rocsparse/library/include/internal/level3/rocsparse_gemmi.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
10 KiB
C

/*! \file */
/* ************************************************************************
* Copyright (C) 2023-2024 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_GEMMI_H
#define ROCSPARSE_GEMMI_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup level3_module
* \brief Dense matrix sparse matrix multiplication using the CSR storage format.
*
* \details
* \p rocsparse_gemmi multiplies the scalar \f$\alpha\f$ with a column-oriented dense \f$m \times k\f$
* matrix \f$op(A)\f$ and the sparse \f$k \times n\f$ matrix \f$op(B)\f$, defined in CSR
* storage format, and adds the result to the column-oriented dense \f$m \times n\f$ matrix \f$C\f$ that
* is multiplied by the scalar \f$\beta\f$, such that
* \f[
* C := \alpha \cdot op(A) \cdot op(B) + \beta \cdot C
* \f]
* with
* \f[
* op(A) = \left\{
* \begin{array}{ll}
* A, & \text{if trans_A == rocsparse_operation_none} \\
* A^T, & \text{if trans_A == rocsparse_operation_transpose} \\
* A^H, & \text{if trans_A == rocsparse_operation_conjugate_transpose}
* \end{array}
* \right.
* \f]
* and
* \f[
* op(B) = \left\{
* \begin{array}{ll}
* B, & \text{if trans_B == rocsparse_operation_none} \\
* B^T, & \text{if trans_B == rocsparse_operation_transpose} \\
* B^H, & \text{if trans_B == rocsparse_operation_conjugate_transpose}
* \end{array}
* \right.
* \f]
*
* \note
* Currently, only \p trans_A == \ref rocsparse_operation_none is supported.
*
* \note
* Currently, only \p trans_B == \ref rocsparse_operation_transpose is supported.
*
* \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 supports execution in a hipGraph context.
*
* @param[in]
* handle handle to the rocSPARSE library context queue.
* @param[in]
* trans_A matrix \f$A\f$ operation type.
* @param[in]
* trans_B matrix \f$B\f$ operation type.
* @param[in]
* m number of rows of the column-oriented dense matrix \f$A\f$.
* @param[in]
* n number of columns of the sparse CSR matrix \f$op(B)\f$ and \f$C\f$.
* @param[in]
* k number of columns of the column-oriented dense matrix \f$A\f$.
* @param[in]
* nnz number of non-zero entries of the sparse CSR matrix \f$B\f$.
* @param[in]
* alpha scalar \f$\alpha\f$.
* @param[in]
* A array of dimension \f$lda \times k\f$ (\f$op(A) == A\f$) or
* \f$lda \times m\f$ (\f$op(A) == A^T\f$ or \f$op(A) == A^H\f$).
* @param[in]
* lda leading dimension of \f$A\f$, must be at least \f$m\f$
* (\f$op(A) == A\f$) or \f$k\f$ (\f$op(A) == A^T\f$ or
* \f$op(A) == A^H\f$).
* @param[in]
* descr descriptor of the sparse CSR matrix \f$B\f$. Currently, only
* \ref rocsparse_matrix_type_general is supported.
* @param[in]
* csr_val array of \p nnz elements of the sparse CSR matrix \f$B\f$.
* @param[in]
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
* sparse CSR matrix \f$B\f$.
* @param[in]
* csr_col_ind array of \p nnz elements containing the column indices of the sparse CSR
* matrix \f$B\f$.
* @param[in]
* beta scalar \f$\beta\f$.
* @param[inout]
* C column-oriented dense matrix of dimension \f$ldc \times n\f$ that holds the values of \f$C\f$.
* @param[in]
* ldc leading dimension of \f$C\f$, must be at least \f$m\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 m, \p n, \p k, \p nnz, \p lda, or \p ldc
* is invalid.
* \retval rocsparse_status_invalid_pointer \p alpha, \p A, \p csr_val,
* \p csr_row_ptr, \p csr_col_ind, \p beta, or \p C pointer is invalid.
*
* \par Example
* This example multiplies a column-oriented dense matrix with a CSC matrix.
* \snippet example_rocsparse_gemmi.cpp doc example
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sgemmi(rocsparse_handle handle,
rocsparse_operation trans_A,
rocsparse_operation trans_B,
rocsparse_int m,
rocsparse_int n,
rocsparse_int k,
rocsparse_int nnz,
const float* alpha,
const float* A,
rocsparse_int lda,
const rocsparse_mat_descr descr,
const float* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
const float* beta,
float* C,
rocsparse_int ldc);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dgemmi(rocsparse_handle handle,
rocsparse_operation trans_A,
rocsparse_operation trans_B,
rocsparse_int m,
rocsparse_int n,
rocsparse_int k,
rocsparse_int nnz,
const double* alpha,
const double* A,
rocsparse_int lda,
const rocsparse_mat_descr descr,
const double* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
const double* beta,
double* C,
rocsparse_int ldc);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cgemmi(rocsparse_handle handle,
rocsparse_operation trans_A,
rocsparse_operation trans_B,
rocsparse_int m,
rocsparse_int n,
rocsparse_int k,
rocsparse_int nnz,
const rocsparse_float_complex* alpha,
const rocsparse_float_complex* A,
rocsparse_int lda,
const rocsparse_mat_descr descr,
const rocsparse_float_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
const rocsparse_float_complex* beta,
rocsparse_float_complex* C,
rocsparse_int ldc);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zgemmi(rocsparse_handle handle,
rocsparse_operation trans_A,
rocsparse_operation trans_B,
rocsparse_int m,
rocsparse_int n,
rocsparse_int k,
rocsparse_int nnz,
const rocsparse_double_complex* alpha,
const rocsparse_double_complex* A,
rocsparse_int lda,
const rocsparse_mat_descr descr,
const rocsparse_double_complex* csr_val,
const rocsparse_int* csr_row_ptr,
const rocsparse_int* csr_col_ind,
const rocsparse_double_complex* beta,
rocsparse_double_complex* C,
rocsparse_int ldc);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_GEMMI_H */