Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_?_sp2md
Computes the product of two sparse matrices (support operations on both matrices) and stores the result as a dense matrix.
Syntax
sparse_status_t mkl_sparse_s_sp2md ( const sparse_operation_t opA,
const struct matrix_descr descrA,
const sparse_matrix_t A,
const sparse_operation_t opB,
const struct matrix_descr descrB,
const sparse_matrix_t B,
const float alpha,
const float beta,
float *C,
const sparse_layout_t layout,
const MKL_INT ldc );sparse_status_t mkl_sparse_d_sp2md ( const sparse_operation_t opA,
const struct matrix_descr descrA,
const sparse_matrix_t A,
const sparse_operation_t opB,
const struct matrix_descr descrB,
const sparse_matrix_t B,
const double alpha,
const double beta,
double *C,
const sparse_layout_t layout,
const MKL_INT ldc );sparse_status_t mkl_sparse_c_sp2md ( const sparse_operation_t opA,
const struct matrix_descr descrA,
const sparse_matrix_t A,
const sparse_operation_t opB,
const struct matrix_descr descrB,
const sparse_matrix_t B,
const MKL_Complex8 alpha,
const MKL_Complex8 beta,
MKL_Complex8 *C,
const sparse_layout_t layout,
const MKL_INT ldc );sparse_status_t mkl_sparse_z_sp2md ( const sparse_operation_t opA,
const struct matrix_descr descrA,
const sparse_matrix_t A,
const sparse_operation_t opB,
const struct matrix_descr descrB,
const sparse_matrix_t B,
const MKL_Complex16 alpha,
const MKL_Complex16 beta,
MKL_Complex16 *C,
const sparse_layout_t layout,
const MKL_INT ldc );Include Files
mkl_spblas.h
Description
The mkl_sparse_?_sp2md routine performs a matrix-matrix operation:
\[C \leftarrow \alpha \cdot opA(A) \cdot opB(B) + \beta\cdot C\]
where \(A\) and \(B\) are sparse matrices, opA() is a matrix modifier for matrix \(A\) , opB() is a matrix modifier for matrix \(B\), and \(C\) is a dense matrix, \(\alpha\) and \(\beta\) are scalars.
(SPARSE_INDEX_BASE_ZERO, SPARSE_LAYOUT_ROW_MAJOR)
(SPARSE_INDEX_BASE_ONE, SPARSE_LAYOUT_COLUMN_MAJOR)
Input Parameters
opA
Specifies operation on input matrix \(A\).
opA |
Description |
|---|---|
SPARSE_OPERATION_NON_TRANSPOSE |
\(opA(A) = A\) |
SPARSE_OPERATION_TRANSPOSE |
\(opA(A) = A^{T}\) |
SPARSE_OPERATION_CONJUGATE_TRANSPOSE |
\(opA(A) = A^{H}\) |
descrA
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:
|
A
Handle which contains the sparse matrix \(A\) .
opB
Specifies operation on input matrix \(B\).
opB |
Description |
|---|---|
SPARSE_OPERATION_NON_TRANSPOSE |
\(opB(B) = B\) |
SPARSE_OPERATION_TRANSPOSE |
\(opB(B) = B^{T}\) |
SPARSE_OPERATION_CONJUGATE_TRANSPOSE |
\(opB(B) = B^{H}\) |
descrB
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:
|
B
Handle which contains the sparse matrix \(B\) .
alpha
Specifies the scalar, \(\alpha\) .
beta
Specifies the scalar, \(\beta\) .
layout
Describes the storage scheme for the dense matrix \(C\):
SPARSE_LAYOUT_COLUMN_MAJOR |
Storage of elements uses column major layout. |
SPARSE_LAYOUT_ROW_MAJOR |
Storage of elements uses row major layout. |
ldc
Leading dimension of matrix \(C\) .
Output Parameters
C
The resulting dense matrix.
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. |