GGLSE - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
template<typename T>
void gglse(integer *m, integer *n, integer *p, T *a, integer *lda, T *b, integer *ldb, T *c, T *d, T *x, T *work, integer *lwork, integer *info)#

GGLSE solves overdetermined or underdetermined systems for OTHER matrices.

Purpose:

    GGLSE solves the linear equality-constrained least squares (LSE)
    problem:
            minimize || c - A*x ||_2   subject to   B*x = d
    where A is an M-by-N matrix, B is a P-by-N matrix, c is a given
    M-vector, and d is a given P-vector. It is assumed that
    P <= N <= M+P, and
             rank(B) = P and  rank( (A)) = N.
                                  ( (B))
    These conditions ensure that the LSE problem has a unique solution,
    which is obtained using a generalized RQ factorization of the
    matrices (B, A) given by
       B = (0 R)*Q,   A = Z*T*Q.
Parameters:
  • M[in]

    M is INTEGER

    The number of rows of the matrix A. M >= 0.

  • N[in]

    N is INTEGER

    The number of columns of the matrices A and B. N >= 0.

  • P[in]

    P is INTEGER

    The number of rows of the matrix B. 0 <= P <= N <= M+P.

  • A[inout]

    A is REAL array, dimension (LDA,N)

    On entry, the M-by-N matrix A.

    On exit, the elements on and above the diagonal of the array contain the min(M,N)-by-N upper trapezoidal matrix T.
  • LDA[in]

    LDA is INTEGER

    The leading dimension of the array A. LDA >= fla_max(1,M).

  • B[inout]

    B is REAL array, dimension (LDB,N)

    On entry, the P-by-N matrix B.

    On exit, the upper triangle of the subarray B(1:P,N-P+1:N) contains the P-by-P upper triangular matrix R.
  • LDB[in]

    LDB is INTEGER

    The leading dimension of the array B. LDB >= fla_max(1,P).

  • C[inout]

    C is REAL array, dimension (M)

    On entry, C contains the right hand side vector for the least squares part of the LSE problem.

    On exit, the residual sum of squares for the solution is given by the sum of squares of elements N-P+1 to M of vector C.
  • D[inout]

    D is REAL array, dimension (P)

    On entry, D contains the right hand side vector for the constrained equation.

    On exit, D is destroyed.
  • X[out]

    X is REAL array, dimension (N)

    On exit, X is the solution of the LSE problem.

  • WORK[out]

    WORK is REAL 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. LWORK >= fla_max(1,M+N+P).

    For optimum performance LWORK >= P+min(M,N)+max(M,N)*NB, where NB is an upper bound for the optimal blocksizes for SGEQRF, SGERQF, SORMQR and SORMRQ.

    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.

    = 1: the upper triangular factor R associated with B in the generalized RQ factorization of the pair (B, A) is singular, so that rank(B) < P; the least squares solution could not be computed.

    = 2: the (N-P) by (N-P) part of the upper trapezoidal factor T associated with A in the generalized RQ factorization of the pair (B, A) is singular, so that rank( (A) ) < N; the least squares solution could not ( (B) ) be computed.