Sets an estimate of the number and type of upcoming mkl_sparse_?_sorv operations.
sparse_status_t mkl_sparse_set_sorv_hint( const sparse_sor_type_t type, const sparse_matrix_t A, const struct matrix_descr descr, const MKL_INT expected_calls );
Use the mkl_sparse_set_sorv_hint routine to provide the Inspector-Executor Sparse BLAS API an estimate of the number of upcoming forward/backward sweeps or symmetric SOR preconditioner operations for performance optimization.
Product and Performance Information |
---|
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex. Notice revision #20201201 |
Specifies the operation performed by the SORV preconditioner.
SPARSE_SOR_FORWARD |
Performs forward sweep as defined by: |
SPARSE_SOR_BACKWARD |
Performs backward sweep as defined by: |
SPARSE_SOR_SYMMETRIC |
Preconditioner matrix could be expressed as: |
Structure 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:
|
Handle containing internal data.
Estimate of the number of calls to the execution routine.
Handle containing internal data.
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. |