Developer Reference for Intel® oneAPI Math Kernel Library for C
?geqr2
Computes the QR factorization of a general rectangular matrix using an unblocked algorithm.
Syntax
lapack_intLAPACKE_sgeqr2 ( intmatrix_layout , lapack_intm , lapack_intn , float*a , lapack_intlda , float*tau );
lapack_intLAPACKE_dgeqr2 ( intmatrix_layout , lapack_intm , lapack_intn , double*a , lapack_intlda , double*tau );
lapack_intLAPACKE_cgeqr2 ( intmatrix_layout , lapack_intm , lapack_intn , lapack_complex_float*a , lapack_intlda , lapack_complex_float*tau );
lapack_intLAPACKE_zgeqr2 ( intmatrix_layout , lapack_intm , lapack_intn , lapack_complex_double*a , lapack_intlda , lapack_complex_double*tau );
Include Files
mkl.h
Description
sgeqr2 dgeqr2 cgeqr2 zgeqr2
The routine computes a QR factorization of a real/complex m -by- n matrix A as A = Q*R .
The routine does not form the matrix Q explicitly. Instead, Q is represented as a product of min( m , n ) elementary reflectors :
Q = H(1)*H(2)* ... *H(k) , where k = min(m, n)
Each H (i) has the form
H(i) = I - tau*v*v^{T} for real flavors, or
H(i) = I - tau*v*v^{H} for complex flavors
where tau is a real/complex scalar stored in tau(i)[i] , and v is a real/complex vector with v_{1:i-1} = 0 and v_{i} = 1 .
On exit, v_{i+1:m} is stored in a(i+1:m, i) .
Input Parameters
A <datatype> placeholder, if present, is used for the C interface data types in the C interface section above. See C Interface Conventions for the C interface principal conventions and type definitions.
m
The number of rows in the matrix A ( m≥ 0 ).
n
The number of columns in A ( n≥ 0 ).
- a , work
-
REAL for sgeqr2 DOUBLE PRECISION for dgeqr2 COMPLEX for cgeqr2 DOUBLE COMPLEX for zgeqr2 . Arrays: a(lda,*) contains the m -by- n matrix A . The second dimension of a must be at least max(1, n) . work(n) is a workspace array.
- a
-
Array, size at least max(1, lda*n) for column major and max(1, lda*m) for row major layout. Array a contains the m -by- n matrix A .
lda
The leading dimension of a ; at least max(1, m ) for column major layout and max(1, n ) for row major layout .
Output Parameters
- a
-
Overwritten by the factorization data as follows: on exit, the elements on and above the diagonal of the array a contain the min( n , m )-by- n upper trapezoidal matrix R ( R is upper triangular if m≥n ); the elements below the diagonal, with the array tau , represent the orthogonal/unitary matrix Q as a product of elementary reflectors.
- tau
-
REAL for sgeqr2 DOUBLE PRECISION for dgeqr2 COMPLEX for cgeqr2 DOUBLE COMPLEX for zgeqr2 . Array, size at least max(1, min(m, n)) . Contains scalar factors of the elementary reflectors.
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.
If info = -1011 , memory allocation error occurred.