Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

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

You can use this routine to enable a pivot strategy in the case of an ill-conditioned matrix.

Input Parameters

A

Handle containing a sparse matrix in an internal data structure.

hint

Value specifying whether to use pivoting.

NOTE:
The only value currently supported is SPARSE_QR_WITH_PIVOTS, which enables the use of a pivot strategy for an ill-conditioned matrix.

Return Values

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.