Integer, Intent (In)	::	m, n, ilo, ihi, lda, ldc, lwork
Integer, Intent (Out)	::	info
Real (Kind=nag_wp), Intent (In)	::	tau(*)
Real (Kind=nag_wp), Intent (Inout)	::	a(lda,), c(ldc,)
Real (Kind=nag_wp), Intent (Out)	::	work(max(1,lwork))
Character (1), Intent (In)	::	side, trans

C Header Interface

#include <nag.h>

void

f08ngf_ (const char *side, const char *trans, const Integer *m, const Integer *n, const Integer *ilo, const Integer *ihi, double a[], const Integer *lda, const double tau[], double c[], const Integer *ldc, double work[], const Integer *lwork, Integer *info, const Charlen length_side, const Charlen length_trans)

The routine may be called by the names f08ngf, nagf_lapackeig_dormhr or its LAPACK name dormhr.

3 Description

f08ngf is intended to be used following a call to f08nef, which reduces a real general matrix

A

to upper Hessenberg form

H

by an orthogonal similarity transformation:

A = Q H Q^{T}

. f08nef represents the matrix

Q

as a product of

i_{hi} - i_{lo}

elementary reflectors. Here

i_{lo}

and

i_{hi}

are values determined by f08nhf when balancing the matrix; if the matrix has not been balanced,

i_{lo} = 1

and

i_{hi} = n

This routine may be used to form one of the matrix products

Q C, Q^{T} C, C Q ​ or ​ C Q^{T},

overwriting the result on

C

(which may be any real rectangular matrix).

A common application of this routine is to transform a matrix

V

of eigenvectors of

H

to the matrix

QV

of eigenvectors of

A

4 References

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

5 Arguments

1: $side$ – Character(1) Input

On entry: indicates how

Q

Q^{T}

is to be applied to

C

$side ='L'$: $Q$ or $Q^{T}$ is applied to $C$ from the left.
$side ='R'$: $Q$ or $Q^{T}$ is applied to $C$ from the right.

Constraint:

side ='L'

'R'

2: $trans$ – Character(1) Input

On entry: indicates whether

Q

Q^{T}

is to be applied to

C

$trans ='N'$: $Q$ is applied to $C$ .
$trans ='T'$: $Q^{T}$ is applied to $C$ .

Constraint:

trans ='N'

'T'

3: $m$ – Integer Input

On entry:

m

, the number of rows of the matrix

C

;

m

is also the order of

Q

side ='L'

Constraint:

m \geq 0

4: $n$ – Integer Input

On entry:

n

, the number of columns of the matrix

C

;

n

is also the order of

Q

side ='R'

Constraint:

n \geq 0

5: $ilo$ – Integer Input

6: $ihi$ – Integer Input

On entry: these must be the same arguments ilo and ihi, respectively, as supplied to f08nef.

Constraints:

if $side ='L'$ and $m > 0$ , $1 \leq ilo \leq ihi \leq m$ ;
if $side ='L'$ and $m = 0$ , $ilo = 1$ and $ihi = 0$ ;
if $side ='R'$ and $n > 0$ , $1 \leq ilo \leq ihi \leq n$ ;
if $side ='R'$ and $n = 0$ , $ilo = 1$ and $ihi = 0$ .

7: $a (lda, *)$ – Real (Kind=nag_wp) array Input

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

\max (1, m)

side ='L'

and at least

\max (1, n)

side ='R'

On entry: details of the vectors which define the elementary reflectors, as returned by f08nef.

8: $lda$ – Integer Input

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

Constraints:

if $side ='L'$ , $lda \geq \max (1, m)$ ;
if $side ='R'$ , $lda \geq \max (1, n)$ .

9: $tau (*)$ – Real (Kind=nag_wp) array Input

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

\max (1, m - 1)

side ='L'

and at least

\max (1, n - 1)

side ='R'

On entry: further details of the elementary reflectors, as returned by f08nef.

10: $c (ldc, *)$ – Real (Kind=nag_wp) array Input/Output

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

\max (1, n)

On entry: the

m \times n

matrix

C

On exit: c is overwritten by

Q C

Q^{T} C

C Q

C Q^{T}

as specified by side and trans.

11: $ldc$ – Integer Input

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

Constraint:

ldc \geq \max (1, m)

12: $work (\max (1, lwork))$ – Real (Kind=nag_wp) array Workspace

On exit: if

info = 0

work (1)

contains the minimum value of lwork required for optimal performance.

13: $lwork$ – Integer Input

On entry: the dimension of the array work as declared in the (sub)program from which f08ngf is called.

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 \geq n \times nb

side ='L'

and at least

m \times nb

side ='R'

, where

nb

is the optimal block size.

Constraints:

if $side ='L'$ , $lwork \geq \max (1, n)$ or $lwork = −1$ ;
if $side ='R'$ , $lwork \geq \max (1, m)$ or $lwork = −1$ .

14: $info$ – Integer Output

On exit:

info = 0

unless the routine detects an error (see Section 6).

6 Error Indicators and Warnings

$info < 0$: If $info = - i$ , argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

7 Accuracy

The computed result differs from the exact result by a matrix

E

such that

{‖ E ‖}_{2} = O (ε) {‖ C ‖}_{2},

where

ε

is the machine precision.

8 Parallelism and Performance

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

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

f08ngf 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 total number of floating-point operations is approximately

2 n q^{2}

side ='L'

and

2 m q^{2}

side ='R'

, where

q = i_{hi} - i_{lo}

The complex analogue of this routine is f08nuf.

10 Example

This example computes all the eigenvalues of the matrix

A

, where

A = (\begin{array}{r} 0.35 & 0.45 & - 0.14 & - 0.17 \\ 0.09 & 0.07 & - 0.54 & 0.35 \\ - 0.44 & - 0.33 & - 0.03 & 0.17 \\ 0.25 & - 0.32 & - 0.13 & 0.11 \end{array}),

and those eigenvectors which correspond to eigenvalues

λ

such that

Re (λ) < 0

. Here

A

is general and must first be reduced to upper Hessenberg form

H

by f08nef. The program then calls f08pef to compute the eigenvalues, and f08pkf to compute the required eigenvectors of

H

by inverse iteration. Finally f08ngf is called to transform the eigenvectors of

H

back to eigenvectors of the original matrix

A

f08ng: FL CL CPP AD PY MB

NAG FL Interfacef08ngf (dormhr)

▸▿ 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
f08ngf (dormhr)