UNMLQ - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
template<typename T>
void unmlq(char *side, char *trans, integer *m, integer *n, integer *k, T *a, integer *lda, T *tau, T *c, integer *ldc, T *work, integer *lwork, integer *info)#

Apply Q or Q’ from LQ factorization.

Purpose:

       Apply Q or Q' from LQ factorization. Overwrite the general complex m-by-n matrix c with

       side = 'L'  side = 'R'
       trans = 'N':   Q * C C * Q
       trans = 'C':   Q**H * C C * Q**H

       where Q is a complex unitary matrix defined as the product of k elementary reflectors

       Q = H(k)**H . . . H(2)**H H(1)**H

       as returned by CGELQF. Q is of order M if side = 'L' and of order N if side = 'R'.
Parameters:
  • side[in]

    side is char*

    = ‘L’: apply Q or Q**H from the Left;

    = ‘R’: apply Q or Q**H from the Right.
  • trans[in]

    trans is char*

    = ‘N’: No transpose, apply Q;

    = ‘C’: Conjugate transpose, apply Q**H.
  • m[in]

    m is integer*

    The number of rows of the matrix c. m >= 0.

  • n[in]

    n is integer*

    The number of columns of the matrix c. n >= 0.

  • k[in]

    k is integer*

    The number of elementary reflectors whose product defines the matrix Q.

    If side = ‘L’, m >= k >= 0;

    if side = ‘R’, n >= k >= 0.

  • a[in]

    a is COMPLEX/COMPLEX*16 array, dimension

    (lda,m) if side = ‘L’,

    (lda,n) if side = ‘R’

    The i-th row must contain the vector which defines the elementary reflector H(i), for i = 1,2,…,k, as returned by CGELQF in the first k rows of its array argument a.

  • lda[in]

    lda is integer*

    The leading dimension of the array a. lda >= fla_max(1,k).

  • tau[in]

    tau is COMPLEX/COMPLEX*16 array, dimension (k)

    tau(i) must contain the scalar factor of the elementary reflector H(i), as returned by CGELQF.

  • c[inout]

    c is COMPLEX/COMPLEX*16 array, dimension (ldc,n)

    On entry, the m-by-n matrix c.

    On exit, c is overwritten by Q*C or Q**T*C or C*Q**T or C*Q.
  • ldc[in]

    ldc is integer*

    The leading dimension of the array c. ldc >= fla_max(1,m).

  • WORK[out]

    WORK is COMPLEX array, dimension (MAX(1,LWORK))

    On exit, if INFO = 0, WORK(1) returns the optimal LWORK.

  • LWORK[in]

    LWORK is INTEGER

    The dimension of the array WORK.

    If SIDE = ‘L’, LWORK >= fla_max(1,N);

    if SIDE = ‘R’, LWORK >= fla_max(1,M).

    For good performance, LWORK should generally be larger.

    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.

  • INFO[out]

    INFO is INTEGER

    = 0: successful exit

    < 0: if INFO = -i, the i-th argument had an illegal value