NAG Library Routine Document
f07npf
(zsysvx)
1
Purpose
f07npf (zsysvx) uses the diagonal pivoting factorization to compute the solution to a complex system of linear equations
where
is an
by
symmetric matrix and
and
are
by
matrices. Error bounds on the solution and a condition estimate are also provided.
2
Specification
Fortran Interface
Subroutine f07npf ( |
fact,
uplo,
n,
nrhs,
a,
lda,
af,
ldaf,
ipiv,
b,
ldb,
x,
ldx,
rcond,
ferr,
berr,
work,
lwork,
rwork,
info) |
Integer, Intent (In) | :: |
n,
nrhs,
lda,
ldaf,
ldb,
ldx,
lwork | Integer, Intent (Inout) | :: |
ipiv(*) | Integer, Intent (Out) | :: |
info | Real (Kind=nag_wp), Intent (Inout) | :: |
ferr(*),
berr(*),
rwork(*) | Real (Kind=nag_wp), Intent (Out) | :: |
rcond | Complex (Kind=nag_wp), Intent (In) | :: |
a(lda,*),
b(ldb,*) | Complex (Kind=nag_wp), Intent (Inout) | :: |
af(ldaf,*),
x(ldx,*) | Complex (Kind=nag_wp), Intent (Out) | :: |
work(max(1,lwork)) | Character (1), Intent (In) | :: |
fact,
uplo |
|
C Header Interface
#include nagmk26.h
void |
f07npf_ (
const char *fact,
const char *uplo,
const Integer *n,
const Integer *nrhs,
const Complex a[],
const Integer *lda,
Complex af[],
const Integer *ldaf,
Integer ipiv[],
const Complex b[],
const Integer *ldb,
Complex x[],
const Integer *ldx,
double *rcond,
double ferr[],
double berr[],
Complex work[],
const Integer *lwork,
double rwork[],
Integer *info,
const Charlen length_fact,
const Charlen length_uplo) |
|
The routine may be called by its
LAPACK
name zsysvx.
3
Description
f07npf (zsysvx) performs the following steps:
1. |
If , the diagonal pivoting method is used to factor . The form of the factorization is if or if , where (or ) is a product of permutation and unit upper (lower) triangular matrices, and is symmetric and block diagonal with by and by diagonal blocks. |
2. |
If some , so that is exactly singular, then the routine returns with . Otherwise, the factored form of is used to estimate the condition number of the matrix . If the reciprocal of the condition number is less than machine precision, is returned as a warning, but the routine still goes on to solve for and compute error bounds as described below. |
3. |
The system of equations is solved for using the factored form of . |
4. |
Iterative refinement is applied to improve the computed solution matrix and to calculate error bounds and backward error estimates for it. |
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
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia
5
Arguments
- 1: – Character(1)Input
-
On entry: specifies whether or not the factorized form of the matrix
has been supplied.
- af and ipiv contain the factorized form of the matrix . af and ipiv will not be modified.
- The matrix will be copied to af and factorized.
Constraint:
or .
- 2: – Character(1)Input
-
On entry: if
, the upper triangle of
is stored.
If , the lower triangle of is stored.
Constraint:
or .
- 3: – IntegerInput
-
On entry: , the number of linear equations, i.e., the order of the matrix .
Constraint:
.
- 4: – IntegerInput
-
On entry: , the number of right-hand sides, i.e., the number of columns of the matrix .
Constraint:
.
- 5: – Complex (Kind=nag_wp) arrayInput
-
Note: the second dimension of the array
a
must be at least
.
On entry: the
by
symmetric matrix
.
- If , the upper triangular part of must be stored and the elements of the array below the diagonal are not referenced.
- If , the lower triangular part of must be stored and the elements of the array above the diagonal are not referenced.
- 6: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f07npf (zsysvx) is called.
Constraint:
.
- 7: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
af
must be at least
.
On entry: if
,
af contains the block diagonal matrix
and the multipliers used to obtain the factor
or
from the factorization
or
as computed by
f07nrf (zsytrf).
On exit: if
,
af returns the block diagonal matrix
and the multipliers used to obtain the factor
or
from the factorization
or
.
- 8: – IntegerInput
-
On entry: the first dimension of the array
af as declared in the (sub)program from which
f07npf (zsysvx) is called.
Constraint:
.
- 9: – Integer arrayInput/Output
-
Note: the dimension of the array
ipiv
must be at least
.
On entry: if
,
ipiv contains details of the interchanges and the block structure of
, as determined by
f07nrf (zsytrf).
- if , is a by pivot block and the th row and column of were interchanged with the th row and column;
- if and , is a by pivot block and the th row and column of were interchanged with the th row and column;
- if and , is a by pivot block and the th row and column of were interchanged with the th row and column.
On exit: if
,
ipiv contains details of the interchanges and the block structure of
, as determined by
f07nrf (zsytrf), as described above.
- 10: – Complex (Kind=nag_wp) arrayInput
-
Note: the second dimension of the array
b
must be at least
.
On entry: the by right-hand side matrix .
- 11: – IntegerInput
-
On entry: the first dimension of the array
b as declared in the (sub)program from which
f07npf (zsysvx) is called.
Constraint:
.
- 12: – Complex (Kind=nag_wp) arrayOutput
-
Note: the second dimension of the array
x
must be at least
.
On exit: if or , the by solution matrix .
- 13: – IntegerInput
-
On entry: the first dimension of the array
x as declared in the (sub)program from which
f07npf (zsysvx) is called.
Constraint:
.
- 14: – Real (Kind=nag_wp)Output
-
On exit: the estimate of the reciprocal condition number of the matrix
. If
, the matrix may be exactly singular. This condition is indicated by
. Otherwise, if
rcond is less than the
machine precision, the matrix is singular to working precision. This condition is indicated by
.
- 15: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
ferr
must be at least
.
On exit: if
or
, an estimate of the forward error bound for each computed solution vector, such that
where
is the
th column of the computed solution returned in the array
x and
is the corresponding column of the exact solution
. The estimate is as reliable as the estimate for
rcond, and is almost always a slight overestimate of the true error.
- 16: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
berr
must be at least
.
On exit: if or , an estimate of the component-wise relative backward error of each computed solution vector (i.e., the smallest relative change in any element of or that makes an exact solution).
- 17: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
,
returns the optimal
lwork.
- 18: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f07npf (zsysvx) is called.
, and for best performance, when
,
, where
is the optimal block size for
f07nrf (zsytrf).
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.
- 19: – Real (Kind=nag_wp) arrayWorkspace
-
Note: the dimension of the array
rwork
must be at least
.
- 20: – IntegerOutput
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.
-
Element of the diagonal is exactly zero.
The factorization has been completed, but the factor is exactly singular,
so the solution and error bounds could not be computed.
is returned.
-
is nonsingular, but
rcond is less than
machine precision, meaning that the matrix is singular to working precision.
Nevertheless, the solution and error bounds are computed because there
are a number of situations where the computed solution can be more accurate
than the value of
rcond would suggest.
7
Accuracy
For each right-hand side vector
, the computed solution
is the exact solution of a perturbed system of equations
, where
where
is the
machine precision. See Chapter 11 of
Higham (2002) for further details.
If
is the true solution, then the computed solution
satisfies a forward error bound of the form
where
.
If
is the
th column of
, then
is returned in
and a bound on
is returned in
. See Section 4.4 of
Anderson et al. (1999) for further details.
8
Parallelism and Performance
f07npf (zsysvx) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f07npf (zsysvx) 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 factorization of requires approximately floating-point operations.
For each right-hand side, computation of the backward error involves a minimum of floating-point operations. Each step of iterative refinement involves an additional operations. At most five steps of iterative refinement are performed, but usually only one or two steps are required. Estimating the forward error involves solving a number of systems of equations of the form ; the number is usually or and never more than . Each solution involves approximately operations.
The real analogue of this routine is
f07mbf (dsysvx). The complex Hermitian analogue of this routine is
f07mpf (zhesvx).
10
Example
This example solves the equations
where
is the complex symmetric matrix
and
Error estimates for the solutions, and an estimate of the reciprocal of the condition number of the matrix are also output.
10.1
Program Text
Program Text (f07npfe.f90)
10.2
Program Data
Program Data (f07npfe.d)
10.3
Program Results
Program Results (f07npfe.r)