NAG Library Function Document

nag_zgglse (f08znc)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

nag_zgglse (f08znc) solves a complex linear equality-constrained least squares problem.

2
Specification

#include <nag.h>
#include <nagf08.h>
void  nag_zgglse (Nag_OrderType order, Integer m, Integer n, Integer p, Complex a[], Integer pda, Complex b[], Integer pdb, Complex c[], Complex d[], Complex x[], NagError *fail)

3
Description

nag_zgglse (f08znc) solves the complex linear equality-constrained least squares (LSE) problem
minimize x c-Ax2  subject to  Bx=d  
where A is an m by n matrix, B is a p by n matrix, c is an m element vector and d is a p element vector. It is assumed that pnm+p, rankB=p and rankE=n, where E= A B . These conditions ensure that the LSE problem has a unique solution, which is obtained using a generalized RQ factorization of the matrices B and A.

4
References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia
Anderson E, Bai Z and Dongarra J (1992) Generalized QR factorization and its applications Linear Algebra Appl. (Volume 162–164) 243–271
Eldèn L (1980) Perturbation theory for the least squares problem with linear equality constraints SIAM J. Numer. Anal. 17 338–350

5
Arguments

1:     order Nag_OrderTypeInput
On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by order=Nag_RowMajor. See Section 3.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     m IntegerInput
On entry: m, the number of rows of the matrix A.
Constraint: m0.
3:     n IntegerInput
On entry: n, the number of columns of the matrices A and B.
Constraint: n0.
4:     p IntegerInput
On entry: p, the number of rows of the matrix B.
Constraint: 0pnm+p.
5:     a[dim] ComplexInput/Output
Note: the dimension, dim, of the array a must be at least
  • max1,pda×n when order=Nag_ColMajor;
  • max1,m×pda when order=Nag_RowMajor.
The i,jth element of the matrix A is stored in
  • a[j-1×pda+i-1] when order=Nag_ColMajor;
  • a[i-1×pda+j-1] when order=Nag_RowMajor.
On entry: the m by n matrix A.
On exit: a is overwritten.
6:     pda IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraints:
  • if order=Nag_ColMajor, pdamax1,m;
  • if order=Nag_RowMajor, pdamax1,n.
7:     b[dim] ComplexInput/Output
Note: the dimension, dim, of the array b must be at least
  • max1,pdb×n when order=Nag_ColMajor;
  • max1,p×pdb when order=Nag_RowMajor.
The i,jth element of the matrix B is stored in
  • b[j-1×pdb+i-1] when order=Nag_ColMajor;
  • b[i-1×pdb+j-1] when order=Nag_RowMajor.
On entry: the p by n matrix B.
On exit: b is overwritten.
8:     pdb IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array b.
Constraints:
  • if order=Nag_ColMajor, pdbmax1,p;
  • if order=Nag_RowMajor, pdbmax1,n.
9:     c[m] ComplexInput/Output
On entry: the right-hand side vector c for the least squares part of the LSE problem.
On exit: the residual sum of squares for the solution vector x is given by the sum of squares of elements c[n-p],c[n-p+1],,c[m-1]; the remaining elements are overwritten.
10:   d[p] ComplexInput/Output
On entry: the right-hand side vector d for the equality constraints.
On exit: d is overwritten.
11:   x[n] ComplexOutput
On exit: the solution vector x of the LSE problem.
12:   fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6
Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, m=value.
Constraint: m0.
On entry, n=value.
Constraint: n0.
On entry, pda=value.
Constraint: pda>0.
On entry, pdb=value.
Constraint: pdb>0.
NE_INT_2
On entry, pda=value and m=value.
Constraint: pdamax1,m.
On entry, pda=value and n=value.
Constraint: pdamax1,n.
On entry, pdb=value and n=value.
Constraint: pdbmax1,n.
On entry, pdb=value and p=value.
Constraint: pdbmax1,p.
NE_INT_3
On entry, p=value, m=value and n=value.
Constraint: 0pnm+p.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
NE_SINGULAR
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 the rank of the matrix (E) comprising the rows of A and B is less than n; the least squares solutions could not be computed.
The upper triangular factor R associated with B in the generalized RQ factorization of the pair B,A is singular, so that rankB<p; the least squares solution could not be computed.

7
Accuracy

For an error analysis, see Anderson et al. (1992) and Eldèn (1980). See also Section 4.6 of Anderson et al. (1999).

8
Parallelism and Performance

nag_zgglse (f08znc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_zgglse (f08znc) makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the x06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9
Further Comments

When mn=p, the total number of real floating-point operations is approximately 83n26m+n; if pn, the number reduces to approximately 83n23m-n.

10
Example

This example solves the least squares problem
minimize x c-Ax2   subject to   Bx=d  
where
c = -2.54+0.09i 1.65-2.26i -2.11-3.96i 1.82+3.30i -6.41+3.77i 2.07+0.66i ,  
and
A = 0.96-0.81i -0.03+0.96i -0.91+2.06i -0.05+0.41i -0.98+1.98i -1.20+0.19i -0.66+0.42i -0.81+0.56i 0.62-0.46i 1.01+0.02i 0.63-0.17i -1.11+0.60i 0.37+0.38i 0.19-0.54i -0.98-0.36i 0.22-0.20i 0.83+0.51i 0.20+0.01i -0.17-0.46i 1.47+1.59i 1.08-0.28i 0.20-0.12i -0.07+1.23i 0.26+0.26i ,  
B = 1.0+0.0i 0.0i+0.0 -1.0+0.0i 0.0i+0.0 0.0i+0.0 1.0+0.0i 0.0i+0.0 -1.0+0.0i  
and
d = 0 0 .  
The constraints Bx=d  correspond to x1 = x3  and x2 = x4 .

10.1
Program Text

Program Text (f08znce.c)

10.2
Program Data

Program Data (f08znce.d)

10.3
Program Results

Program Results (f08znce.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017