Developer Reference for Intel® oneAPI Math Kernel Library for C
p?orgr2/p?ungr2
Generates all or part of the orthogonal/unitary matrix Q from an RQ factorization determined by p?gerqf (unblocked algorithm).
Syntax
voidpsorgr2 ( MKL_INT*m , MKL_INT*n , MKL_INT*k , float*a , MKL_INT*ia , MKL_INT*ja , MKL_INT*desca , float*tau , float*work , MKL_INT*lwork , MKL_INT*info );
voidpdorgr2 ( MKL_INT*m , MKL_INT*n , MKL_INT*k , double*a , MKL_INT*ia , MKL_INT*ja , MKL_INT*desca , double*tau , double*work , MKL_INT*lwork , MKL_INT*info );
voidpcungr2 ( MKL_INT*m , MKL_INT*n , MKL_INT*k , MKL_Complex8*a , MKL_INT*ia , MKL_INT*ja , MKL_INT*desca , MKL_Complex8*tau , MKL_Complex8*work , MKL_INT*lwork , MKL_INT*info );
voidpzungr2 ( MKL_INT*m , MKL_INT*n , MKL_INT*k , MKL_Complex16*a , MKL_INT*ia , MKL_INT*ja , MKL_INT*desca , MKL_Complex16*tau , MKL_Complex16*work , MKL_INT*lwork , MKL_INT*info );
Include Files
mkl_scalapack.h
Description
psorgr2 pdorgr2 pcungr2 pzungr2 The p?orgr2/p?ungr2 routine function generates an m -by- n real/complex matrix Q denoting A(ia:ia+m-1, ja:ja+n-1) with orthonormal rows, which is defined as the last m rows of a product of k elementary reflectors of order n
Q = H (1)* H (2)*…* H ( k ) (for real flavors);
Q = ( H (1)) :code:`H` *( H (2)) :code:`H` …*( H ( k )) :code:`H` (for complex flavors) as returned by p?gerqf (Computes the RQ factorization of a general rectangular matrix.) .
Input Parameters
m
(global)
The number of rows in the distributed submatrix Q . m ≥ 0 .
n
(global)
The number of columns in the distributed submatrix Q . n ≥ m ≥ 0 .
k
(global)
The number of elementary reflectors whose product defines the matrix Q . m ≥ k ≥ 0 .
- a
-
REAL for psorgr2 DOUBLE PRECISION for pdorgr2 COMPLEX for pcungr2 COMPLEX*16 for pzungr2 .
Pointer into the local memory to an array of size lld_a * LOCc ( ja + n -1) .
On entry, the i -th row of the matrix stored in a must contain the vector that defines the elementary reflector H ( i ), ia + m - k ≤ i ≤ ia + m -1, as returned by GUID-67EC72B2-AC47-4767-BDF9-77FF3FBEA778.xml#GUID-67EC72B2-AC47-4767-BDF9-77FF3FBEA778 in the k rows of its distributed matrix argument A(ia+m-k:ia+m-1, ja:*) .
ia
(global)
The row index in the global matrix A indicating the first row of sub( A ).
ja
(global)
The column index in the global matrix A indicating the first column of sub( A ).
desca
(global and local) array of size dlen_ . The array descriptor for the distributed matrix A .
- tau
-
(local) REAL for psorgr2 DOUBLE PRECISION for pdorgr2 COMPLEX for pcungr2 COMPLEX*16 for pzungr2 .
Array of size LOCr(ja+m-1) . tau [ j ] contains the scalar factor of the elementary reflectors H ( j +1), j = 0, 1, …, LOCr(ja+m-1) -1 , as returned by GUID-67EC72B2-AC47-4767-BDF9-77FF3FBEA778.xml#GUID-67EC72B2-AC47-4767-BDF9-77FF3FBEA778 . This array is tied to the distributed matrix A .
- work
-
(local) REAL for psorgr2 DOUBLE PRECISION for pdorgr2 COMPLEX for pcungr2 COMPLEX*16 for pzungr2 . Workspace array of size lwork .
lwork
(local or global)
The size of the array work . lwork is local input and must be at least lwork ≥ nqa0 + max(1, mpa0 ) , where iroffa = mod( ia-1, mb_a ) , icoffa = mod( ja-1, nb_a ) , iarow = indxg2p( ia, mb_a, myrow, rsrc_a, nprow ) , iacol = indxg2p( ja, nb_a, mycol, csrc_a, npcol ) , mpa0 = numroc( m+iroffa, mb_a, myrow, iarow, nprow ) , nqa0 = numroc( n+icoffa, nb_a, mycol, iacol, npcol ) .
indxg2p and numroc are ScaLAPACK tool functions; myrow , mycol , nprow, and npcol can be determined by calling the function blacs_gridinfo .
If lwork = -1 , then lwork is global input and a workspace query is assumed; the function only calculates the minimum and optimal size for all work arrays. Each of these values is returned in the first entry of the corresponding work array, and no error message is issued by GUID-E523C816-D553-4D4E-8458-5404828CC07B.xml .
Output Parameters
- a
-
On exit, this array contains the local pieces of the m -by- n distributed matrix Q .
work
On exit, work(1)[0] returns the minimal and optimal lwork .
info
(local)
= 0 : successful exit
< 0 : if the i -th argument is an array and the j -th entry , indexed j -1, had an illegal value,
then info = - ( i *100 + j ), if the i -th argument is a scalar and had an illegal value, then info = - i .