NAG C Library Function Document

nag_herm_posdef_tridiag_lin_solve (f04cgc)

1
Purpose

nag_herm_posdef_tridiag_lin_solve (f04cgc) computes the solution to a complex system of linear equations AX=B, where A is an n by n Hermitian positive definite tridiagonal matrix and X and B are n by r matrices. An estimate of the condition number of A and an error bound for the computed solution are also returned.

2
Specification

#include <nag.h>
#include <nagf04.h>
void  nag_herm_posdef_tridiag_lin_solve (Nag_OrderType order, Integer n, Integer nrhs, double d[], Complex e[], Complex b[], Integer pdb, double *rcond, double *errbnd, NagError *fail)

3
Description

A is factorized as A=LDLH, where L is a unit lower bidiagonal matrix and D is a real diagonal matrix, and the factored form of A is then used to solve the system of equations.

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

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 order=Nag_RowMajor. See Section 3.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     n IntegerInput
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: n0.
3:     nrhs IntegerInput
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: nrhs0.
4:     d[dim] doubleInput/Output
Note: the dimension, dim, of the array d must be at least max1,n.
On entry: must contain the n diagonal elements of the tridiagonal matrix A.
On exit: if fail.code= NE_NOERROR or NE_RCOND, d is overwritten by the n diagonal elements of the diagonal matrix D from the LDLH factorization of A.
5:     e[dim] ComplexInput/Output
Note: the dimension, dim, of the array e must be at least max1,n-1.
On entry: must contain the n-1 subdiagonal elements of the tridiagonal matrix A.
On exit: if fail.code= NE_NOERROR or NE_RCOND, e is overwritten by the n-1 subdiagonal elements of the unit lower bidiagonal matrix L from the LDLH factorization of A. (e can also be regarded as the conjugate of the superdiagonal of the unit upper bidiagonal factor U from the UHDU factorization of A.)
6:     b[dim] ComplexInput/Output
Note: the dimension, dim, of the array b must be at least
  • max1,pdb×nrhs when order=Nag_ColMajor;
  • max1,n×pdb when order=Nag_RowMajor.
The i,jth element of the matrix B is stored in
  • b[j-1×pdb+i-1] when order=Nag_ColMajor;
  • b[i-1×pdb+j-1] when order=Nag_RowMajor.
On entry: the n by r matrix of right-hand sides B.
On exit: if fail.code= NE_NOERROR or NE_RCOND, the n by r solution matrix X.
7:     pdb IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array b.
Constraints:
  • if order=Nag_ColMajor, pdbmax1,n;
  • if order=Nag_RowMajor, pdbmax1,nrhs.
8:     rcond double *Output
On exit: if fail.code= NE_NOERROR or NE_RCOND, an estimate of the reciprocal of the condition number of the matrix A, computed as rcond=1/A1,A-11.
9:     errbnd double *Output
On exit: if fail.code= NE_NOERROR or NE_RCOND, 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:   fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6
Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
The double allocatable memory required is n. In this case the factorization and the solution X have been computed, but rcond and errbnd have not been computed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, n=value.
Constraint: n0.
On entry, nrhs=value.
Constraint: nrhs0.
On entry, pdb=value.
Constraint: pdb>0.
NE_INT_2
On entry, pdb=value and n=value.
Constraint: pdbmax1,n.
On entry, pdb=value and nrhs=value.
Constraint: pdbmax1,nrhs.
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.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
NE_POS_DEF
The principal minor of order value of the matrix A is not positive definite. The factorization has not been completed and the solution could not be computed.
NE_RCOND
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.

7
Accuracy

The computed solution for a single right-hand side, x^, satisfies an equation of the form
A+E x^=b,  
where
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-11A1, the condition number of A with respect to the solution of the linear equations. nag_herm_posdef_tridiag_lin_solve (f04cgc) uses the approximation E1=εA1 to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8
Parallelism and Performance

nag_herm_posdef_tridiag_lin_solve (f04cgc) 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9
Further Comments

The total number of floating-point operations required to solve the equations AX=B is proportional to nr. The condition number estimation requires On floating-point operations.
See Section 15.3 of Higham (2002) for further details on computing the condition number of tridiagonal matrices.
The real analogue of nag_herm_posdef_tridiag_lin_solve (f04cgc) is nag_real_sym_posdef_tridiag_lin_solve (f04bgc).

10
Example

This example solves the equations
AX=B,  
where A is the Hermitian positive definite tridiagonal matrix
A= 16.0i+00.0 16.0+16.0i 0.0i+0.0 0.0i+0.0 16.0-16.0i 41.0i+00.0 18.0-9.0i 0.0i+0.0 0.0i+00.0 18.0+09.0i 46.0i+0.0 1.0-4.0i 0.0i+00.0 0.0i+00.0 1.0+4.0i 21.0i+0.0  
and
B= 64.0+16.0i -16.0-32.0i 93.0+62.0i 61.0-66.0i 78.0-80.0i 71.0-74.0i 14.0-27.0i 35.0+15.0i .  
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 (f04cgce.c)

10.2
Program Data

Program Data (f04cgce.d)

10.3
Program Results

Program Results (f04cgce.r)