NAG Library Routine Document
f08nuf
(zunmhr)
1
Purpose
f08nuf (zunmhr) multiplies an arbitrary complex matrix
by the complex unitary matrix
which was determined by
f08nsf (zgehrd) when reducing a complex general matrix to Hessenberg form.
2
Specification
Fortran Interface
Subroutine f08nuf ( |
side,
trans,
m,
n,
ilo,
ihi,
a,
lda,
tau,
c,
ldc,
work,
lwork,
info) |
Integer, Intent (In) | :: |
m,
n,
ilo,
ihi,
lda,
ldc,
lwork | Integer, Intent (Out) | :: |
info | Complex (Kind=nag_wp), Intent (In) | :: |
tau(*) | Complex (Kind=nag_wp), Intent (Inout) | :: |
a(lda,*),
c(ldc,*) | Complex (Kind=nag_wp), Intent (Out) | :: |
work(max(1,lwork)) | Character (1), Intent (In) | :: |
side,
trans |
|
C Header Interface
#include nagmk26.h
void |
f08nuf_ (
const char *side,
const char *trans,
const Integer *m,
const Integer *n,
const Integer *ilo,
const Integer *ihi,
Complex a[],
const Integer *lda,
const Complex tau[],
Complex c[],
const Integer *ldc,
Complex work[],
const Integer *lwork,
Integer *info,
const Charlen length_side,
const Charlen length_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
to upper Hessenberg form
by a unitary similarity transformation:
.
f08nsf (zgehrd) represents the matrix
as a product of
elementary reflectors. Here
and
are values determined by
f08nvf (zgebal) when balancing the matrix; if the matrix has not been balanced,
and
.
This routine may be used to form one of the matrix products
overwriting the result on
(which may be any complex rectangular matrix).
A common application of this routine is to transform a matrix of eigenvectors of to the matrix of eigenvectors of .
4
References
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5
Arguments
- 1: – Character(1)Input
-
On entry: indicates how
or
is to be applied to
.
- or is applied to from the left.
- or is applied to from the right.
Constraint:
or .
- 2: – Character(1)Input
-
On entry: indicates whether
or
is to be applied to
.
- is applied to .
- is applied to .
Constraint:
or .
- 3: – IntegerInput
-
On entry: , the number of rows of the matrix ; is also the order of if .
Constraint:
.
- 4: – IntegerInput
-
On entry: , the number of columns of the matrix ; is also the order of if .
Constraint:
.
- 5: – IntegerInput
- 6: – IntegerInput
-
On entry: these
must be the same arguments
ilo and
ihi, respectively, as supplied to
f08nsf (zgehrd).
Constraints:
- if and , ;
- if and , and ;
- if and , ;
- if and , and .
- 7: – Complex (Kind=nag_wp) arrayInput
-
Note: the second dimension of the array
a
must be at least
if
and at least
if
.
On entry: details of the vectors which define the elementary reflectors, as returned by
f08nsf (zgehrd).
- 8: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08nuf (zunmhr) is called.
Constraints:
- if , ;
- if , .
- 9: – Complex (Kind=nag_wp) arrayInput
-
Note: the dimension of the array
tau
must be at least
if
and at least
if
.
On entry: further details of the elementary reflectors, as returned by
f08nsf (zgehrd).
- 10: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
c
must be at least
.
On entry: the by matrix .
On exit:
c is overwritten by
or
or
or
as specified by
side and
trans.
- 11: – IntegerInput
-
On entry: the first dimension of the array
c as declared in the (sub)program from which
f08nuf (zunmhr) is called.
Constraint:
.
- 12: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
- 13: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08nuf (zunmhr) is called.
If
, 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, if and at least if , where is the optimal block size.
Constraints:
- if , or ;
- if , or .
- 14: – IntegerOutput
On exit:
unless the routine detects an error (see
Section 6).
6
Error Indicators and Warnings
-
If , argument 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
such that
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.
The total number of real floating-point operations is approximately if and if , where .
The real analogue of this routine is
f08ngf (dormhr).
10
Example
This example computes all the eigenvalues of the matrix
, where
and those eigenvectors which correspond to eigenvalues
such that
. Here
is general and must first be reduced to upper Hessenberg form
by
f08nsf (zgehrd). The program then calls
f08psf (zhseqr) to compute the eigenvalues, and
f08pxf (zhsein) to compute the required eigenvectors of
by inverse iteration. Finally
f08nuf (zunmhr) is called to transform the eigenvectors of
back to eigenvectors of the original matrix
.
10.1
Program Text
Program Text (f08nufe.f90)
10.2
Program Data
Program Data (f08nufe.d)
10.3
Program Results
Program Results (f08nufe.r)