NAG Library Routine Document

F08KQF (ZGELSD)

1  Purpose

2  Specification

3  Description

4  References

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,$*$) – COMPLEX (KIND=nag_wp) arrayInput/Output

Note: the second dimension of the array A must be at least $\max \left(1,\mathbf{N}\right)$.

On entry: the $m$ by $n$ coefficient matrix $A$.

On exit: the contents of A are destroyed.

5:     LDA – INTEGERInput

On entry: the first dimension of the array A as declared in the (sub)program from which F08KQF (ZGELSD) is called.

Constraint: $\mathbf{LDA}\ge \max \left(1,\mathbf{M}\right)$.

6:     B(LDB,$*$) – COMPLEX (KIND=nag_wp) arrayInput/Output

Note: the second dimension of the array B must be at least $\max \left(1,\mathbf{NRHS}\right)$.

On entry: the $m$ by $r$ right-hand side matrix $B$.

On exit: B is overwritten by the $n$ by $r$ solution matrix $X$. If $m\ge n$ and $\mathbf{RANK}=n$, the residual sum of squares for the solution in the $i$th column is given by the sum of squares of the modulus of elements $n+1,\dots ,m$ in that column.

7:     LDB – INTEGERInput

On entry: the first dimension of the array B as declared in the (sub)program from which F08KQF (ZGELSD) is called.

Constraint: $\mathbf{LDB}\ge \max \left(1,\mathbf{M},\mathbf{N}\right)$.

8:     S($*$) – REAL (KIND=nag_wp) arrayOutput

Note: the dimension of the array S must be at least $\max \left(1,\min \left(\mathbf{M},\mathbf{N}\right)\right)$.

On exit: the singular values of $A$ in decreasing order.

9:     RCOND – REAL (KIND=nag_wp)Input

On entry: used to determine the effective rank of $A$. Singular values $\mathbf{S}\left(i\right)\le \mathbf{RCOND}\times \mathbf{S}\left(1\right)$ are treated as zero. If $\mathbf{RCOND}<0$, machine precision is used instead.

10:   RANK – INTEGEROutput

On exit: the effective rank of $A$, i.e., the number of singular values which are greater than $\mathbf{RCOND}\times \mathbf{S}\left(1\right)$.

11:   WORK($\max \left(1,\mathbf{LWORK}\right)$) – COMPLEX (KIND=nag_wp) arrayWorkspace

On exit: if $\mathbf{INFO}=\mathbf{0}$, the real part of $\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 F08KQF (ZGELSD) is called.

The exact minimum amount of workspace needed depends on M, N and NRHS. As long as LWORK is at least

$$\max \left(1,\mathbf{M}+\mathbf{N}+r,2r+r\times \mathbf{NRHS}\right)\text{,}$$

where $r=\min \left(\mathbf{M},\mathbf{N}\right)$, the code will execute correctly.

If $\mathbf{LWORK}=-1$, a workspace query is assumed; the routine only calculates the optimal size of the WORK array and the minimum size of the IWORK array, and returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK is issued.

Suggested value: for optimal performance, LWORK should generally be larger than the required minimum. Consider increasing LWORK by at least $\mathit{nb}\times \min \left(\mathbf{M},\mathbf{N}\right)$, where $\mathit{nb}$ is the optimal block size.

Constraint: LWORK must be at least $\max \left(1,\mathbf{M}+\mathbf{N}+r,2r+r\times \mathbf{NRHS}\right)$ or $\mathbf{LWORK}=-1$.

13:   RWORK($*$) – REAL (KIND=nag_wp) arrayWorkspace

Note: the dimension of the array RWORK must be at least $\max \left(1,\mathit{lrwork}\right)$, where $\mathit{lrwork}$ is at least

$$10\times \mathbf{N}+2\times \mathbf{N}\times \mathit{smlsiz}+8\times \mathbf{N}\times \mathit{nlvl}+3\times \mathit{smlsiz}\times \mathbf{NRHS}+{\left(\mathit{smlsiz}+1\right)}^2\text{, \hspace{1em} if }\mathbf{M}\ge \mathbf{N}$$

or

$$10\times \mathbf{M}+2\times \mathbf{M}\times \mathit{smlsiz}+8\times \mathbf{M}\times \mathit{nlvl}+3\times \mathit{smlsiz}\times \mathbf{NRHS}+{\left(\mathit{smlsiz}+1\right)}^2\text{, \hspace{1em} if }\mathbf{M}<\mathbf{N}$$

where $\mathit{smlsiz}$ is equal to the maximum size of the subproblems at the bottom of the computation tree (usually about $25$), and $\mathit{nlvl}=\max \left(0,\mathrm{int}\left({\log }_2\left(\min \left(\mathbf{M},\mathbf{N}\right)/\left(\mathit{smlsiz}+1\right)\right)\right)+1\right)$, the code will execute correctly.

On exit: if $\mathbf{INFO}=\mathbf{0}$, $\mathbf{RWORK}\left(1\right)$ contains the required minimal size of $\mathit{lrwork}$.

14:   IWORK($*$) – INTEGER arrayWorkspace

Note: the dimension of the array IWORK must be at least $\max \left(1,\mathit{liwork}\right)$, where $\mathit{liwork}$ is at least $\max \left(1,3\times \min \left(\mathbf{M},\mathbf{N}\right)\times \mathit{nlvl}+11\times \min \left(\mathbf{M},\mathbf{N}\right)\right)$.

On exit: if $\mathbf{INFO}=\mathbf{0}$, $\mathbf{IWORK}\left(1\right)$ returns the minimum $\mathit{liwork}$.

15:   INFO – INTEGEROutput

On exit: $\mathbf{INFO}=0$ unless the routine detects an error (see Section 6).

6  Error Indicators and Warnings

$\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.

$\mathbf{INFO}>0$

The algorithm for computing the SVD failed to converge; if $\mathbf{INFO}=i$, $i$ off-diagonal elements of an intermediate bidiagonal form did not converge to zero.

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (f08kqfe.f90)

9.2  Program Data

Program Data (f08kqfe.d)

9.3  Program Results

Program Results (f08kqfe.r)