NAG Library Routine Document

F08NUF (ZUNMHR)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

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

F08NUF (ZUNMHR) multiplies an arbitrary complex matrix

C

by the complex unitary matrix

Q

which was determined by F08NSF (ZGEHRD) when reducing a complex general matrix to Hessenberg form.

2 Specification

SUBROUTINE F08NUF (

SIDE, TRANS, M, N, ILO, IHI, A, LDA, TAU, C, LDC, WORK, LWORK, INFO)

INTEGER	M, N, ILO, IHI, LDA, LDC, LWORK, INFO
COMPLEX (KIND=nag_wp)	A(LDA,), TAU(), C(LDC,*), WORK(max(1,LWORK))
CHARACTER(1)	SIDE, TRANS

The routine may be called by its LAPACK name zunmhr.

3 Description

F08NUF (ZUNMHR) is intended to be used following a call to F08NSF (ZGEHRD), which reduces a complex general matrix

A

to upper Hessenberg form

H

by a unitary similarity transformation:

A = Q H Q^{H}

. F08NSF (ZGEHRD) represents the matrix

Q

as a product of

i_{hi} - i_{lo}

elementary reflectors. Here

i_{lo}

and

i_{hi}

are values determined by F08NVF (ZGEBAL) 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^{H} C, C Q ​ or ​ C Q^{H},

overwriting the result on

C

(which may be any complex 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 Parameters

1: $SIDE$ – CHARACTER(1)Input

On entry: indicates how

Q

Q^{H}

is to be applied to

C

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

Constraint:

SIDE ='L'

'R'

2: $TRANS$ – CHARACTER(1)Input

On entry: indicates whether

Q

Q^{H}

is to be applied to

C

$TRANS ='N'$: $Q$ is applied to $C$ .
$TRANS ='C'$: $Q^{H}$ is applied to $C$ .

Constraint:

TRANS ='N'

'C'

3: $M$ – INTEGERInput

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$ – INTEGERInput

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$ – INTEGERInput

6: $IHI$ – INTEGERInput

On entry: these must be the same parameters ILO and IHI, respectively, as supplied to F08NSF (ZGEHRD).

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

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 F08NSF (ZGEHRD).

8: $LDA$ – INTEGERInput

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

Constraints:

if $SIDE ='L'$ , $LDA \geq \max (1, M)$ ;
if $SIDE ='R'$ , $LDA \geq \max (1, N)$ .

9: $TAU (*)$ – COMPLEX (KIND=nag_wp) arrayInput

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 F08NSF (ZGEHRD).

10: $C (LDC *)$ – COMPLEX (KIND=nag_wp) arrayInput/Output

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

\max (1, N)

On entry: the

m

n

matrix

C

On exit: C is overwritten by

Q C

Q^{H} C

C Q

C Q^{H}

as specified by SIDE and TRANS.

11: $LDC$ – INTEGERInput

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

Constraint:

LDC \geq \max (1, M)

12: $WORK (\max (1, LWORK))$ – COMPLEX (KIND=nag_wp) arrayWorkspace

On exit: if

INFO = 0

, the real part of

WORK (1)

contains the minimum value of LWORK required for optimal performance.

13: $LWORK$ – INTEGERInput

On entry: the dimension of the array WORK as declared in the (sub)program from which F08NUF (ZUNMHR) 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$ – INTEGEROutput

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

F08NUF (ZUNMHR) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

F08NUF (ZUNMHR) 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 real floating-point operations is approximately

8 n q^{2}

SIDE ='L'

and

8 m q^{2}

SIDE ='R'

, where

q = i_{hi} - i_{lo}

The real analogue of this routine is F08NGF (DORMHR).

10 Example

This example computes all the eigenvalues of the matrix

A

, where

A = (\begin{array}{r} - 3.97 - 5.04 i & - 4.11 + 3.70 i & - 0.34 + 1.01 i & 1.29 - 0.86 i \\ 0.34 - 1.50 i & 1.52 - 0.43 i & 1.88 - 5.38 i & 3.36 + 0.65 i \\ 3.31 - 3.85 i & 2.50 + 3.45 i & 0.88 - 1.08 i & 0.64 - 1.48 i \\ - 1.10 + 0.82 i & 1.81 - 1.59 i & 3.25 + 1.33 i & 1.57 - 3.44 i \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 F08NSF (ZGEHRD). The program then calls F08PSF (ZHSEQR) to compute the eigenvalues, and F08PXF (ZHSEIN) to compute the required eigenvectors of

H

by inverse iteration. Finally F08NUF (ZUNMHR) is called to transform the eigenvectors of

H

back to eigenvectors of the original matrix

A

NAG Library Routine DocumentF08NUF (ZUNMHR)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

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 Library Routine Document

F08NUF (ZUNMHR)