Integer, Intent (In)	::	n, ilo, ihi, lda, lwork
Integer, Intent (Out)	::	info
Complex (Kind=nag_wp), Intent (Inout)	::	a(lda,), tau()
Complex (Kind=nag_wp), Intent (Out)	::	work(max(1,lwork))

C Header Interface

#include <nag.h>

void	f08nsf_ (const Integer n, const Integer ilo, const Integer ihi, Complex a[], const Integer lda, Complex tau[], Complex work[], const Integer lwork, Integer info)

The routine may be called by the names f08nsf, nagf_lapackeig_zgehrd or its LAPACK name zgehrd.

3 Description

f08nsf reduces a complex general matrix

A

to upper Hessenberg form

H

by a unitary similarity transformation:

A = Q H Q^{H}

H

has real subdiagonal elements.

The matrix

Q

is not formed explicitly, but is represented as a product of elementary reflectors (see the F08 Chapter Introduction for details). Routines are provided to work with

Q

in this representation (see Section 9).

The routine can take advantage of a previous call to f08nvf, which may produce a matrix with the structure:

(\begin{matrix} A_{11} & A_{12} & A_{13} \\ A_{22} & A_{23} \\ A_{33} \end{matrix})

where

A_{11}

and

A_{33}

are upper triangular. If so, only the central diagonal block

A_{22}

, in rows and columns

i_{lo}

i_{hi}

, needs to be reduced to Hessenberg form (the blocks

A_{12}

and

A_{23}

will also be affected by the reduction). Therefore, the values of

i_{lo}

and

i_{hi}

determined by f08nvf can be supplied to the routine directly. If f08nvf has not previously been called however, then

i_{lo}

must be set to

1

and

i_{hi}

n

4 References

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

5 Arguments

1: $n$ – Integer Input

On entry:

n

, the order of the matrix

A

Constraint:

n \geq 0

2: $ilo$ – Integer Input

3: $ihi$ – Integer Input

On entry: if

A

has been output by f08nvf, ilo and ihi must contain the values returned by that routine. Otherwise, ilo must be set to

1

and ihi to n.

Constraints:

if $n > 0$ , $1 \leq ilo \leq ihi \leq n$ ;
if $n = 0$ , $ilo = 1$ and $ihi = 0$ .

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

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

\max (1, n)

On entry: the

n \times n

general matrix

A

On exit: a is overwritten by the upper Hessenberg matrix

H

and details of the unitary matrix

Q

. The subdiagonal elements of

H

are real.

5: $lda$ – Integer Input

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

Constraint:

lda \geq \max (1, n)

6: $tau (*)$ – Complex (Kind=nag_wp) array Output

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

\max (1, n - 1)

On exit: further details of the unitary matrix

Q

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

On exit: if

info = 0

, the real part of

work (1)

contains the minimum value of lwork required for optimal performance.

8: $lwork$ – Integer Input

On entry: the dimension of the array work as declared in the (sub)program from which f08nsf 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

, where

nb

is the optimal block size.

Constraint:

lwork \geq \max (1, n)

lwork = −1

9: $info$ – Integer Output

On exit:

info = 0

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

6 Error Indicators and Warnings

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

$info = - 999$: Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.
An explanatory message is output, and execution of the program is terminated.

7 Accuracy

The computed Hessenberg matrix

H

is exactly similar to a nearby matrix

(A + E)

, where

{‖ E ‖}_{2} \leq c (n) ε {‖ A ‖}_{2},

c (n)

is a modestly increasing function of

n

, and

ε

is the machine precision.

The elements of

H

themselves may be sensitive to small perturbations in

A

or to rounding errors in the computation, but this does not affect the stability of the eigenvalues, eigenvectors or Schur factorization.

8 Parallelism and Performance

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

f08nsf 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

\frac{8}{3} q^{2} (2 q + 3 n)

, where

q = i_{hi} - i_{lo}

; if

i_{lo} = 1

and

i_{hi} = n

, the number is approximately

\frac{40}{3} n^{3}

To form the unitary matrix

Q

f08nsf may be followed by a call to f08ntf :

Call zunghr(n,ilo,ihi,a,lda,tau,work,lwork,info)

To apply

Q

to an

m \times n

complex matrix

C

f08nsf may be followed by a call to f08nuf. For example,

Call zunmhr('Left','No Transpose',m,n,ilo,ihi,a,lda,tau,c,ldc, &
              work,lwork,info)

forms the matrix product

Q C

The real analogue of this routine is f08nef.

10 Example

This example computes the upper Hessenberg form 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}) .

f08ns: FL CL CPP AD PY MB

NAG FL Interfacef08nsf (zgehrd)

▸▿ 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
f08nsf (zgehrd)