Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 12/16/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

mkl_sparse_?_mv

Computes a sparse matrix- vector product.

Syntax

stat = mkl_sparse_s_mv (operation, alpha, A, descr, x, beta, y)

stat = mkl_sparse_d_mv (operation, alpha, A, descr, x, beta, y)

stat = mkl_sparse_c_mv (operation, alpha, A, descr, x, beta, y)

stat = mkl_sparse_z_mv (operation, alpha, A, descr, x, beta, y)

Include Files
  • mkl_spblas.f90
Description

The mkl_sparse_?_mv routine computes a sparse matrix-dense vector product defined as

					y := alpha*op(A)*x + beta*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

C_INT.

Specifies operation op() on input matrix.

SPARSE_OPERATION_NON_TRANSPOSE

Non-transpose, op(A) = A.

SPARSE_OPERATION_TRANSPOSE

Transpose, op(A) = AT.

SPARSE_OPERATION_CONJUGATE_TRANSPOSE

Conjugate transpose, op(A) = AH.

alpha

C_FLOAT for mkl_sparse_s_mv

C_DOUBLE for mkl_sparse_d_mv

C_FLOAT_COMPLEX for mkl_sparse_c_mv

C_DOUBLE_COMPLEX for mkl_sparse_z_mv

Specifies the scalar alpha.

A

SPARSE_MATRIX_T.

Handle which contains the input matrix A.

descr

MATRIX_DESCR.

Descriptor specifying sparse matrix properties.

type - Specifies the type of a sparse matrix:

SPARSE_MATRIX_TYPE_GENERAL

The matrix is processed as is.

SPARSE_MATRIX_TYPE_SYMMETRIC

The matrix is symmetric (only the requested triangle is processed).

SPARSE_MATRIX_TYPE_HERMITIAN

The matrix is Hermitian (only the requested triangle is processed).

SPARSE_MATRIX_TYPE_TRIANGULAR

The matrix is triangular (only the requested triangle is processed).

SPARSE_MATRIX_TYPE_DIAGONAL

The matrix is diagonal (only diagonal elements are processed).

SPARSE_MATRIX_TYPE_BLOCK_TRIANGULAR

The matrix is block-triangular (only requested triangle is processed). Applies to BSR format only.

SPARSE_MATRIX_TYPE_BLOCK_DIAGONAL

The matrix is block-diagonal (only diagonal blocks are processed). Applies to BSR format only.

mode - Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices:

SPARSE_FILL_MODE_LOWER

The lower triangular matrix part is processed.

SPARSE_FILL_MODE_UPPER

The upper triangular matrix part is processed.

diag - Specifies diagonal type for non-general matrices:

SPARSE_DIAG_NON_UNIT

Diagonal elements might not be equal to one.

SPARSE_DIAG_UNIT

Diagonal elements are equal to one.
x

C_FLOAT for mkl_sparse_s_mv

C_DOUBLE for mkl_sparse_d_mv

C_FLOAT_COMPLEX for mkl_sparse_c_mv

C_DOUBLE_COMPLEX for mkl_sparse_z_mv

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

C_FLOAT for mkl_sparse_s_mv

C_DOUBLE for mkl_sparse_d_mv

C_FLOAT_COMPLEX for mkl_sparse_c_mv

C_DOUBLE_COMPLEX for mkl_sparse_z_mv

Specifies the scalar beta.

y

C_FLOAT for mkl_sparse_s_mv

C_DOUBLE for mkl_sparse_d_mv

C_FLOAT_COMPLEX for mkl_sparse_c_mv

C_DOUBLE_COMPLEX for mkl_sparse_z_mv

Array with 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. Array of size equal to the number of rows, m of A if operation = SPARSE_OPERATION_NON_TRANSPOSE and at least the number of columns, k, of A otherwise. On entry, the array y must contain the vector y.

Output Parameters
y

C_FLOAT for mkl_sparse_s_mv

C_DOUBLE for mkl_sparse_d_mv

C_FLOAT_COMPLEX for mkl_sparse_c_mv

C_DOUBLE_COMPLEX for mkl_sparse_z_mv

Overwritten by the updated vector y.

stat

INTEGER

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.