Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 2021.1
  • 12/04/2020
  • Public Content
Contents

p?orgl2/p?ungl2

Generates all or part of the orthogonal/unitary matrix Q from an LQ factorization determined by
p?gelqf
 (unblocked algorithm).

Syntax

void
psorgl2
(
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
pdorgl2
(
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
pcungl2
(
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
pzungl2
(
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?orgl2/p?ungl2
function
generates a
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 first
m
 rows of a product of
k
 elementary reflectors of order
n
Q
 =
H
(
k
)*...*
H
(2)*
H
(1) (for real flavors),
Q
 = (
H
(
k
))
H
*...*(
H
(2))
H
*(
H
(1))
H
 (for complex flavors) as returned by
p?gelqf
.
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
a
must contain the vector that defines the elementary reflector
H
(
i
),
ia
≤
i
≤
ia
+
k
-1, as returned by
p?gelqf
 in the
k
 rows of its
distributed matrix
 argument
A
(
ia
:
ia
+
k
-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
+
k
-1).
tau
[
j
]
 contains the scalar factor of the elementary reflectors
H
(
j
+1),
j
 = 0, 1, ...,
LOCr
(
ja
+
k
-1)
-1
, as returned by
p?gelqf
. 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
≥
nqa
0 + max(1,
mpa
0)
, 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
)
,
mpa
0 =
numroc
(
m
+
iroffa
,
mb_a
,
myrow
,
iarow
,
nprow
)
,
nqa
0 =
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
.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.