mkl_sparse_set_mm

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 10/15/2026

Version

Public

mkl_sparse_set_mm_hint

Allows user to provide an estimate of the number and type of upcoming sparse-matrix dense-matrix multiplication operations and in conjunction with mkl_sparse_optimize allows the library to perform some internal analysis to optimize these operations. See mkl_sparse_mm for details of the sparse-matrix dense-matrix multiplication operation.

Syntax

stat = mkl_sparse_set_mm_hint ( A, operation, descr, layout, dense_matrix_size, expected_calls )

Include Files

mkl_spblas.f90

Description

The mkl_sparse_set_mm_hint routine provides an estimate of the number of upcoming matrix-matrix multiplication operations and type of these operations. All such hints must be called before mkl_sparse_optimize which will allow the library to perform some internal analysis to optimize these operations.

Input Parameters

operation

C_INT .

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}\)`

descr

MATRIX_DESCR .

Descriptor specifying sparse matrix properties.

sparse_matrix_type_t 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 requested diagonal blocks are processed). Applies to BSR format only.

sparse_fill_mode_t 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.

sparse_diag_type_t 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.

layout

C_INT .

Specifies layout of elements:

`SPARSE_LAYOUT_COLUMN_MAJOR`	Storage of elements uses column major layout.
`SPARSE_LAYOUT_ROW_MAJOR`	Storage of elements uses row major layout.

dense_matrix_size

C_INT.

Number of columns in dense matrix.

expected_calls

C_INT.

Number of expected calls to execution routine.

Output Parameters

A

SPARSE_MATRIX_T .

Handle containing internal data.

stat

INTEGER

Value indicating whether the operation was successful, and if not, why:

`SPARSE_STATUS_SUCCESS`	The operation was successful or an additional optimization is currently not available.
`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.

Return Values

See Output Parameter, stat.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in