Integer, Intent (In)	::	n, lda, ncolb, ldb, ldq
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (Inout)	::	a(lda,), b(ldb,), q(ldq,), work()
Real (Kind=nag_wp), Intent (Out)	::	sv(n)
Logical, Intent (In)	::	wantq, wantp

C Header Interface

#include <nag.h>

void	f02wuf_ (const Integer n, double a[], const Integer lda, const Integer ncolb, double b[], const Integer ldb, const logical wantq, double q[], const Integer ldq, double sv[], const logical wantp, double work[], Integer ifail)

The routine may be called by the names f02wuf or nagf_eigen_real_triang_svd.

3 Description

The

n \times n

upper triangular matrix

R

is factorized as

R = Q S P^{T},

where

Q

and

P

are

n \times n

orthogonal matrices and

S

is an

n \times n

diagonal matrix with non-negative diagonal elements,

σ_{1}, σ_{2}, \dots, σ_{n}

, ordered such that

σ_{1} \geq σ_{2} \geq \dots \geq σ_{n} \geq 0 .

The columns of

Q

are the left-hand singular vectors of

R

, the diagonal elements of

S

are the singular values of

R

and the columns of

P

are the right-hand singular vectors of

R

Either or both of

Q

and

P^{T}

may be requested and the matrix

C

given by

C = Q^{T} B,

where

B

is an

n \times ncolb

given matrix, may also be requested.

The routine obtains the singular value decomposition by first reducing

R

to bidiagonal form by means of Givens plane rotations and then using the

Q R

algorithm to obtain the singular value decomposition of the bidiagonal form.

Good background descriptions to the singular value decomposition are given in Chan (1982), Dongarra et al. (1979), Golub and Van Loan (1996), Hammarling (1985) and Wilkinson (1978).

Note that if

K

is any orthogonal diagonal matrix so that

K K^{T} = I

(that is the diagonal elements of

K

are

+ 1

−1

) then

A = (Q K) S {(P K)}^{T}

is also a singular value decomposition of

A

4 References

Chan T F (1982) An improved algorithm for computing the singular value decomposition ACM Trans. Math. Software 8 72–83

Dongarra J J, Moler C B, Bunch J R and Stewart G W (1979) LINPACK Users' Guide SIAM, Philadelphia

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

Hammarling S (1985) The singular value decomposition in multivariate statistics SIGNUM Newsl. 20(3) 2–25

Wilkinson J H (1978) Singular Value Decomposition – Basic Aspects Numerical Software – Needs and Availability (ed D A H Jacobs) Academic Press

5 Arguments

1: $n$ – Integer Input

On entry:

n

, the order of the matrix

R

n = 0

, an immediate return is effected.

Constraint:

n \geq 0

2: $a (lda, *)$ – Real (Kind=nag_wp) array Input/Output

Note: the second dimension of the array a must be at least

\max (1, n)

On entry: the leading

n \times n

upper triangular part of the array a must contain the upper triangular matrix

R

On exit: if

wantp = .TRUE.

, the

n \times n

part of a will contain the

n \times n

orthogonal matrix

P^{T}

, otherwise the

n \times n

upper triangular part of a is used as internal workspace, but the strictly lower triangular part of a is not referenced.

3: $lda$ – Integer Input

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

Constraint:

lda \geq \max (1, n)

4: $ncolb$ – Integer Input

On entry:

ncolb

, the number of columns of the matrix

B

ncolb = 0

, the array b is not referenced.

Constraint:

ncolb \geq 0

5: $b (ldb, *)$ – Real (Kind=nag_wp) array Input/Output

Note: the second dimension of the array b must be at least

\max (1, ncolb)

On entry: with

ncolb > 0

, the leading

n \times ncolb

part of the array b must contain the matrix to be transformed.

On exit: the leading

n \times ncolb

part of the array b is overwritten by the matrix

Q^{T} B

6: $ldb$ – Integer Input

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

Constraints:

if $ncolb > 0$ , $ldb \geq \max (1, n)$ ;
otherwise $ldb \geq 1$ .

7: $wantq$ – Logical Input

On entry: must be .TRUE. if the matrix

Q

is required.

wantq = .FALSE.

, the array q is not referenced.

8: $q (ldq, *)$ – Real (Kind=nag_wp) array Output

Note: the second dimension of the array q must be at least

\max (1, n)

