Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_set_qr_hint
Define the pivot strategy for further calls of mkl_sparse_?_qr .
Syntax
sparse_status_t mkl_sparse_set_qr_hint ( sparse_matrix_t A,
sparse_qr_hint_t hint );
Include Files
mkl_sparse_qr.h
Description
Allows to provide hints or suggestions to Sparse QR solver indicating different variations of the QR algorithm that should be employed, for instance if the matrix is ill-conditioned, a pivoting strategy can be turned on via the hints.
Input Parameters
A
Handle containing a sparse matrix in an internal data structure.
hint
Value specifying hints for Sparse QR decomposition.
sparse_qr_hint_t |
Description |
|---|---|
SPARSE_QR_WITH_PIVOTS |
Enables use of a pivoting strategy for ill-conditioned matrices |
Output Parameters
See Return Values for output status.
Return Values
Value indicating whether the operation was successful, and if not, 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. |