?gels

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 6/24/2024

Version

Public

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

Visible to Intel only — GUID: GUID-6AA5572D-7411-4E99-9022-F35254DAE9AB

View Details

?gels

Uses QR or LQ factorization to solve a overdetermined or underdetermined linear system with full rank matrix.

Syntax

call sgels(trans, m, n, nrhs, a, lda, b, ldb, work, lwork, info)

call dgels(trans, m, n, nrhs, a, lda, b, ldb, work, lwork, info)

call cgels(trans, m, n, nrhs, a, lda, b, ldb, work, lwork, info)

call zgels(trans, m, n, nrhs, a, lda, b, ldb, work, lwork, info)

call gels(a, b [,trans] [,info])

Include Files

mkl.fi, lapack.f90

Description

The routine solves overdetermined or underdetermined real/ complex linear systems involving an m-by-n matrix A, or its transpose/ conjugate-transpose, using a QR or LQ factorization of A. It is assumed that A has full rank.

The following options are provided:

1. If trans = 'N' and m≥n: find the least squares solution of an overdetermined system, that is, solve the least squares problem

minimize ||b - A*x||₂

2. If trans = 'N' and m < n: find the minimum norm solution of an underdetermined system A*X = B.

3. If trans = 'T' or 'C' and m≥n: find the minimum norm solution of an undetermined system A^H*X = B.

4. If trans = 'T' or 'C' and m < n: find the least squares solution of an overdetermined system, that is, solve the least squares problem

minimize ||b - A^H*x||₂

Several right hand side vectors b and solution vectors x can be handled in a single call; they are formed by the columns of the right hand side matrix B and the solution matrix X (when coefficient matrix is A, B is m-by-nrhs and X is n-by-nrhs; if the coefficient matrix is A^T or A^H, B isn-by-nrhs and X is m-by-nrhs.

Input Parameters

trans

CHARACTER*1. Must be 'N', 'T', or 'C'.

If trans = 'N', the linear system involves matrix A;

If trans = 'T', the linear system involves the transposed matrix A^T (for real flavors only);

If trans = 'C', the linear system involves the conjugate-transposed matrix A^H (for complex flavors only).

m

INTEGER. The number of rows of the matrix A (m≥ 0).

n

INTEGER. The number of columns of the matrix A

(n≥ 0).

nrhs

INTEGER. The number of right-hand sides; the number of columns in B (nrhs≥ 0).

a, b, work

REAL for sgels

DOUBLE PRECISION for dgels

COMPLEX for cgels

DOUBLE COMPLEX for zgels.

Arrays:

a(lda,*) contains the m-by-n matrix A.

The second dimension of a must be at least max(1, n).

b(ldb,*) contains the matrix B of right hand side vectors.

The second dimension of b must be at least max(1, nrhs).

work is a workspace array, its dimension max(1, lwork).

lda

INTEGER. The leading dimension of a; at least max(1, m).

ldb

INTEGER. The leading dimension of b; must be at least max(1, m, n).

lwork

INTEGER. The size of the work array; must be at least min (m, n)+max(1, m, n, nrhs).

If lwork = -1, then a workspace query is assumed; the routine only calculates the optimal size of the work array, returns this value as the first entry of the work array, and no error message related to lwork is issued by xerbla.

See Application Notes for the suggested value of lwork.

Output Parameters

a

On exit, overwritten by the factorization data as follows:

if m≥n, array a contains the details of the QR factorization of the matrix A as returned by ?geqrf;

if m < n, array a contains the details of the LQ factorization of the matrix A as returned by ?gelqf.

b

If info = 0, b overwritten by the solution vectors, stored columnwise:

if trans = 'N' and m≥n, rows 1 to n of b contain the least squares solution vectors; the residual sum of squares for the solution in each column is given by the sum of squares of modulus of elements n+1 to m in that column;

if trans = 'N' and m < n, rows 1 to n of b contain the minimum norm solution vectors;

if trans = 'T' or 'C' and m≥n, rows 1 to m of b contain the minimum norm solution vectors;

if trans = 'T' or 'C' and m < n, rows 1 to m of b contain the least squares solution vectors; the residual sum of squares for the solution in each column is given by the sum of squares of modulus of elements m+1 to n in that column.

work(1)

If info = 0, on exit work(1) contains the minimum value of lwork required for optimum performance. Use this lwork for subsequent runs.

info

INTEGER.

If info = 0, the execution is successful.

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

If info = i, the i-th diagonal element of the triangular factor of A is zero, so that A does not have full rank; the least squares solution could not be computed.

LAPACK 95 Interface Notes

Routines in Fortran 95 interface have fewer arguments in the calling sequence than their FORTRAN 77 counterparts. For general conventions applied to skip redundant or restorable arguments, see LAPACK 95 Interface Conventions.

Specific details for the routine gels interface are the following:

a

Holds the matrix A of size (m,n).

b

Holds the matrix of size max(m,n)-by-nrhs.

If trans = 'N', then, on entry, the size of b is m-by-nrhs,

If trans = 'T', then, on entry, the size of b is n-by-nrhs,

trans

Must be 'N' or 'T'. The default value is 'N'.

Application Notes

For better performance, try using lwork = min (m, n)+max(1, m, n, nrhs)*blocksize, where blocksize is a machine-dependent value (typically, 16 to 64) required for optimum performance of the blocked algorithm.

If you are in doubt how much workspace to supply, use a generous value of lwork for the first run or set lwork = -1.

If you choose the first option and set any of admissible lwork sizes, which is no less than the minimal value described, the routine completes the task, though probably not so fast as with a recommended workspace, and provides the recommended workspace in the first element of the corresponding array work on exit. Use this value (work(1)) for subsequent runs.

If you set lwork = -1, the routine returns immediately and provides the recommended workspace in the first element of the corresponding array (work). This operation is called a workspace query.

Note that if you set lwork to less than the minimal required value and not -1, the routine returns immediately with an error exit and does not provide any information on the recommended workspace.

Parent topic: Linear Least Squares (LLS) Problems: LAPACK Driver Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

?gels

Syntax

Include Files

Description

Input Parameters

Output Parameters

LAPACK 95 Interface Notes

Application Notes