F08 Chapter Contents
F08 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentF08BAF (DGELSY)

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

F08BAF (DGELSY) computes the minimum norm solution to a real linear least squares problem
 $minx b-Ax2$
using a complete orthogonal factorization 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.

## 2  Specification

 SUBROUTINE F08BAF ( M, N, NRHS, A, LDA, B, LDB, JPVT, RCOND, RANK, WORK, LWORK, INFO)
 INTEGER M, N, NRHS, LDA, LDB, JPVT(*), RANK, LWORK, INFO REAL (KIND=nag_wp) A(LDA,*), B(LDB,*), RCOND, WORK(max(1,LWORK))
The routine may be called by its LAPACK name dgelsy.

## 3  Description

The right-hand side vectors are stored as the columns of the $m$ by $r$ matrix $B$ and the solution vectors in the $n$ by $r$ matrix $X$.
F08BAF (DGELSY) first computes a $QR$ factorization with column pivoting
 $AP= Q R11 R12 0 R22 ,$
with ${R}_{11}$ defined as the largest leading sub-matrix whose estimated condition number is less than $1/{\mathbf{RCOND}}$. The order of ${R}_{11}$, RANK, is the effective rank of $A$.
Then, ${R}_{22}$ is considered to be negligible, and ${R}_{12}$ is annihilated by orthogonal transformations from the right, arriving at the complete orthogonal factorization
 $AP= Q T11 0 0 0 Z .$
The minimum norm solution is then
 $X = PZT T11-1 Q1T b 0$
where ${Q}_{1}$ consists of the first RANK columns of $Q$.

## 4  References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia http://www.netlib.org/lapack/lug
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

## 5  Parameters

1:     M – INTEGERInput
On entry: $m$, the number of rows of the matrix $A$.
Constraint: ${\mathbf{M}}\ge 0$.
2:     N – INTEGERInput
On entry: $n$, the number of columns of the matrix $A$.
Constraint: ${\mathbf{N}}\ge 0$.
3:     NRHS – INTEGERInput
On entry: $r$, the number of right-hand sides, i.e., the number of columns of the matrices $B$ and $X$.
Constraint: ${\mathbf{NRHS}}\ge 0$.
4:     A(LDA,$*$) – REAL (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array A must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{N}}\right)$.
On entry: the $m$ by $n$ matrix $A$.
On exit: A has been overwritten by details of its complete orthogonal factorization.
5:     LDA – INTEGERInput
On entry: the first dimension of the array A as declared in the (sub)program from which F08BAF (DGELSY) is called.
Constraint: ${\mathbf{LDA}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{M}}\right)$.
6:     B(LDB,$*$) – REAL (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array B must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{NRHS}}\right)$.
On entry: the $m$ by $r$ right-hand side matrix $B$.
On exit: the $n$ by $r$ solution matrix $X$.
7:     LDB – INTEGERInput
On entry: the first dimension of the array B as declared in the (sub)program from which F08BAF (DGELSY) is called.
Constraint: ${\mathbf{LDB}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{M}},{\mathbf{N}}\right)$.
8:     JPVT($*$) – INTEGER arrayInput/Output
Note: the dimension of the array JPVT must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{N}}\right)$.
On entry: if ${\mathbf{JPVT}}\left(i\right)\ne 0$, the $i$th column of $A$ is permuted to the front of $AP$, otherwise column $i$ is a free column.
On exit: if ${\mathbf{JPVT}}\left(i\right)=k$, then the $i$th column of $AP$ was the $k$th column of $A$.
9:     RCOND – REAL (KIND=nag_wp)Input
On entry: used to determine the effective rank of $A$, which is defined as the order of the largest leading triangular sub-matrix ${R}_{11}$ in the $QR$ factorization of $A$, whose estimated condition number is $\text{}<1/{\mathbf{RCOND}}$.
Suggested value: if the condition number of A is not known then ${\mathbf{RCOND}}=\sqrt{\left(\epsilon \right)/2}$ (where $\epsilon$ is machine precision, see X02AJF) is a good choice. Negative values or values less than machine precision should be avoided since this will cause A to have an effective $\text{rank}=\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{M}},{\mathbf{N}}\right)$ that could be larger than its actual rank, leading to meaningless results.
10:   RANK – INTEGEROutput
On exit: the effective rank of $A$, i.e., the order of the sub-matrix ${R}_{11}$. This is the same as the order of the sub-matrix ${T}_{11}$ in the complete orthogonal factorization of $A$.
11:   WORK($\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{LWORK}}\right)$) – REAL (KIND=nag_wp) arrayWorkspace
On exit: if ${\mathbf{INFO}}={\mathbf{0}}$, ${\mathbf{WORK}}\left(1\right)$ contains the minimum value of LWORK required for optimal performance.
12:   LWORK – INTEGERInput
On entry: the dimension of the array WORK as declared in the (sub)program from which F08BAF (DGELSY) is called.
If ${\mathbf{LWORK}}=-1$, 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.
Suggested value: for optimal performance,
 $LWORK ≥ max k + 2 × N + nb × N+1 , 2 × k + nb × NRHS ,$
where $k=\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{M}},{\mathbf{N}}\right)$ and $\mathit{nb}$ is the optimal block size.
Constraint: ${\mathbf{LWORK}}\ge k+\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(2×k,{\mathbf{N}}+1,k+{\mathbf{NRHS}}\right)\text{, where ​}k=\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{M}},{\mathbf{N}}\right)$ or
${\mathbf{LWORK}}=-1$.
13:   INFO – INTEGEROutput
On exit: ${\mathbf{INFO}}=0$ unless the routine detects an error (see Section 6).

## 6  Error Indicators and Warnings

Errors or warnings detected by the routine:
${\mathbf{INFO}}<0$
If ${\mathbf{INFO}}=-i$, argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

## 7  Accuracy

See Section 4.5 of Anderson et al. (1999) for details of error bounds.

The complex analogue of this routine is F08BNF (ZGELSY).

## 9  Example

This example solves the linear least squares problem
 $minx b-Ax2$
for the solution, $x$, of minimum norm, where
 $A = -0.09 0.14 -0.46 0.68 1.29 -1.56 0.20 0.29 1.09 0.51 -1.48 -0.43 0.89 -0.71 -0.96 -1.09 0.84 0.77 2.11 -1.27 0.08 0.55 -1.13 0.14 1.74 -1.59 -0.72 1.06 1.24 0.34 and b= 7.4 4.2 -8.3 1.8 8.6 2.1 .$
A tolerance of $0.01$ is used to determine the effective rank of $A$.
Note that the block size (NB) of $64$ assumed in this example is not realistic for such a small problem, but should be suitable for large problems.

### 9.1  Program Text

Program Text (f08bafe.f90)

### 9.2  Program Data

Program Data (f08bafe.d)

### 9.3  Program Results

Program Results (f08bafe.r)