NAG FL Interface
f08zpf (zggglm)
1
Purpose
f08zpf solves a complex general Gauss–Markov linear (least squares) model problem.
2
Specification
Fortran Interface
Subroutine f08zpf ( |
m, n, p, a, lda, b, ldb, d, x, y, work, lwork, info) |
Integer, Intent (In) |
:: |
m, n, p, lda, ldb, lwork |
Integer, Intent (Out) |
:: |
info |
Complex (Kind=nag_wp), Intent (Inout) |
:: |
a(lda,*), b(ldb,*), d(m) |
Complex (Kind=nag_wp), Intent (Out) |
:: |
x(n), y(p), work(max(1,lwork)) |
|
C Header Interface
#include <nag.h>
void |
f08zpf_ (const Integer *m, const Integer *n, const Integer *p, Complex a[], const Integer *lda, Complex b[], const Integer *ldb, Complex d[], Complex x[], Complex y[], Complex work[], const Integer *lwork, Integer *info) |
|
C++ Header Interface
#include <nag.h> extern "C" {
void |
f08zpf_ (const Integer &m, const Integer &n, const Integer &p, Complex a[], const Integer &lda, Complex b[], const Integer &ldb, Complex d[], Complex x[], Complex y[], Complex work[], const Integer &lwork, Integer &info) |
}
|
The routine may be called by the names f08zpf, nagf_lapackeig_zggglm or its LAPACK name zggglm.
3
Description
f08zpf solves the complex general Gauss–Markov linear model (GLM) problem
where
is an
by
matrix,
is an
by
matrix and
is an
element vector. It is assumed that
,
and
, where
. Under these assumptions, the problem has a unique solution
and a minimal
-norm solution
, which is obtained using a generalized
factorization of the matrices
and
.
In particular, if the matrix
is square and nonsingular, then the GLM problem is equivalent to the weighted linear least squares problem
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
5
Arguments
-
1:
– Integer
Input
-
On entry: , the number of rows of the matrices and .
Constraint:
.
-
2:
– Integer
Input
-
On entry: , the number of columns of the matrix .
Constraint:
.
-
3:
– Integer
Input
-
On entry: , the number of columns of the matrix .
Constraint:
.
-
4:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: the by matrix .
On exit:
a is overwritten.
-
5:
– Integer
Input
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08zpf is called.
Constraint:
.
-
6:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
b
must be at least
.
On entry: the by matrix .
On exit:
b is overwritten.
-
7:
– Integer
Input
-
On entry: the first dimension of the array
b as declared in the (sub)program from which
f08zpf is called.
Constraint:
.
-
8:
– Complex (Kind=nag_wp) array
Input/Output
-
On entry: the left-hand side vector of the GLM equation.
On exit:
d is overwritten.
-
9:
– Complex (Kind=nag_wp) array
Output
-
On exit: the solution vector of the GLM problem.
-
10:
– Complex (Kind=nag_wp) array
Output
-
On exit: the solution vector of the GLM problem.
-
11:
– Complex (Kind=nag_wp) array
Workspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
-
12:
– Integer
Input
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08zpf is called.
If
, 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.
Suggested value:
for optimal performance, , where is the optimal block size.
Constraint:
or .
-
13:
– Integer
Output
On exit:
unless the routine detects an error (see
Section 6).
6
Error Indicators and Warnings
If , argument had an illegal value. An explanatory message is output, and execution of the program is terminated.
-
The upper triangular factor associated with in the generalized factorization of the pair is singular, so that ; the least squares solution could not be computed.
-
The bottom by part of the upper trapezoidal factor associated with in the generalized factorization of the pair is singular, so that ; the least squares solutions could not be computed.
7
Accuracy
For an error analysis, see
Anderson et al. (1992). See also Section 4.6 of
Anderson et al. (1999).
8
Parallelism and Performance
f08zpf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08zpf 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 routine. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
When , the total number of real floating-point operations is approximately ; when , the total number of real floating-point operations is approximately .
10
Example
This example solves the weighted least squares problem
where
and
Note that the block size (NB) of assumed in this example is not realistic for such a small problem, but should be suitable for large problems.
10.1
Program Text
10.2
Program Data
10.3
Program Results