NAG Library Function Document

nag_zptsv (f07jnc)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

nag_zptsv (f07jnc) 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.

2
Specification

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

3
Description

nag_zptsv (f07jnc) factors A as A=LDLH. 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
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 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: n, the order of the matrix A.
Constraint: n0.
3:     nrhs IntegerInput
On entry: r, the number of right-hand sides, 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: the n diagonal elements of the tridiagonal matrix A.
On exit: the n diagonal elements of the diagonal matrix D from the factorization A=LDLH.
5:     e[dim] ComplexInput/Output
Note: the dimension, dim, of the array e must be at least max1,n-1.
On entry: the n-1 subdiagonal elements of the tridiagonal matrix A.
On exit: the n-1 subdiagonal elements of the unit bidiagonal factor L from the LDLH factorization of A. (e can also be regarded as the superdiagonal of the unit 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 right-hand side matrix B.
On exit: if fail.code= NE_NOERROR, 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:     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.
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_MAT_NOT_POS_DEF
The leading minor of order value is not positive definite, and the solution has not been computed. The factorization has not been completed unless n=value.
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.

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-11 A1 , the condition number of A  with respect to the solution of the linear equations. See Section 4.4 of Anderson et al. (1999) for further details.
nag_zptsvx (f07jpc) is a comprehensive LAPACK driver that returns forward and backward error bounds and an estimate of the condition number. Alternatively, nag_herm_posdef_tridiag_lin_solve (f04cgc) solves Ax=b  and returns a forward error bound and condition estimate. nag_herm_posdef_tridiag_lin_solve (f04cgc) calls nag_zptsv (f07jnc) to solve the equations.

8
Parallelism and Performance

nag_zptsv (f07jnc) 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 number of floating-point operations required for the factorization of A  is proportional to n , and the number of floating-point operations required for the solution of the equations is proportional to nr , where r  is the number of right-hand sides.
The real analogue of this function is nag_dptsv (f07jac).

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 93.0+62.0i 78.0-80.0i 14.0-27.0i .  
Details of the LDLH  factorization of A  are also output.

10.1
Program Text

Program Text (f07jnce.c)

10.2
Program Data

Program Data (f07jnce.d)

10.3
Program Results

Program Results (f07jnce.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017