?gelss

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 7/13/2023

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-99719D94-02B6-402C-A5C5-F83867776CDC

View Details

?gelss

Computes the minimum-norm solution to a linear least squares problem using the singular value decomposition of A.

Syntax

call sgelss(m, n, nrhs, a, lda, b, ldb, s, rcond, rank, work, lwork, info)

call dgelss(m, n, nrhs, a, lda, b, ldb, s, rcond, rank, work, lwork, info)

call cgelss(m, n, nrhs, a, lda, b, ldb, s, rcond, rank, work, lwork, rwork, info)

call zgelss(m, n, nrhs, a, lda, b, ldb, s, rcond, rank, work, lwork, rwork, info)

call gelss(a, b [,rank] [,s] [,rcond] [,info])

Include Files

mkl.fi, lapack.f90

Description

The routine computes the minimum norm solution to a real linear least squares problem:

minimize ||b - A*x||₂

using the singular value decomposition (SVD) of A. A is an m-by-n matrix which may be rank-deficient. Several right hand side vectors b and solution vectors x can be handled in a single call; they are stored as the columns of the m-by-nrhs right hand side matrix B and the n-by-nrhs solution matrix X. The effective rank of A is determined by treating as zero those singular values which are less than rcond times the largest singular value.

Input Parameters

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 sgelss

DOUBLE PRECISION for dgelss

COMPLEX for cgelss

DOUBLE COMPLEX for zgelss.

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 m-by-nrhs right hand side matrix B.

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).

rcond

REAL for single-precision flavors

DOUBLE PRECISION for double-precision flavors.

rcond is used to determine the effective rank of A. Singular values s(i) ≤rcond *s(1) are treated as zero.

If rcond <0, machine precision is used instead.

lwork

INTEGER. The size of the work array; lwork≥ 1.

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.

rwork

REAL for cgelss

DOUBLE PRECISION for zgelss.

Workspace array used in complex flavors only. size at least max(1, 5*min(m, n)).

Output Parameters

a

On exit, the first min(m, n) rows of a are overwritten with the matrix of right singular vectors of A, stored row-wise.

b

Overwritten by the n-by-nrhs solution matrix X.

If m≥n and rank = n, the residual sum-of-squares for the solution in the i-th column is given by the sum of squares of modulus of elements n+1:m in that column.

s

REAL for single precision flavors

DOUBLE PRECISION for double precision flavors.

Array, size at least max(1, min(m, n)). The singular values of A in decreasing order. The condition number of A in the 2-norm is

k₂(A) = s(1)/ s(min(m, n)) .

rank

INTEGER. The effective rank of A, that is, the number of singular values which are greater than rcond *s(1).

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, then the algorithm for computing the SVD failed to converge; i indicates the number of off-diagonal elements of an intermediate bidiagonal form which did not converge to zero.

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 gelss interface are the following:

a: Holds the matrix A of size (m,n).
b: Holds the matrix of size max(m,n)-by-nrhs. On entry, contains the m-by-nrhs right hand side matrix B, On exit, overwritten by the n-by-nrhs solution matrix X.
s: Holds the vector of length min(m,n).
rcond: Default value for this element is rcond = 100*EPSILON(1.0_WP).

Application Notes

For real flavors:

lwork≥ 3*min(m, n)+ max( 2*min(m, n), max(m, n), nrhs)

For complex flavors:

lwork≥ 2*min(m, n)+ max(m, n, nrhs)

For good performance, lwork should generally be larger.

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

?gelss

Syntax

Include Files

Description

Input Parameters

Output Parameters

LAPACK 95 Interface Notes

Application Notes