F08NGF (DORMHR) (PDF version)
F08 Chapter Contents
F08 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

F08NGF (DORMHR)

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

F08NGF (DORMHR) multiplies an arbitrary real matrix C by the real orthogonal matrix Q which was determined by F08NEF (DGEHRD) when reducing a real general matrix to Hessenberg form.

2  Specification

SUBROUTINE F08NGF ( SIDE, TRANS, M, N, ILO, IHI, A, LDA, TAU, C, LDC, WORK, LWORK, INFO)
INTEGER  M, N, ILO, IHI, LDA, LDC, LWORK, INFO
REAL (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 dormhr.

3  Description

F08NGF (DORMHR) is intended to be used following a call to F08NEF (DGEHRD), which reduces a real general matrix A to upper Hessenberg form H by an orthogonal similarity transformation: A=QHQT. F08NEF (DGEHRD) represents the matrix Q as a product of ihi-ilo elementary reflectors. Here ilo and ihi are values determined by F08NHF (DGEBAL) when balancing the matrix; if the matrix has not been balanced, ilo=1 and ihi=n.
This routine may be used to form one of the matrix products
QC , QTC , CQ ​ or ​ CQT ,  
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  Parameters

1:     SIDE – CHARACTER(1)Input
On entry: indicates how Q or QT is to be applied to C.
SIDE='L'
Q or QT is applied to C from the left.
SIDE='R'
Q or QT is applied to C from the right.
Constraint: SIDE='L' or 'R'.
2:     TRANS – CHARACTER(1)Input
On entry: indicates whether Q or QT is to be applied to C.
TRANS='N'
Q is applied to C.
TRANS='T'
QT is applied to C.
Constraint: TRANS='N' or 'T'.
3:     M – INTEGERInput
On entry: m, the number of rows of the matrix C; m is also the order of Q if SIDE='L'.
Constraint: M0.
4:     N – INTEGERInput
On entry: n, the number of columns of the matrix C; n is also the order of Q if SIDE='R'.
Constraint: N0.
5:     ILO – INTEGERInput
6:     IHI – INTEGERInput
On entry: these must be the same parameters ILO and IHI, respectively, as supplied to F08NEF (DGEHRD).
Constraints:
  • if SIDE='L' and M>0, 1 ILO IHI M ;
  • if SIDE='L' and M=0, ILO=1 and IHI=0;
  • if SIDE='R' and N>0, 1 ILO IHI N ;
  • if SIDE='R' and N=0, ILO=1 and IHI=0.
7:     ALDA* – REAL (KIND=nag_wp) arrayInput
Note: the second dimension of the array A must be at least max1,M if SIDE='L' and at least max1,N if SIDE='R'.
On entry: details of the vectors which define the elementary reflectors, as returned by F08NEF (DGEHRD).
8:     LDA – INTEGERInput
On entry: the first dimension of the array A as declared in the (sub)program from which F08NGF (DORMHR) is called.
Constraints:
  • if SIDE='L', LDA max1,M ;
  • if SIDE='R', LDA max1,N .
9:     TAU* – REAL (KIND=nag_wp) arrayInput
Note: the dimension of the array TAU must be at least max1,M-1 if SIDE='L' and at least max1,N-1 if SIDE='R'.
On entry: further details of the elementary reflectors, as returned by F08NEF (DGEHRD).
10:   CLDC* – REAL (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array C must be at least max1,N.
On entry: the m by n matrix C.
On exit: C is overwritten by QC or QTC or CQ or CQT 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 F08NGF (DORMHR) is called.
Constraint: LDCmax1,M.
12:   WORKmax1,LWORK – REAL (KIND=nag_wp) arrayWorkspace
On exit: if INFO=0, WORK1 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 F08NGF (DORMHR) is called.
If 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, LWORKN×nb if SIDE='L' and at least M×nb if SIDE='R', where nb is the optimal block size.
Constraints:
  • if SIDE='L', LWORKmax1,N or LWORK=-1;
  • if SIDE='R', LWORKmax1,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
E2 = Oε C2 ,  
where ε is the machine precision.

8  Parallelism and Performance

F08NGF (DORMHR) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
F08NGF (DORMHR) 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 2nq2 if SIDE='L' and 2mq2 if SIDE='R', where q=ihi-ilo.
The complex analogue of this routine is F08NUF (ZUNMHR).

10  Example

This example computes all the eigenvalues of the matrix A, where
A = 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 ,  
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 (DGEHRD). The program then calls F08PEF (DHSEQR) to compute the eigenvalues, and F08PKF (DHSEIN) to compute the required eigenvectors of H by inverse iteration. Finally F08NGF (DORMHR) is called to transform the eigenvectors of H back to eigenvectors of the original matrix A.

10.1  Program Text

Program Text (f08ngfe.f90)

10.2  Program Data

Program Data (f08ngfe.d)

10.3  Program Results

Program Results (f08ngfe.r)


F08NGF (DORMHR) (PDF version)
F08 Chapter Contents
F08 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2015