# NAG FL Interfacef08nsf (zgehrd)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

f08nsf reduces a complex general matrix to Hessenberg form.

## 2Specification

Fortran Interface
 Subroutine f08nsf ( n, ilo, ihi, a, lda, tau, work, info)
 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))
#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.

## 3Description

f08nsf reduces a complex general matrix $A$ to upper Hessenberg form $H$ by a unitary similarity transformation: $A=QH{Q}^{\mathrm{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:
 $( A11 A12 A13 A22 A23 A33 )$
where ${A}_{11}$ and ${A}_{33}$ are upper triangular. If so, only the central diagonal block ${A}_{22}$, in rows and columns ${i}_{\mathrm{lo}}$ to ${i}_{\mathrm{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}_{\mathrm{lo}}$ and ${i}_{\mathrm{hi}}$ determined by f08nvf can be supplied to the routine directly. If f08nvf has not previously been called however, then ${i}_{\mathrm{lo}}$ must be set to $1$ and ${i}_{\mathrm{hi}}$ to $n$.

## 4References

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

## 5Arguments

1: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
2: $\mathbf{ilo}$Integer Input
3: $\mathbf{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 ${\mathbf{n}}>0$, $1\le {\mathbf{ilo}}\le {\mathbf{ihi}}\le {\mathbf{n}}$;
• if ${\mathbf{n}}=0$, ${\mathbf{ilo}}=1$ and ${\mathbf{ihi}}=0$.
4: $\mathbf{a}\left({\mathbf{lda}},*\right)$Complex (Kind=nag_wp) array Input/Output
Note: the second dimension of the array a must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry: the $n×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: $\mathbf{lda}$Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f08nsf is called.
Constraint: ${\mathbf{lda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
6: $\mathbf{tau}\left(*\right)$Complex (Kind=nag_wp) array Output
Note: the dimension of the array tau must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}-1\right)$.
On exit: further details of the unitary matrix $Q$.
7: $\mathbf{work}\left(\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{lwork}}\right)\right)$Complex (Kind=nag_wp) array Workspace
On exit: if ${\mathbf{info}}={\mathbf{0}}$, the real part of ${\mathbf{work}}\left(1\right)$ contains the minimum value of lwork required for optimal performance.
8: $\mathbf{lwork}$Integer Input
On entry: the dimension of the array work as declared in the (sub)program from which f08nsf is called.
If ${\mathbf{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, ${\mathbf{lwork}}\ge {\mathbf{n}}×\mathit{nb}$, where $\mathit{nb}$ is the optimal block size.
Constraint: ${\mathbf{lwork}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$ or ${\mathbf{lwork}}=-1$.
9: $\mathbf{info}$Integer Output
On exit: ${\mathbf{info}}=0$ unless the routine detects an error (see Section 6).

## 6Error Indicators and Warnings

$-999<{\mathbf{info}}<0$
If ${\mathbf{info}}=-i$, argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.
${\mathbf{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.

## 7Accuracy

The computed Hessenberg matrix $H$ is exactly similar to a nearby matrix $\left(A+E\right)$, where
 $‖E‖2 ≤ c (n) ε ‖A‖2 ,$
$c\left(n\right)$ is a modestly increasing function of $n$, and $\epsilon$ 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.

## 8Parallelism and Performance

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.

The total number of real floating-point operations is approximately $\frac{8}{3}{q}^{2}\left(2q+3n\right)$, where $q={i}_{\mathrm{hi}}-{i}_{\mathrm{lo}}$; if ${i}_{\mathrm{lo}}=1$ and ${i}_{\mathrm{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×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 $QC$.
The real analogue of this routine is f08nef.

## 10Example

This example computes the upper Hessenberg form of the matrix $A$, where
 $A = ( -3.97-5.04i -4.11+3.70i -0.34+1.01i 1.29-0.86i 0.34-1.50i 1.52-0.43i 1.88-5.38i 3.36+0.65i 3.31-3.85i 2.50+3.45i 0.88-1.08i 0.64-1.48i -1.10+0.82i 1.81-1.59i 3.25+1.33i 1.57-3.44i ) .$

### 10.1Program Text

Program Text (f08nsfe.f90)

### 10.2Program Data

Program Data (f08nsfe.d)

### 10.3Program Results

Program Results (f08nsfe.r)