NAG FL Interface
f04bjf (real_​symm_​packed_​solve)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

f04bjf computes the solution to a real system of linear equations AX=B, where A is an n×n symmetric matrix, stored in packed format and X and B are n×r matrices. An estimate of the condition number of A and an error bound for the computed solution are also returned.

2 Specification

Fortran Interface
Subroutine f04bjf ( uplo, n, nrhs, ap, ipiv, b, ldb, rcond, errbnd, ifail)
Integer, Intent (In) :: n, nrhs, ldb
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: ipiv(n)
Real (Kind=nag_wp), Intent (Inout) :: ap(*), b(ldb,*)
Real (Kind=nag_wp), Intent (Out) :: rcond, errbnd
Character (1), Intent (In) :: uplo
C Header Interface
#include <nag.h>
void  f04bjf_ (const char *uplo, const Integer *n, const Integer *nrhs, double ap[], Integer ipiv[], double b[], const Integer *ldb, double *rcond, double *errbnd, Integer *ifail, const Charlen length_uplo)
The routine may be called by the names f04bjf or nagf_linsys_real_symm_packed_solve.

3 Description

The diagonal pivoting method is used to factor A as A=UDUT, if uplo='U', or A=LDLT, if uplo='L', where U (or L) is a product of permutation and unit upper (lower) triangular matrices, and D is symmetric and block diagonal with 1×1 and 2×2 diagonal blocks. The factored form of A is then used to solve the system of equations AX=B.

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
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5 Arguments

1: uplo Character(1) Input
On entry: if uplo='U', the upper triangle of the matrix A is stored.
If uplo='L', the lower triangle of the matrix A is stored.
Constraint: uplo='U' or 'L'.
2: n Integer Input
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: n0.
3: nrhs Integer Input
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: nrhs0.
4: ap(*) Real (Kind=nag_wp) array Input/Output
Note: the dimension of the array ap must be at least max(1,n×(n+1)/2).
On entry: the n×n symmetric matrix A, packed column-wise in a linear array. The jth column of the matrix A is stored in the array ap as follows:
More precisely,
  • if uplo='U', the upper triangle of A must be stored with element Aij in ap(i+j(j-1)/2) for ij;
  • if uplo='L', the lower triangle of A must be stored with element Aij in ap(i+(2n-j)(j-1)/2) for ij.
On exit: if ifail0, the block diagonal matrix D and the multipliers used to obtain the factor U or L from the factorization A=UDUT or A=LDLT as computed by f07pdf, stored as a packed triangular matrix in the same storage format as A.
5: ipiv(n) Integer array Output
On exit: if ifail0, details of the interchanges and the block structure of D, as determined by f07pdf.
  • If ipiv(k)>0, then rows and columns k and ipiv(k) were interchanged, and dkk is a 1×1 diagonal block;
  • if uplo='U' and ipiv(k)=ipiv(k-1)<0, then rows and columns k-1 and -ipiv(k) were interchanged and dk-1:k,k-1:k is a 2×2 diagonal block;
  • if uplo='L' and ipiv(k)=ipiv(k+1)<0, then rows and columns k+1 and -ipiv(k) were interchanged and dk:k+1,k:k+1 is a 2×2 diagonal block.
6: b(ldb,*) Real (Kind=nag_wp) array Input/Output
Note: the second dimension of the array b must be at least max(1,nrhs).
On entry: the n×r matrix of right-hand sides B.
On exit: if ifail=0 or n+1, the n×r solution matrix X.
7: ldb Integer Input
On entry: the first dimension of the array b as declared in the (sub)program from which f04bjf is called.
Constraint: ldbmax(1,n).
8: rcond Real (Kind=nag_wp) Output
On exit: if no constraints are violated, an estimate of the reciprocal of the condition number of the matrix A, computed as rcond=1/(A1A-11).
9: errbnd Real (Kind=nag_wp) Output
On exit: if ifail=0 or n+1, an estimate of the forward error bound for a computed solution x^, such that x^-x1/x1errbnd, where x^ is a column of the computed solution returned in the array b and x is the corresponding column of the exact solution X. If rcond is less than machine precision, errbnd is returned as unity.
10: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry ifail=0 or −1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
Diagonal block value of the block diagonal matrix is zero. The factorization has been completed, but the solution could not be computed.
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.
On entry, uplo not one of 'U' or 'u' or 'L' or 'l': uplo=value.
On entry, n=value.
Constraint: n0.
On entry, nrhs=value.
Constraint: nrhs0.
On entry, ldb=value and n=value.
Constraint: ldbmax(1,n).
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
The integer allocatable memory required is n, and the real allocatable memory required is 2×n. Allocation failed before the solution could be computed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

The computed solution for a single right-hand side, x^, satisfies an equation of the form
(A+E) x^=b,  
E1 = O(ε) A1  
and ε is the machine precision. An approximate error bound for the computed solution is given by
x^-x1 x1 κ(A) E1 A1 ,  
where κ(A) = A-11 A1 , the condition number of A with respect to the solution of the linear equations. f04bjf uses the approximation E1=εA1 to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f04bjf 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.

9 Further Comments

The packed storage scheme is illustrated by the following example when n=4 and uplo='U'. Two-dimensional storage of the symmetric matrix A:
a11 a12 a13 a14 a22 a23 a24 a33 a34 a44 (aij=aji)  
Packed storage of the upper triangle of A:
ap= [ a11, a12, a22, a13, a23, a33, a14, a24, a34, a44 ]  
The total number of floating-point operations required to solve the equations AX=B is proportional to (13n3+2n2r). The condition number estimation typically requires between four and five solves and never more than eleven solves, following the factorization.
In practice the condition number estimator is very reliable, but it can underestimate the true condition number; see Section 15.3 of Higham (2002) for further details.
The complex analogues of f04bjf are f04cjf for complex Hermitian matrices, and f04djf for complex symmetric matrices.

10 Example

This example solves the equations
where A is the symmetric indefinite matrix
A= ( -1.81 2.06 0.63 -1.15 2.06 1.15 1.87 4.20 0.63 1.87 -0.21 3.87 -1.15 4.20 3.87 2.07 )   and   B= ( 0.96 3.93 6.07 19.25 8.38 9.90 9.50 27.85 ) .  
An estimate of the condition number of A and an approximate error bound for the computed solutions are also printed.

10.1 Program Text

Program Text (f04bjfe.f90)

10.2 Program Data

Program Data (f04bjfe.d)

10.3 Program Results

Program Results (f04bjfe.r)