NAG FL Interface
f08msf (zbdsqr)
1
Purpose
f08msf computes the singular value decomposition of a complex general matrix which has been reduced to bidiagonal form.
2
Specification
Fortran Interface
Subroutine f08msf ( |
uplo, n, ncvt, nru, ncc, d, e, vt, ldvt, u, ldu, c, ldc, work, info) |
Integer, Intent (In) |
:: |
n, ncvt, nru, ncc, ldvt, ldu, ldc |
Integer, Intent (Out) |
:: |
info |
Real (Kind=nag_wp), Intent (Inout) |
:: |
d(*), e(*), work(*) |
Complex (Kind=nag_wp), Intent (Inout) |
:: |
vt(ldvt,*), u(ldu,*), c(ldc,*) |
Character (1), Intent (In) |
:: |
uplo |
|
C Header Interface
#include <nag.h>
void |
f08msf_ (const char *uplo, const Integer *n, const Integer *ncvt, const Integer *nru, const Integer *ncc, double d[], double e[], Complex vt[], const Integer *ldvt, Complex u[], const Integer *ldu, Complex c[], const Integer *ldc, double work[], Integer *info, const Charlen length_uplo) |
|
C++ Header Interface
#include <nag.h> extern "C" {
void |
f08msf_ (const char *uplo, const Integer &n, const Integer &ncvt, const Integer &nru, const Integer &ncc, double d[], double e[], Complex vt[], const Integer &ldvt, Complex u[], const Integer &ldu, Complex c[], const Integer &ldc, double work[], Integer &info, const Charlen length_uplo) |
}
|
The routine may be called by the names f08msf, nagf_lapackeig_zbdsqr or its LAPACK name zbdsqr.
3
Description
f08msf computes the singular values and, optionally, the left or right singular vectors of a real upper or lower bidiagonal matrix
. In other words, it can compute the singular value decomposition (SVD) of
as
Here
is a diagonal matrix with real diagonal elements
(the singular values of
), such that
is an orthogonal matrix whose columns are the left singular vectors
;
is an orthogonal matrix whose rows are the right singular vectors
. Thus
To compute
and/or
, the arrays
u and/or
vt must be initialized to the unit matrix before
f08msf is called.
The routine stores the real orthogonal matrices
and
in complex arrays
u and
vt, so that it may also be used to compute the SVD of a complex general matrix
which has been reduced to bidiagonal form by a unitary transformation:
. If
is
by
with
, then
is
by
and
is
by
; if
is
by
with
, then
is
by
and
is
by
. In this case, the matrices
and/or
must be formed explicitly by
f08ktf and passed to
f08msf in the arrays
u and/or
vt respectively.
f08msf also has the capability of forming , where is an arbitrary complex matrix; this is needed when using the SVD to solve linear least squares problems.
f08msf uses two different algorithms. If any singular vectors are required (i.e., if
or
or
), the bidiagonal
algorithm is used, switching between zero-shift and implicitly shifted forms to preserve the accuracy of small singular values, and switching between
and
variants in order to handle graded matrices effectively (see
Demmel and Kahan (1990)). If only singular values are required (i.e., if
), they are computed by the differential qd algorithm (see
Fernando and Parlett (1994)), which is faster and can achieve even greater accuracy.
The singular vectors are normalized so that , but are determined only to within a complex factor of absolute value .
4
References
Demmel J W and Kahan W (1990) Accurate singular values of bidiagonal matrices SIAM J. Sci. Statist. Comput. 11 873–912
Fernando K V and Parlett B N (1994) Accurate singular values and differential qd algorithms Numer. Math. 67 191–229
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5
Arguments
-
1:
– Character(1)
Input
-
On entry: indicates whether
is an upper or lower bidiagonal matrix.
- is an upper bidiagonal matrix.
- is a lower bidiagonal matrix.
Constraint:
or .
-
2:
– Integer
Input
-
On entry: , the order of the matrix .
Constraint:
.
-
3:
– Integer
Input
-
On entry: , the number of columns of the matrix of right singular vectors. Set if no right singular vectors are required.
Constraint:
.
-
4:
– Integer
Input
-
On entry: , the number of rows of the matrix of left singular vectors. Set if no left singular vectors are required.
Constraint:
.
-
5:
– Integer
Input
-
On entry: , the number of columns of the matrix . Set if no matrix is supplied.
Constraint:
.
-
6:
– Real (Kind=nag_wp) array
Input/Output
-
Note: the dimension of the array
d
must be at least
.
On entry: the diagonal elements of the bidiagonal matrix .
On exit: the singular values in decreasing order of magnitude, unless
(in which case see
Section 6).
-
7:
– Real (Kind=nag_wp) array
Input/Output
-
Note: the dimension of the array
e
must be at least
.
On entry: the off-diagonal elements of the bidiagonal matrix .
On exit:
e is overwritten, but if
see
Section 6.
-
8:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
vt
must be at least
.
On entry: if
,
vt must contain an
by
matrix. If the right singular vectors of
are required,
and
vt must contain the unit matrix; if the right singular vectors of
are required,
vt must contain the unitary matrix
returned by
f08ktf with
.
On exit: the
by
matrix
or
of right singular vectors, stored by rows.
If
,
vt is not referenced.
-
9:
– Integer
Input
-
On entry: the first dimension of the array
vt as declared in the (sub)program from which
f08msf is called.
Constraints:
- if , ;
- otherwise .
-
10:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
u
must be at least
.
On entry: if
,
u must contain an
by
matrix. If the left singular vectors of
are required,
and
u must contain the unit matrix; if the left singular vectors of
are required,
u must contain the unitary matrix
returned by
f08ktf with
.
On exit: the
by
matrix
or
of left singular vectors, stored as columns of the matrix.
If
,
u is not referenced.
-
11:
– Integer
Input
-
On entry: the first dimension of the array
u as declared in the (sub)program from which
f08msf is called.
Constraint:
.
-
12:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
c
must be at least
.
On entry: the by matrix if .
On exit:
c is overwritten by the matrix
. If
,
c is not referenced.
-
13:
– Integer
Input
-
On entry: the first dimension of the array
c as declared in the (sub)program from which
f08msf is called.
Constraints:
- if , ;
- otherwise .
-
14:
– Real (Kind=nag_wp) array
Workspace
-
Note: the dimension of the array
work
must be at least
.
-
15:
– 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.
-
off-diagonals did not converge. The arrays
d and
e contain the diagonal and off-diagonal elements, respectively, of a bidiagonal matrix orthogonally equivalent to
.
7
Accuracy
Each singular value and singular vector is computed to high relative accuracy. However, the reduction to bidiagonal form (prior to calling the routine) may exclude the possibility of obtaining high relative accuracy in the small singular values of the original matrix if its singular values vary widely in magnitude.
If
is an exact singular value of
and
is the corresponding computed value, then
where
is a modestly increasing function of
and
, and
is the
machine precision. If only singular values are computed, they are computed more accurately (i.e., the function
is smaller), than when some singular vectors are also computed.
If
is an exact left singular vector of
, and
is the corresponding computed left singular vector, then the angle
between them is bounded as follows:
where
is the relative gap between
and the other singular values, defined by
A similar error bound holds for the right singular vectors.
8
Parallelism and Performance
f08msf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08msf 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.
The total number of real floating-point operations is roughly proportional to if only the singular values are computed. About additional operations are required to compute the left singular vectors and about to compute the right singular vectors. The operations to compute the singular values must all be performed in scalar mode; the additional operations to compute the singular vectors can be vectorized and on some machines may be performed much faster.
The real analogue of this routine is
f08mef.
10
Example
See
Section 10 in
f08ktf, which illustrates the use of the routine to compute the singular value decomposition of a general matrix.