p?orgr2/p?ungr2

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 11/07/2023

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-5E15F7C5-B9F3-4A82-B086-253855774FCF

View Details

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

void psorgr2 (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 );

void pdorgr2 (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 );

void pcungr2 (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 );

void pzungr2 (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

The p?orgr2/p?ungr2function 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))^H*(H(2))^H...*(H(k))^H (for complex flavors) as returned by p?gerqf.

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

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 amust contain the vector that defines the elementary reflector H(i), ia+m-k ≤ i ≤ ia+m-1, as returned by p?gerqf 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)

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 p?gerqf. This array is tied to the distributed matrix A.

work

(local)

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 pxerbla.

Output Parameters

a

On exit, this array contains the local pieces of the m-by-n distributed matrix Q.

work

On exit, work[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.

Parent topic: ScaLAPACK Auxiliary 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 C

p?orgr2/p?ungr2

Syntax

Include Files

Description

Input Parameters

Output Parameters

See Also