NAG Library Function Document
nag_zggsvd (f08vnc)
1 Purpose
nag_zggsvd (f08vnc) computes the generalized singular value decomposition (GSVD) of an by complex matrix and a by complex matrix .
2 Specification
#include <nag.h> |
#include <nagf08.h> |
void |
nag_zggsvd (Nag_OrderType order,
Nag_ComputeUType jobu,
Nag_ComputeVType jobv,
Nag_ComputeQType jobq,
Integer m,
Integer n,
Integer p,
Integer *k,
Integer *l,
Complex a[],
Integer pda,
Complex b[],
Integer pdb,
double alpha[],
double beta[],
Complex u[],
Integer pdu,
Complex v[],
Integer pdv,
Complex q[],
Integer pdq,
Integer iwork[],
NagError *fail) |
|
3 Description
The generalized singular value decomposition is given by
where
,
and
are unitary matrices. Let
be the effective numerical rank of the matrix
, then
is a
by
nonsingular upper triangular matrix,
and
are
by
and
by
‘diagonal’ matrices structured as follows:
if
,
where
and
is stored as a submatrix of
with elements
stored as
on exit.
If
,
where
and
is stored as a submatrix of
with
stored as
, and
is stored as a submatrix of
with
stored as
.
The function computes , , and, optionally, the unitary transformation matrices , and .
In particular, if
is an
by
nonsingular matrix, then the GSVD of
and
implicitly gives the SVD of
:
If
has orthonormal columns, then the GSVD of
and
is also equal to the CS decomposition of
and
. Furthermore, the GSVD can be used to derive the solution of the eigenvalue problem:
In some literature, the GSVD of
and
is presented in the form
where
and
are orthogonal and
is nonsingular, and
and
are ‘diagonal’. The former GSVD form can be converted to the latter form by taking the nonsingular matrix
as
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
http://www.netlib.org/lapack/lug
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
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
. See
Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.
Constraint:
or .
- 2:
jobu – Nag_ComputeUTypeInput
On entry: if
, the unitary matrix
is computed.
If , is not computed.
Constraint:
or .
- 3:
jobv – Nag_ComputeVTypeInput
On entry: if
, the unitary matrix
is computed.
If , is not computed.
Constraint:
or .
- 4:
jobq – Nag_ComputeQTypeInput
On entry: if
, the unitary matrix
is computed.
If , is not computed.
Constraint:
or .
- 5:
m – IntegerInput
On entry: , the number of rows of the matrix .
Constraint:
.
- 6:
n – IntegerInput
On entry: , the number of columns of the matrices and .
Constraint:
.
- 7:
p – IntegerInput
On entry: , the number of rows of the matrix .
Constraint:
.
- 8:
k – Integer *Output
- 9:
l – Integer *Output
On exit:
k and
l specify the dimension of the subblocks
and
as described in
Section 3;
is the effective numerical rank of
.
- 10:
a[] – ComplexInput/Output
-
Note: the dimension,
dim, of the array
a
must be at least
- when
;
- when
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: the by matrix .
On exit: contains the triangular matrix
, or part of
. See
Section 3 for details.
- 11:
pda – IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
a.
Constraints:
- if ,
;
- if , .
- 12:
b[] – ComplexInput/Output
-
Note: the dimension,
dim, of the array
b
must be at least
- when
;
- when
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: the by matrix .
On exit: contains the triangular matrix
if
. See
Section 3 for details.
- 13:
pdb – IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
b.
Constraints:
- if ,
;
- if , .
- 14:
alpha[n] – doubleOutput
On exit: see the description of
beta.
- 15:
beta[n] – doubleOutput
On exit:
alpha and
beta contain the generalized singular value pairs of
and
,
and
;
- ,
- ,
and if
,
- ,
- ,
or if
,
- ,
- ,
- ,
- , and
- ,
- .
The notation above refers to consecutive elements
, for .
- 16:
u[] – ComplexOutput
-
Note: the dimension,
dim, of the array
u
must be at least
- when
;
- otherwise.
The
th element of the matrix
is stored in
- when ;
- when .
On exit: if
,
u contains the
by
unitary matrix
.
If
,
u is not referenced.
- 17:
pdu – IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
u.
Constraints:
- if , ;
- otherwise .
- 18:
v[] – ComplexOutput
-
Note: the dimension,
dim, of the array
v
must be at least
- when
;
- otherwise.
The
th element of the matrix
is stored in
- when ;
- when .
On exit: if
,
v contains the
by
unitary matrix
.
If
,
v is not referenced.
- 19:
pdv – IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
v.
Constraints:
- if , ;
- otherwise .
- 20:
q[] – ComplexOutput
-
Note: the dimension,
dim, of the array
q
must be at least
- when
;
- otherwise.
The
th element of the matrix
is stored in
- when ;
- when .
On exit: if
,
q contains the
by
unitary matrix
.
If
,
q is not referenced.
- 21:
pdq – IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
q.
Constraints:
- if , ;
- otherwise .
- 22:
iwork[n] – IntegerOutput
On exit: stores the sorting information. More precisely, the following loop will sort
alpha such that
.
- 23:
fail – NagError *Input/Output
-
The NAG error argument (see
Section 3.6 in the Essential Introduction).
6 Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_CONVERGENCE
-
The Jacobi-type procedure failed to converge.
- NE_ENUM_INT_2
-
On entry, , , .
Constraint: if ,
;
otherwise .
On entry, , and .
Constraint: if , ;
otherwise .
On entry, , and .
Constraint: if , ;
otherwise .
On entry, , and .
Constraint: if , ;
otherwise .
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
On entry, and .
Constraint: .
On entry, and .
Constraint: .
On entry, and .
Constraint: .
On entry, and .
Constraint: .
- 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.
7 Accuracy
The computed generalized singular value decomposition is nearly the exact generalized singular value decomposition for nearby matrices
and
, where
and
is the
machine precision. See Section 4.12 of
Anderson et al. (1999) for further details.
8 Parallelism and Performance
nag_zggsvd (f08vnc) is not threaded by NAG in any implementation.
nag_zggsvd (f08vnc) 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
Users' Note for your implementation for any additional implementation-specific information.
The diagonal elements of the matrix are real.
The real analogue of this function is
nag_dggsvd (f08vac).
10 Example
This example finds the generalized singular value decomposition
where
and
together with estimates for the condition number of
and the error bound for the computed generalized singular values.
The example program assumes that , and would need slight modification if this is not the case.
10.1 Program Text
Program Text (f08vnce.c)
10.2 Program Data
Program Data (f08vnce.d)
10.3 Program Results
Program Results (f08vnce.r)