NAG CL Interface
f08cfc (dorgql)

Settings help

CL Name Style:


1 Purpose

f08cfc generates all or part of the real m×m orthogonal matrix Q from a QL factorization computed by f08cec.

2 Specification

#include <nag.h>
void  f08cfc (Nag_OrderType order, Integer m, Integer n, Integer k, double a[], Integer pda, const double tau[], NagError *fail)
The function may be called by the names: f08cfc, nag_lapackeig_dorgql or nag_dorgql.

3 Description

f08cfc is intended to be used after a call to f08cec, which performs a QL factorization of a real matrix A. The orthogonal matrix Q is represented as a product of elementary reflectors.
This function may be used to generate Q explicitly as a square matrix, or to form only its trailing columns.
Usually Q is determined from the QL factorization of an m×p matrix A with mp. The whole of Q may be computed by :
nag_lapackeig_dorgql(order,m,m,p,a,pda,tau,&fail)
(note that the array a must have at least m columns) or its trailing p columns by :
nag_lapackeig_dorgql(order,m,p,p,a,pda,tau,&fail)
The columns of Q returned by the last call form an orthonormal basis for the space spanned by the columns of A; thus f08cec followed by f08cfc can be used to orthogonalize the columns of A.
The information returned by f08cec also yields the QL factorization of the trailing k columns of A, where k<p. The orthogonal matrix arising from this factorization can be computed by :
nag_lapackeig_dorgql(order,m,m,k,a,pda,tau,&fail)
or its trailing k columns by :
nag_lapackeig_dorgql(order,m,k,k,a,pda,tau,&fail)

4 References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia https://www.netlib.org/lapack/lug
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5 Arguments

1: order Nag_OrderType Input
On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by order=Nag_RowMajor. See Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2: m Integer Input
On entry: m, the number of rows of the matrix Q.
Constraint: m0.
3: n Integer Input
On entry: n, the number of columns of the matrix Q.
Constraint: mn0.
4: k Integer Input
On entry: k, the number of elementary reflectors whose product defines the matrix Q.
Constraint: nk0.
5: a[dim] double Input/Output
Note: the dimension, dim, of the array a must be at least
  • max(1,pda×n) when order=Nag_ColMajor;
  • max(1,m×pda) when order=Nag_RowMajor.
On entry: details of the vectors which define the elementary reflectors, as returned by f08cec.
On exit: the m×n matrix Q.
6: pda Integer Input
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraints:
  • if order=Nag_ColMajor, pdamax(1,m);
  • if order=Nag_RowMajor, pdamax(1,n).
7: tau[dim] const double Input
Note: the dimension, dim, of the array tau must be at least max(1,k).
On entry: further details of the elementary reflectors, as returned by f08cec.
8: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, m=value.
Constraint: m0.
On entry, pda=value.
Constraint: pda>0.
NE_INT_2
On entry, m=value and n=value.
Constraint: mn0.
On entry, n=value and k=value.
Constraint: nk0.
On entry, pda=value and m=value.
Constraint: pdamax(1,m).
On entry, pda=value and n=value.
Constraint: pdamax(1,n).
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

7 Accuracy

The computed matrix Q differs from an exactly orthogonal matrix by a matrix E such that
E2 = O(ε) ,  
where ε is the machine precision.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f08cfc 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 function. 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 4mnk-2 (m+n) k2 + 43 k3 ; when n=k, the number is approximately 23 n2 (3m-n) .
The complex analogue of this function is f08ctc.

10 Example

This example generates the first four columns of the matrix Q of the QL factorization of A as returned by f08cec, where
A = ( -0.57 -1.28 -0.39 0.25 -1.93 1.08 -0.31 -2.14 2.30 0.24 0.40 -0.35 -1.93 0.64 -0.66 0.08 0.15 0.30 0.15 -2.13 -0.02 1.03 -1.43 0.50 ) .  

10.1 Program Text

Program Text (f08cfce.c)

10.2 Program Data

Program Data (f08cfce.d)

10.3 Program Results

Program Results (f08cfce.r)