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
251 lines
11 KiB
C
251 lines
11 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_GEMVI_H
|
|
#define ROCSPARSE_GEMVI_H
|
|
|
|
#include "../../rocsparse-types.h"
|
|
#include "rocsparse/rocsparse-export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_gemvi_buffer_size returns the size of the temporary storage buffer
|
|
* required by \ref rocsparse_sgemvi "rocsparse_Xgemvi()". The temporary storage
|
|
* buffer must be allocated by the user.
|
|
*
|
|
* \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 matrix operation type.
|
|
* @param[in]
|
|
* m number of rows of the dense matrix.
|
|
* @param[in]
|
|
* n number of columns of the dense matrix.
|
|
* @param[in]
|
|
* nnz number of non-zero entries in the sparse vector.
|
|
* @param[out]
|
|
* buffer_size temporary storage buffer size.
|
|
*
|
|
* \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 nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p buffer_size pointer is invalid.
|
|
* \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_sgemvi_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
rocsparse_int nnz,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dgemvi_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
rocsparse_int nnz,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_cgemvi_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
rocsparse_int nnz,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zgemvi_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
rocsparse_int nnz,
|
|
size_t* buffer_size);
|
|
/**@}*/
|
|
|
|
/*! \ingroup level2_module
|
|
* \brief Dense matrix sparse vector multiplication.
|
|
*
|
|
* \details
|
|
* \p rocsparse_gemvi multiplies the scalar \f$\alpha\f$ with a dense \f$m \times n\f$
|
|
* matrix \f$A\f$ and the sparse 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]
|
|
*
|
|
* Performing the above operation involves two steps. First, call
|
|
* \ref rocsparse_sgemvi_buffer_size "rocsparse_Xgemvi_buffer_size()" to determine the size of
|
|
* the temporary storage buffer. Next, allocate this temporary buffer and pass it to
|
|
* \p rocsparse_gemvi to complete the computation. After all calls to \p rocsparse_gemvi are complete, the
|
|
* temporary storage buffer can be freed.
|
|
*
|
|
* \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]
|
|
* trans matrix operation type.
|
|
* @param[in]
|
|
* m number of rows of the dense matrix.
|
|
* @param[in]
|
|
* n number of columns of the dense matrix.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* A pointer to the dense matrix.
|
|
* @param[in]
|
|
* lda leading dimension of the dense matrix.
|
|
* @param[in]
|
|
* nnz number of non-zero entries in the sparse vector.
|
|
* @param[in]
|
|
* x_val array of \p nnz elements containing the values of the sparse vector.
|
|
* @param[in]
|
|
* x_ind array of \p nnz elements containing the indices of the sparse vector.
|
|
* @param[in]
|
|
* beta scalar \f$\beta\f$.
|
|
* @param[inout]
|
|
* y array of \p m elements (\f$op(A) == A\f$) or \p n elements
|
|
* (\f$op(A) == A^T\f$ or \f$op(A) == A^H\f$).
|
|
* @param[in]
|
|
* idx_base rocsparse_index_base_zero or rocsparse_index_base_one.
|
|
* @param[in]
|
|
* temp_buffer temporary storage buffer.
|
|
*
|
|
* \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 lda, or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p alpha, \p A, \p x_val, \p x_ind,
|
|
* \p beta, \p y, or \p temp_buffer pointer is invalid.
|
|
* \retval rocsparse_status_not_implemented
|
|
* \p trans != \ref rocsparse_operation_none or
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
|
|
*
|
|
* \par Example
|
|
* \snippet example_rocsparse_gemvi.cpp doc example
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_sgemvi(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const float* alpha,
|
|
const float* A,
|
|
rocsparse_int lda,
|
|
rocsparse_int nnz,
|
|
const float* x_val,
|
|
const rocsparse_int* x_ind,
|
|
const float* beta,
|
|
float* y,
|
|
rocsparse_index_base idx_base,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dgemvi(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const double* alpha,
|
|
const double* A,
|
|
rocsparse_int lda,
|
|
rocsparse_int nnz,
|
|
const double* x_val,
|
|
const rocsparse_int* x_ind,
|
|
const double* beta,
|
|
double* y,
|
|
rocsparse_index_base idx_base,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_cgemvi(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_float_complex* alpha,
|
|
const rocsparse_float_complex* A,
|
|
rocsparse_int lda,
|
|
rocsparse_int nnz,
|
|
const rocsparse_float_complex* x_val,
|
|
const rocsparse_int* x_ind,
|
|
const rocsparse_float_complex* beta,
|
|
rocsparse_float_complex* y,
|
|
rocsparse_index_base idx_base,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zgemvi(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int n,
|
|
const rocsparse_double_complex* alpha,
|
|
const rocsparse_double_complex* A,
|
|
rocsparse_int lda,
|
|
rocsparse_int nnz,
|
|
const rocsparse_double_complex* x_val,
|
|
const rocsparse_int* x_ind,
|
|
const rocsparse_double_complex* beta,
|
|
rocsparse_double_complex* y,
|
|
rocsparse_index_base idx_base,
|
|
void* temp_buffer);
|
|
/**@}*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ROCSPARSE_GEMVI_H */
|