Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_set_symgs_hint
Syntax
Sets estimate of number and type of upcoming mkl_sparse_?_symgs or mkl_sparse_?_symgs_mv operations.
sparse_status_t mkl_sparse_set_symgs_hint ( const sparse_matrix_t A,
const sparse_operation_t operation,
const struct matrix_descr descr,
const MKL_INT expected_calls );Include Files
mkl_spblas.h
Description
Use the mkl_sparse_set_symgs_hint routine to provide the Inspector-executor Sparse BLAS API an estimate of the number of upcoming symmetric Gauss-Seidel preconditioner operations for performance optimization, and specify 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 |
Input Parameters
operation
Specifies the operation performed on matrix A:
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
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:
|
diag
Specifies diagonal type for non-general matrices
mode
Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices.
type
Specifies the type of a sparse matrix.
expected_calls
Estimate of the number to the execution routine.
Output Parameters
A
Handle containing internal data.
Return Values
The function returns a 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. |