Developer Reference for Intel® oneAPI Math Kernel Library for C
?geqlf
Computes the QL factorization of a general m-by-n matrix.
Syntax
lapack_intLAPACKE_sgelqf ( intmatrix_layout , lapack_intm , lapack_intn , float*a , lapack_intlda , float*tau );
lapack_intLAPACKE_dgelqf ( intmatrix_layout , lapack_intm , lapack_intn , double*a , lapack_intlda , double*tau );
lapack_intLAPACKE_cgelqf ( intmatrix_layout , lapack_intm , lapack_intn , lapack_complex_float*a , lapack_intlda , lapack_complex_float*tau );
lapack_intLAPACKE_zgelqf ( intmatrix_layout , lapack_intm , lapack_intn , lapack_complex_double*a , lapack_intlda , lapack_complex_double*tau );
Include Files
mkl.h
Description
sgeqlf dgeqlf cgeqlf zgeqlf geqlf
The routine forms the QL factorization of a general m -by- n matrix A (see Orthogonal Factorizations ). No pivoting is performed.
The routine does not form the matrix Q explicitly. Instead, Q is represented as a product of min( m , n ) elementary reflectors . Routines are provided to work with Q in this representation.
This routine supports the Progress Routine feature. See Progress Function for details.
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 in the matrix A ( m≥ 0 ).
n
The number of columns in A ( n≥ 0 ).
- a , work
-
REAL for sgeqlf DOUBLE PRECISION for dgeqlf COMPLEX for cgeqlf DOUBLE COMPLEX for zgeqlf . Arrays:
Array a of size max(1, lda * n ) for column major layout and max(1, lda * m ) for row major layout contains the matrix A .
The second dimension of a must be at least max(1, n ). 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 on exit by the factorization data as follows: if m≥n , the lower triangle of the subarray a ( m - n +1: m , 1: n ) contains the n -by- n lower triangular matrix L ; if m≤n , the elements on and below the ( n - m )-th superdiagonal contain the m -by- n lower trapezoidal matrix L ; in both cases, the remaining elements, with the array tau , represent the orthogonal/unitary matrix Q as a product of elementary reflectors.
- tau
-
REAL for sgeqlf DOUBLE PRECISION for dgeqlf COMPLEX for cgeqlf DOUBLE COMPLEX for zgeqlf . Array, size at least max(1, min( m , n )). Contains scalar factors of the elementary reflectors for the matrix Q (see Orthogonal Factorizations ).
- work(1)
-
If info = 0 , on exit work(1) contains the minimum value of lwork required for optimum performance.
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
Related routines include:
to generate matrix Q (for real matrices);
to generate matrix Q (for complex matrices);
to apply matrix Q (for real matrices);
to apply matrix Q (for complex matrices).