Visible to Intel only — GUID: GUID-DBCBE227-8EB6-49B9-9EDA-53F256911D15
Visible to Intel only — GUID: GUID-DBCBE227-8EB6-49B9-9EDA-53F256911D15
mkl_sparse_?_dotmv
Computes a sparse matrix-vector product followed by a dot product.
Syntax
stat = mkl_sparse_s_dotmv (operation, alpha, A, descr, x, beta, y, d)
stat = mkl_sparse_d_dotmv (operation, alpha, A, descr, x, beta, y, d)
stat = mkl_sparse_c_dotmv (operation, alpha, A, descr, x, beta, y, d)
stat = mkl_sparse_z_dotmv (operation, alpha, A, descr, x, beta, y, d)
Include Files
- mkl_spblas.f90
Description
The mkl_sparse_?_dotmv routine computes a sparse matrix-vector product and dot product:
y := alpha*op(A)*x + beta*y d := ∑ixi*yi (real case) d := ∑iconj(xi)*yi (complex case)
where
alpha and beta are scalars.
x and y are vectors.
A is an m-by-k matrix.
conj represents complex conjugation.
op(A) is a matrix modifier.
Available options for op(A) are A, AT, or AH.
For sparse matrices in the BSR format, the supported combinations of (indexing,block_layout) are:
(SPARSE_INDEX_BASE_ZERO, SPARSE_LAYOUT_ROW_MAJOR )
(SPARSE_INDEX_BASE_ONE, SPARSE_LAYOUT_COLUMN_MAJOR )
Input Parameters
- operation
-
C_INT.
Specifies the operation performed on matrix A.
If operation = SPARSE_OPERATION_NON_TRANSPOSE, op(A) = A.
If operation = SPARSE_OPERATION_TRANSPOSE, op(A) = AT.
If operation = SPARSE_OPERATION_CONJUGATE_TRANSPOSE, op(A) = AH.
- alpha
-
C_FLOAT for mkl_sparse_s_dotmv
C_DOUBLE for mkl_sparse_d_dotmv
C_FLOAT_COMPLEX for mkl_sparse_c_dotmv
C_DOUBLE_COMPLEX for mkl_sparse_z_dotmv
Specifies the scalar alpha.
- A
-
SPARSE_MATRIX_T.
Handle which contains the sparse 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_dotmv
C_DOUBLE for mkl_sparse_d_dotmv
C_FLOAT_COMPLEX for mkl_sparse_c_dotmv
C_DOUBLE_COMPLEX for mkl_sparse_z_dotmv
If operation = SPARSE_OPERATION_NON_TRANSPOSE, array of size at least k, where k is the number of columns of matrix A.
Otherwise, array of size at least m, where m is the number of rows of matrix A.
On entry, the array x must contain the vector x.
- beta
-
C_FLOAT for mkl_sparse_s_dotmv
C_DOUBLE for mkl_sparse_d_dotmv
C_FLOAT_COMPLEX for mkl_sparse_c_dotmv
C_DOUBLE_COMPLEX for mkl_sparse_z_dotmv
Specifies the scalar beta.
- y
-
C_FLOAT for mkl_sparse_s_dotmv
C_DOUBLE for mkl_sparse_d_dotmv
C_FLOAT_COMPLEX for mkl_sparse_c_dotmv
C_DOUBLE_COMPLEX for mkl_sparse_z_dotmv
If operation = SPARSE_OPERATION_NON_TRANSPOSE, array of size at least m, where k is the number of rows of matrix A.
Otherwise, array of size at least k, where k is the number of columns of matrix A.
On entry, the array y must contain the vector y.
Output Parameters
- y
-
Overwritten by the updated vector y.
- d
-
C_FLOAT for mkl_sparse_s_dotmv
C_DOUBLE for mkl_sparse_d_dotmv
C_FLOAT_COMPLEX for mkl_sparse_c_dotmv
C_DOUBLE_COMPLEX for mkl_sparse_z_dotmv
Overwritten by the dot product of x and 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.