Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/31/2023
Public

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

Document Table of Contents

?gerfs

Refines the solution of a system of linear equations with a general coefficient matrix and estimates its error.

Syntax

lapack_int LAPACKE_sgerfs( int matrix_layout, char trans, lapack_int n, lapack_int nrhs, const float* a, lapack_int lda, const float* af, lapack_int ldaf, const lapack_int* ipiv, const float* b, lapack_int ldb, float* x, lapack_int ldx, float* ferr, float* berr );

lapack_int LAPACKE_dgerfs( int matrix_layout, char trans, lapack_int n, lapack_int nrhs, const double* a, lapack_int lda, const double* af, lapack_int ldaf, const lapack_int* ipiv, const double* b, lapack_int ldb, double* x, lapack_int ldx, double* ferr, double* berr );

lapack_int LAPACKE_cgerfs( int matrix_layout, char trans, lapack_int n, lapack_int nrhs, const lapack_complex_float* a, lapack_int lda, const lapack_complex_float* af, lapack_int ldaf, const lapack_int* ipiv, const lapack_complex_float* b, lapack_int ldb, lapack_complex_float* x, lapack_int ldx, float* ferr, float* berr );

lapack_int LAPACKE_zgerfs( int matrix_layout, char trans, lapack_int n, lapack_int nrhs, const lapack_complex_double* a, lapack_int lda, const lapack_complex_double* af, lapack_int ldaf, const lapack_int* ipiv, const lapack_complex_double* b, lapack_int ldb, lapack_complex_double* x, lapack_int ldx, double* ferr, double* berr );

Include Files
  • mkl.h
Description

The routine performs an iterative refinement of the solution to a system of linear equations A*X = B or AT*X = B or AH*X = B with a general matrix A, with multiple right-hand sides. For each computed solution vector x, the routine computes the component-wise backward errorβ. This error is the smallest relative perturbation in elements of A and b such that x is the exact solution of the perturbed system:

|δaij| β|aij|, |δbi| β|bi| such that (A + δA)x = (b + δb).

Finally, the routine estimates the component-wise forward error in the computed solution ||x - xe||/||x|| (here xe is the exact solution).

Before calling this routine:

  • call the factorization routine ?getrf

  • call the solver routine ?getrs.

Input Parameters

matrix_layout

Specifies whether matrix storage layout is row major (LAPACK_ROW_MAJOR) or column major (LAPACK_COL_MAJOR).

trans

Must be 'N' or 'T' or 'C'.

Indicates the form of the equations:

If trans = 'N', the system has the form A*X = B.

If trans = 'T', the system has the form AT*X = B.

If trans = 'C', the system has the form AH*X = B.

n

The order of the matrix A; n 0.

nrhs

The number of right-hand sides; nrhs 0.

a,af,b,x

Arrays:

a(size max(1, lda*n)) contains the original matrix A, as supplied to ?getrf.

af(size max(1, ldaf*n)) contains the factored matrix A, as returned by ?getrf.

bof size max(1, ldb*nrhs) for column major layout and max(1, ldb*n) for row major layout contains the right-hand side matrix B.

xof size max(1, ldx*nrhs) for column major layout and max(1, ldx*n) for row major layout contains the solution matrix X.

lda

The leading dimension of a; lda max(1, n).

ldaf

The leading dimension of af; ldaf max(1, n).

ldb

The leading dimension of b; ldb max(1, n) for column major layout and ldbnrhs for row major layout.

ldx

The leading dimension of x; ldx max(1, n) for column major layout and ldxnrhs for row major layout.

ipiv

Array, size at least max(1, n).

The ipiv array, as returned by ?getrf.

Output Parameters

x

The refined solution matrix X.

ferr, berr

Arrays, size at least max(1, nrhs). Contain the component-wise forward and backward errors, respectively, for each solution vector.

Return Values

This function returns a value info.

If info = 0, the execution is successful.

If info = -i, parameter i had an illegal value.

Application Notes

The bounds returned in ferr are not rigorous, but in practice they almost always overestimate the actual error.

For each right-hand side, computation of the backward error involves a minimum of 4n2 floating-point operations (for real flavors) or 16n2 operations (for complex flavors). In addition, each step of iterative refinement involves 6n2 operations (for real flavors) or 24n2 operations (for complex flavors); the number of iterations may range from 1 to 5. Estimating the forward error involves solving a number of systems of linear equations A*x = b with the same coefficient matrix A and different right hand sides b; the number is usually 4 or 5 and never more than 11. Each solution requires approximately 2n2 floating-point operations for real flavors or 8n2 for complex flavors.