Developer Reference for Intel® oneAPI Math Kernel Library for C
mkl_sparse_set_sorv_hint
Sets an estimate of the number and type of upcoming mkl_sparse_?_sorv operations.
Syntax
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 );Include Files
mkl_spblas.h
Description
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 |
Input Parameters
type
Specifies the operation performed by the SORV preconditioner:
SPARSE_SOR_FORWARD |
Performs forward sweep as defined by: \((\omega\cdot L + D)\cdot x^{1} = (D - \omega\cdot D - \omega\cdot U)\cdot x^{0} + \omega\cdot b\) |
SPARSE_SOR_BACKWARD |
Performs backward sweep as defined by: \((\omega\cdot U + D)\cdot x^{1} = (D - \omega\cdot D - \omega\cdot L)\cdot x^{0} + \omega\cdot b\) |
SPARSE_SOR_SYMMETRIC |
Preconditioner matrix could be expressed as: \(\frac{\omega}{2-\omega}\left(\frac{1}{\omega}D + L\right)D^{-1}\left(\frac{1}{\omega}D+L\right)^{T}\) |
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:
|
A
Handle containing internal data.
expected_calls
Estimate of the number of calls 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. |