Developer Reference for Intel® oneAPI Math Kernel Library for C
?ungql
Generates the complex matrix Q of the QL factorization formed by ?geqlf .
Syntax
lapack_intLAPACKE_cungql ( intmatrix_layout , lapack_intm , lapack_intn , lapack_intk , lapack_complex_float*a , lapack_intlda , constlapack_complex_float*tau );
lapack_intLAPACKE_zungql ( intmatrix_layout , lapack_intm , lapack_intn , lapack_intk , lapack_complex_double*a , lapack_intlda , constlapack_complex_double*tau );
Include Files
mkl.h
Description
cungql zungql ungql
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
- matrix_layout
-
Specifies whether matrix storage layout is row major ( LAPACK_ROW_MAJOR ) or column major ( LAPACK_COL_MAJOR ).
m
The number of rows of the matrix Q ( m≥0 ).
n
The number of columns of the matrix Q ( m≥n≥0 ).
k
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 (size max(1, lda * n ) for column major layout and max(1, lda * m ) for row major layout) , tau .
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 - 1] 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
The leading dimension of a ; at least max(1, m ) for column major layout and max(1, n ) for row major layout .
lwork
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.
Return Values
This function returns a value info .
If info=0 , the execution is successful.
If info = -i , the i -th parameter had an illegal value.
LAPACK 95 Interface Notes
There exist FORTRAN 77 and FORTRAN 95 interfaces for this routine. See the Intel® oneMKL Fortran Developer Reference for details.
Application Notes
The real counterpart of this routine is orgql .