f01qj: FL CL CPP AD PY MB

NAG FL Interface
f01qjf (real_gen_rq)

Keyword Search:

NAG Library Manual, Mark 30.1

Interfaces: FL CL CPP AD PY MB

NAG FL Interface Introduction

F01 (Matop) Chapter Contents

F01 (Matop) Chapter Introduction

f01qj: FL CL CPP AD PY MB

▸▿ 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

1 Purpose

f01qjf finds the

R Q

factorization of the real

m \times n

(

m \leq n

) matrix

A

, so that

A

is reduced to upper triangular form by means of orthogonal transformations from the right.

2 Specification

Fortran Interface

Subroutine f01qjf (

m, n, a, lda, zeta, ifail)

Integer, Intent (In)	::	m, n, lda
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (Inout)	::	a(lda,*)
Real (Kind=nag_wp), Intent (Out)	::	zeta(m)

C Header Interface

#include <nag.h>

void	f01qjf_ (const Integer m, const Integer n, double a[], const Integer lda, double zeta[], Integer ifail)

The routine may be called by the names f01qjf or nagf_matop_real_gen_rq.

3 Description

The

m \times n

matrix

A

is factorized as

\begin{array}{l} A = (\begin{matrix} R & 0 \end{matrix}) P^{T} & when m < n, \\ A = R P^{T} & when m = n, \end{array}

where

P

is an

n \times n

orthogonal matrix and

R

is an

m \times m

upper triangular matrix.

P

is given as a sequence of Householder transformation matrices

P = P_{m} \dots P_{2} P_{1},

the (

m - k + 1

)th transformation matrix,

P_{k}

, being used to introduce zeros into the

k

th row of

A

P_{k}

has the form

P_{k} = I - u_{k} u_{k}^{T},

where

u_{k} = (\begin{array}{l} w_{k} \\ ζ_{k} \\ 0 \\ z_{k} \end{array}),

ζ_{k}

is a scalar,

w_{k}

is an

(k - 1)

element vector and

z_{k}

is an

(n - m)

element vector.

u_{k}

is chosen to annihilate the elements in the

k

th row of

A

The vector

u_{k}

is returned in the

k

th element of zeta and in the

k

th row of a, such that

ζ_{k}

is in

zeta (k)

, the elements of

w_{k}

are in

a (k, 1), \dots, a (k, k - 1)

and the elements of

z_{k}

are in

a (k, m + 1), \dots, a (k, n)

. The elements of

R

are returned in the upper triangular part of a.

4 References

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

Wilkinson J H (1965) The Algebraic Eigenvalue Problem Oxford University Press, Oxford

5 Arguments

1: $m$ – Integer Input: On entry: $m$ , the number of rows of the matrix $A$ .
When $m = 0$ then an immediate return is effected.

Constraint: $m \geq 0$ .
2: $n$ – Integer Input: On entry: $n$ , the number of columns of the matrix $A$ .

Constraint: $n \geq m$ .
3: $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 $m \times n$ part of the array a must contain the matrix to be factorized.

On exit: the $m \times m$ upper triangular part of a will contain the upper triangular matrix $R$ , and the $m \times m$ strictly lower triangular part of a and the $m \times (n - m)$ rectangular part of a to the right of the upper triangular part will contain details of the factorization as described in Section 3.
4: $lda$ – Integer Input: On entry: the first dimension of the array a as declared in the (sub)program from which f01qjf is called.

Constraint: $lda \geq \max (1, m)$ .
5: $zeta (m)$ – Real (Kind=nag_wp) array Output: On exit: $zeta (k)$ contains the scalar $ζ_{k}$ for the $(m - k + 1)$ th transformation. If $P_{k} = I$ then $zeta (k) = 0.0$ , otherwise $zeta (k)$ contains $ζ_{k}$ as described in Section 3 and $ζ_{k}$ is always in the range $(1.0, \sqrt{2.0})$ .
6: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $−1$ or $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$ or $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$: On entry, $lda = ⟨ value ⟩$ and $m = ⟨ value ⟩$ .
Constraint: $lda \geq m$ .

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

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

$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

R

and

P

satisfy the relation

(\begin{matrix} R & 0 \end{matrix}) P^{T} = A + E,

where

‖ E ‖ \leq c ε ‖ A ‖,

ε

is the machine precision (see x02ajf),

c

is a modest function of

m

and

n

, and

‖ . ‖

denotes the spectral (two) norm.

8 Parallelism and Performance

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

f01qjf 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

The approximate number of floating-point operations is given by

2 \times m^{2} (3 n - m) / 3

The first

k

rows of the orthogonal matrix

P^{T}

can be obtained by calling f01qkf, which overwrites the

k

rows of

P^{T}

on the first

k

rows of the array a.

P^{T}

is obtained by the call:

ifail = 0
Call f01qkf('Separate',m,n,k,a,lda,zeta,work,ifail)

WORK

must be a

\max (m - 1, k - m, 1)

element array. If

K

is larger than

M

, then a must have been declared to have at least

K

rows.

Operations involving the matrix

R

can readily be performed by the Level 2 BLAS routines f06pff and f06pjf (see Chapter F06), but note that no test for near singularity of

R

is incorporated into f06pjf. If

R

is singular, or nearly singular then f02wuf can be used to determine the singular value decomposition of

R

10 Example

This example obtains the

R Q

factorization of the

3 \times 5

matrix

A = (\begin{array}{r} 2.0 & 2.0 & 1.6 & 2.0 & 1.2 \\ 2.5 & 2.5 & - 0.4 & - 0.5 & - 0.3 \\ 2.5 & 2.5 & 2.8 & 0.5 & - 2.9 \end{array}) .

f01qj: FL CL CPP AD PY MB

NAG FL Interfacef01qjf (real_​gen_​rq)

▸▿ 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
f01qjf (real_gen_rq)