?ungql

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 3/22/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-4D522855-9FC7-499A-81AB-AB8D7A110A72

View Details

?ungql

Generates the complex matrix Q of the QL factorization formed by ?geqlf.

Syntax

call cungql(m, n, k, a, lda, tau, work, lwork, info)

call zungql(m, n, k, a, lda, tau, work, lwork, info)

call ungql(a, tau [,info])

Include Files

mkl.fi, lapack.f90

Description

The routine generates an m-by-n complex matrix Q with orthonormal columns, which is defined as the last n columns of a product of k elementary reflectors H(i) of order m: Q = H(k) *...* H(2)*H(1) as returned by the routines geqlf/geqlf . Use this routine after a call to cgeqlf/zgeqlf.

Input Parameters

m

INTEGER. The number of rows of the matrix Q (m≥0).

n

INTEGER. The number of columns of the matrix Q (m≥n≥0).

k

INTEGER. The number of elementary reflectors whose product defines the matrix Q (n≥k≥0).

a, tau, work

COMPLEX for cungql

DOUBLE COMPLEX for zungql

Arrays: a(lda,*), tau(*), work(lwork).

On entry, the (n - k + i)th column of a must contain the vector which defines the elementary reflector H(i), for i = 1,2,...,k, as returned by cgeqlf/zgeqlf in the last k columns of its array argument a;

tau(i) must contain the scalar factor of the elementary reflector H(i), as returned by cgeqlf/zgeqlf;

The second dimension of a must be at least max(1, n).

The size of tau must be at least max(1, k).

work is a workspace array, its dimension max(1, lwork).

lda

INTEGER. The leading dimension of a; at least max(1, m).

lwork

INTEGER. The size of the work array; at least max(1, n).

If lwork = -1, then 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 by xerbla.

See Application Notes for the suggested value of lwork.

Output Parameters

a

Overwritten by the last n columns of the m-by-m unitary matrix Q.

work(1)

If info = 0, on exit work(1) contains the minimum value of lwork required for optimum performance. Use this lwork for subsequent runs.

info

INTEGER.

If info = 0, the execution is successful.

If info = -i, the i-th parameter had an illegal value.

LAPACK 95 Interface Notes

Routines in Fortran 95 interface have fewer arguments in the calling sequence than their FORTRAN 77 counterparts. For general conventions applied to skip redundant or restorable arguments, see LAPACK 95 Interface Conventions.

Specific details for the routine ungql interface are the following:

a: Holds the matrix A of size (m,n).
tau: Holds the vector of length (k).

Application Notes

For better performance, try using lwork =n*blocksize, where blocksize is a machine-dependent value (typically, 16 to 64) required for optimum performance of the blocked algorithm.

If it is not clear how much workspace to supply, use a generous value of lwork for the first run, or set lwork = -1.

In first case the routine completes the task, though probably not so fast as with a recommended workspace, and provides the recommended workspace in the first element of the corresponding array work on exit. Use this value (work(1)) for subsequent runs.

If lwork = -1, then the routine returns immediately and provides the recommended workspace in the first element of the corresponding array (work). This operation is called a workspace query.

Note that if lwork is less than the minimal required value and is not equal to -1, then the routine returns immediately with an error exit and does not provide any information on the recommended workspace.

The real counterpart of this routine is orgql.

Parent topic: Orthogonal Factorizations: LAPACK Computational Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

?ungql

Syntax

Include Files

Description

Input Parameters

Output Parameters

LAPACK 95 Interface Notes

Application Notes