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_?_qr_factorize

Factorization step of the SPARSE QR solver.

Syntax

sparse_status_t mkl_sparse_d_qr_factorize (sparse_matrix_t A, double *alt_values);

sparse_status_t mkl_sparse_s_qr_factorize (sparse_matrix_t A, float *alt_values);

Include Files

  • mkl_sparse_qr.h

Description

The mkl_sparse_?_qr_factorize routine performs numerical factorization of matrix A. Prior to calling this routine, the mkl_sparse_?_qr_reorder routine must be called for the matrix handle A. For more information about the workflow of sparse QR functionality, refer to oneMKL Sparse QR solver. Multifrontal Sparse QR Factorization Method for Solving a Sparse System of Linear Equations.

NOTE:
Currently, mkl_sparse_?_qr_factorize supports only CSR format for the input matrix.

Input Parameters

A

Handle containing a sparse matrix in an internal data structure.

alt_values

Array with alternative values. Must be the size of the non-zeroes in the initial input matrix. When passed to the routine, these values will be used during the factorization step instead of the values stored in handle A.

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.