NAG Library Routine Document

f08anf (zgels)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{trans}$ – Character(1)Input

On entry: if $\mathbf{trans}=\text{'N'}$, the linear system involves $A$.

If $\mathbf{trans}=\text{'C'}$, the linear system involves $A^{\mathrm{H}}$.

Constraint: $\mathbf{trans}=\text{'N'}$ or $\text{'C'}$.

2:     $\mathbf{m}$ – IntegerInput

On entry: $m$, the number of rows of the matrix $A$.

Constraint: $\mathbf{m}\ge 0$.

3:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the number of columns of the matrix $A$.

Constraint: $\mathbf{n}\ge 0$.

4:     $\mathbf{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$.

5:     $\mathbf{a}\left(\mathbf{lda},*\right)$ – 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$ matrix $A$.

On exit: if $\mathbf{m}\ge \mathbf{n}$, a is overwritten by details of its $QR$ factorization, as returned by f08asf (zgeqrf).

If $\mathbf{m}<\mathbf{n}$, a is overwritten by details of its $LQ$ factorization, as returned by f08avf (zgelqf).

6:     $\mathbf{lda}$ – IntegerInput

On entry: the first dimension of the array a as declared in the (sub)program from which f08anf (zgels) is called.

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

7:     $\mathbf{b}\left(\mathbf{ldb},*\right)$ – 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 matrix $B$ of right-hand side vectors, stored in columns; b is $m$ by $r$ if $\mathbf{trans}=\text{'N'}$, or $n$ by $r$ if $\mathbf{trans}=\text{'C'}$.

On exit: b is overwritten by the solution vectors, $x$, stored in columns:

• if $\mathbf{trans}=\text{'N'}$ and $m\ge n$, or $\mathbf{trans}=\text{'C'}$ and $m<n$, elements $1$ to $\min \left(m,n\right)$ in each column of b contain the least squares solution vectors; the residual sum of squares for the solution is given by the sum of squares of the modulus of elements $\left(\min \left(m,n\right)+1\right)$ to $\max \left(m,n\right)$ in that column;
• otherwise, elements $1$ to $\max \left(m,n\right)$ in each column of b contain the minimum norm solution vectors.

8:     $\mathbf{ldb}$ – IntegerInput

On entry: the first dimension of the array b as declared in the (sub)program from which f08anf (zgels) is called.

Constraint: $\mathbf{ldb}\ge \max \left(1,\mathbf{m},\mathbf{n}\right)$.

9:     $\mathbf{work}\left(\max \left(1,\mathbf{lwork}\right)\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.

10:   $\mathbf{lwork}$ – IntegerInput

On entry: the dimension of the array work as declared in the (sub)program from which f08anf (zgels) 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, $\mathbf{lwork}\ge \min \left(\mathbf{m},\mathbf{n}\right)+\max \left(1,\mathbf{m},\mathbf{n},\mathbf{nrhs}\right)\times \mathit{nb}$, where $\mathit{nb}$ is the optimal block size.

Constraint: $\mathbf{lwork}\ge \min \left(\mathbf{m},\mathbf{n}\right)+\max \left(1,\mathbf{m},\mathbf{n},\mathbf{nrhs}\right)$ or $\mathbf{lwork}=-1$.

11:   $\mathbf{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$

Diagonal element $〈\mathit{\text{value}}〉$ of the triangular factor of $A$ is zero, so that $A$ does not have full rank; the least squares solution could not be computed.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f08anfe.f90)

10.2

Program Data

Program Data (f08anfe.d)

10.3

Program Results

Program Results (f08anfe.r)