wantq = .TRUE.

, and at least

1

otherwise.

On exit: with

wantq = .TRUE.

, the leading

n \times n

part of the array q will contain the orthogonal matrix

Q

. Otherwise the array q is not referenced.

9: $ldq$ – Integer Input

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

Constraints:

if $wantq = .TRUE.$ , $ldq \geq \max (1, n)$ ;
otherwise $ldq \geq 1$ .

10: $sv (n)$ – Real (Kind=nag_wp) array Output

On exit:

If $ifail = 0$ the array sv will contain the diagonal elements of the matrix.
If $ifail = 1$ the array sv will contain the diagonal elements of the bidiagonal matrix $E$ in the factorization $R = Q E P^{T}$ ; the superdiagonal elements of $E$ will be contained in the first $n - 1$ elements of work.

11: $wantp$ – Logical Input

On entry: must be .TRUE. if the matrix

P^{T}

is required, in which case

P^{T}

is overwritten on the array a, otherwise wantp must be .FALSE..

12: $work (*)$ – Real (Kind=nag_wp) array Output

Note: the dimension of the array work must be at least

\max (1, 2 \times (n - 1))

ncolb = 0

and

wantq = .FALSE.

and

wantp = .FALSE.

\max (1, 3 \times (n - 1))

if (

ncolb = 0

and

wantq = .FALSE.

and

wantp = .TRUE.

) or (

wantp = .FALSE.

and (

ncolb > 0

wantq = .TRUE.

)), and at least

\max (1, 5 \times (n - 1))

otherwise.

On exit:

work (1 : n - 1)

contains the super-diagonal elements of the bidiagonal matrix

E

computed during the bidiagonalization stage;

work (n)

contains the total number of iterations taken by the

Q R

algorithm.

The rest of the array is used as internal workspace.

13: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: The $Q R$ algorithm has failed to converge. $⟨ value ⟩$ singular values have not been found.

$ifail = - 1$: On entry, $lda = ⟨ value ⟩$ and $n = ⟨ value ⟩$ .
Constraint: $lda \geq n$ .

On entry, $ldb = ⟨ value ⟩$ , $n = ⟨ value ⟩$ and $ncolb = ⟨ value ⟩$ .
Constraint: if $ncolb > 0$ , $ldb \geq n$ .

On entry, $ldq = ⟨ value ⟩$ and $n = ⟨ value ⟩$ .
Constraint: if $wantq = .TRUE.$ , $ldq \geq n$ .

On entry, $n = ⟨ value ⟩$ .
Constraint: $n \geq 0$ .

On entry, $ncolb = ⟨ value ⟩$ .
Constraint: $ncolb \geq 0$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

The computed factors

Q

S

and

P

satisfy the relation

Q S P^{T} = R + E,

where

‖ E ‖ \leq c ε ‖ A ‖,

ε

is the machine precision,

c

is a modest function of

n

and

‖ . ‖

denotes the spectral (two) norm. Note that

‖ A ‖ = sv (1)

A similar result holds for the computed matrix

Q^{T} B

The computed matrix

Q

satisfies the relation

Q = T + F,

where

T

is exactly orthogonal and

‖ F ‖ \leq d ε,

where

d

is a modest function of

n

. A similar result holds for

P

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

f02wuf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

f02wuf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

For given values of ncolb, wantq and wantp, the number of floating-point operations required is approximately proportional to

n^{3}

Following the use of this routine the rank of

R

may be estimated by a call to f06klf. The statement

irank = f06klf(n,sv,1,tol)

returns the value

(k - 1)

in irank, where

k

is the smallest integer for which

sv (k) < tol \times sv (1)

, and

tol

is the tolerance supplied in tol, so that irank is an estimate of the rank of

S

and thus also of

R

. If tol is supplied as negative then the machine precision is used in place of tol.

10 Example

This example finds the singular value decomposition of the

3 \times 3

upper triangular matrix

A = (\begin{array}{r} −4 & −2 & −3 \\ 0 & −3 & −2 \\ 0 & 0 & −4 \end{array}),

together with the vector

Q^{T} b

for the vector

b = (\begin{array}{r} −1 \\ −1 \\ −1 \end{array}) .

f02wu: FL CL CPP AD PY MB

NAG FL Interfacef02wuf (real_​triang_​svd)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
f02wuf (real_triang_svd)