Developer Reference

  • 2020.2
  • 07/15/2020
  • Public Content
Contents

mkl_sparse_set_symgs_hint

Syntax

Sets estimate of number and type of upcoming
mkl_sparse_?_symgs
operations.
stat =
mkl_sparse_set_symgs_hint
(
A
,
operation
,
descr
,
layout
,
dense_matrix_size
,
expected_calls
)
Include Files
  • mkl_spblas.f90
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-Zeidel preconditioner operations for performance optimization, and specify whether or not to perform an operation on the matrix.
Input Parameters
operation
C_INT
.
Specifies the operation performed on matrix
A
.
If
operation
=
SPARSE_OPERATION_NON_TRANSPOSE
,
op(
A
) =
A
.
If
operation
=
SPARSE_OPERATION_TRANSPOSE
,
op(
A
) =
A
T
.
If
operation
=
SPARSE_OPERATION_CONJUGATE_TRANSPOSE
,
op(
A
) =
A
H
.
descr
MATRIX_DESCR
.
Descriptor
specifying sparse matrix properties.
type
- 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 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.
mode
- 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.
diag
- Specifies 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.
diag
C_INT
.
Specifies diagonal type for non-general matrices
mode
C_INT
.
Specifies the triangular matrix part for symmetric, Hermitian, triangular, and block-triangular matrices.
type
C_INT
.
Specifies the type of a sparse matrix.
expected_calls
C_INT
.
Estimate of the number to the execution routine.
Output Parameters
A
SPARSE_MATRIX_T
.
Handle containing internal data.
stat
INTEGER
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