mkl_sparse_set_lu_smoother

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 10/31/2024

Version

Public

Visible to Intel only — GUID: GUID-69833ECC-0021-405D-9C0E-0FDD4CEC14B6

View Details

mkl_sparse_set_lu_smoother_hint

Provides an estimate of the number and type of upcoming calls to LU smoother functionality.

Syntax

sparse_status_t mkl_sparse_set_lu_smoother_hint (sparse_matrix_t A, const sparse_operation_t operation, struct matrix_descr descr, MKL_INT expected_calls);

Include Files

mkl_spblas.h

Description

The mkl_sparse_set_lu_smoother_hint function provides subsequent Inspector-Executor Sparse BLAS calls an estimate of the number of upcoming calls to the lu_smoother routine that ultimately may influence the optimizations applied and specifies whether or not to perform an operation on the matrix.

Product and Performance Information
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex. Notice revision #20201201

Product and Performance Information

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.

Notice revision #20201201

Input Parameters

operation

Specifies the operation op() on input matrix.

`SPARSE_OPERATION_NON_TRANSPOSE`	Non-transpose, `op(A)`= `A`.
`SPARSE_OPERATION_TRANSPOSE`	Transpose, `op(A)`= `A`^T.
`SPARSE_OPERATION_CONJUGATE_TRANSPOSE`	Conjugate transpose, `op(A)`= `A`^H.

descr

Structure specifying sparse matrix properties.

sparse_matrix_type_ttype - 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 the 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.

sparse_fill_mode_tmode - 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_tdiag - Specifies the 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.

expected_calls

Number of expected calls to execution routine.

A

Handle containing internal data.

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.

Parent topic: Inspector-Executor Sparse BLAS Analysis Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in