Constrained Least Squares APIs

Constrained Least Squares APIs#

GGLSE#

group gglse

Functions

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.

GGGLM#

group ggglm

Functions

template<typename T>
void ggglm(integer *n, integer *m, integer *p, T *a, integer *lda, T *b, integer *ldb, T *d, T *x, T *y, T *work, integer *lwork, integer *info)#

GGGLM solves a general Gauss-Markov linear model (GLM) problem.

Purpose:

    GGGLM solves a general Gauss-Markov linear model (GLM) problem:
            minimize || y ||_2   subject to   d = A*x + B*y
                x
    where A is an N-by-M matrix, B is an N-by-P matrix, and d is a
    given N-vector. It is assumed that M <= N <= M+P, and
               rank(A) = M    and    rank( A B) = N.
    Under these assumptions, the constrained equation is always
    consistent, and there is a unique solution x and a minimal 2-norm
    solution y, which is obtained using a generalized QR factorization
    of the matrices (A, B) given by
       A = Q*(R),   B = Q*T*Z.
             (0)
    In particular, if matrix B is square nonsingular, then the problem
    GLM is equivalent to the following weighted linear least squares
    problem
                 minimize || inv(B)*(d-A*x) ||_2
                     x
    where inv(B) denotes the inverse of B.

Parameters:
  • N – [in]

    N is INTEGER

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

  • M – [in]

    M is INTEGER

    The number of columns of the matrix A. 0 <= M <= N.

  • P – [in]

    P is INTEGER

    The number of columns of the matrix B. P >= N-M.

  • A – [inout]

    A is REAL array, dimension (LDA,M)

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

    On exit, the upper triangular part of the array A contains the M-by-M upper triangular matrix R.

  • LDA – [in]

    LDA is INTEGER

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

  • B – [inout]

    B is REAL array, dimension (LDB,P)

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

    On exit, if N <= P, the upper triangle of the subarray B(1:N,P-N+1:P) contains the N-by-N upper triangular matrix T; if N > P, the elements on and above the (N-P)th subdiagonal contain the N-by-P upper trapezoidal matrix T.

  • LDB – [in]

    LDB is INTEGER

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

  • D – [inout]

    D is REAL array, dimension (N)

    On entry, D is the left hand side of the GLM equation. On exit, D is destroyed.

  • X – [out] X is REAL array, dimension (M)

  • Y – [out]

    Y is REAL array, dimension (P)

    On exit, X and Y are the solutions of the GLM 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,N+M+P). For optimum performance, LWORK >= M+min(N,P)+max(N,P)*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 A in the generalized QR factorization of the pair (A, B) is singular, so that rank(A) < M; the least squares solution could not be computed.

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