Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_?_mv
Computes a sparse matrix - vector product.
Syntax
sparse_status_t mkl_sparse_s_mv ( const sparse_operation_t operation,
const float alpha,
const sparse_matrix_t A,
const struct matrix_descr descr,
const float *x,
const float beta,
float *y );sparse_status_t mkl_sparse_d_mv ( const sparse_operation_t operation,
const double alpha,
const sparse_matrix_t A,
const struct matrix_descr descr,
const double *x,
const double beta,
double *y );sparse_status_t mkl_sparse_c_mv ( const sparse_operation_t operation,
const MKL_Complex8 alpha,
const sparse_matrix_t A,
const struct matrix_descr descr,
const MKL_Complex8 *x,
const MKL_Complex8 beta,
MKL_Complex8 *y );sparse_status_t mkl_sparse_z_mv ( const sparse_operation_t operation,
const MKL_Complex16 alpha,
const sparse_matrix_t A,
const struct matrix_descr descr,
const MKL_Complex16 *x,
const MKL_Complex16 beta,
MKL_Complex16 *y );Include Files
mkl_spblas.h
Description
The mkl_sparse_?_mv routine computes a sparse matrix-dense vector product defined as
\[y \leftarrow \alpha\cdot op(A)\cdot x + \beta\cdot y\]
where \(\alpha\) and \(\beta\) are scalars, \(x\) and \(y\) are vectors, and \(A\) is a sparse matrix handle of a matrix with \(m\) rows and \(k\) columns, and \(op\) is a matrix modifier for matrix \(A\) .
Input Parameters
operation
Specifies operation op() on input matrix:
operation |
Description |
|---|---|
SPARSE_OPERATION_NON_TRANSPOSE |
\(op(A) = A\) |
SPARSE_OPERATION_TRANSPOSE |
\(op(A) = A^{T}\) |
SPARSE_OPERATION_CONJUGATE_TRANSPOSE |
\(op(A) = A^{H}\) |
alpha
Specifies the scalar, \(\alpha\) .
A
Handle which contains the sparse matrix A .
descr
Descriptor specifying sparse matrix properties.
sparse_matrix_type_t type |
Specifies the type of a sparse matrix:
|
sparse_fill_mode_t mode |
Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices:
|
sparse_diag_type_t diag |
Specifies diagonal type for non-general matrices:
|
x
Array of size equal to the number of columns, \(k\) of \(A\) if operation = SPARSE_OPERATION_NON_TRANSPOSE and at least the number of rows, \(m\) of \(A\) otherwise. On entry, the array must contain the vector x .
beta
Specifies the scalar, \(\beta\) .
y
Array of size at least \(m\) if operation = SPARSE_OPERATION_NON_TRANSPOSE and at least \(k\) otherwise. On entry, the array y must contain the vector y .
Output Parameters
y
Overwritten by the updated vector y .
Return Values
The function returns a value indicating whether the operation was successful or not, and why.
SPARSE_STATUS_SUCCESS |
The operation was successful. |
SPARSE_STATUS_NOT_INITIALIZED |
The routine encountered an empty handle or matrix array. |
SPARSE_STATUS_ALLOC_FAILED |
Internal memory allocation failed. |
SPARSE_STATUS_INVALID_VALUE |
The input parameters contain an invalid value. |
SPARSE_STATUS_EXECUTION_FAILED |
Execution failed. |
SPARSE_STATUS_INTERNAL_ERROR |
An error in algorithm implementation occurred. |
SPARSE_STATUS_NOT_SUPPORTED |
The requested operation is not supported. |