NAG C Library Function Document

nag_ztptrs (f07usc)

1
Purpose

nag_ztptrs (f07usc) solves a complex triangular system of linear equations with multiple right-hand sides, AX=B, ATX=B or AHX=B, using packed storage.

2
Specification

#include <nag.h>
#include <nagf07.h>
void  nag_ztptrs (Nag_OrderType order, Nag_UploType uplo, Nag_TransType trans, Nag_DiagType diag, Integer n, Integer nrhs, const Complex ap[], Complex b[], Integer pdb, NagError *fail)

3
Description

nag_ztptrs (f07usc) solves a complex triangular system of linear equations AX=B, ATX=B or AHX=B, using packed storage.

4
References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
Higham N J (1989) The accuracy of solutions to triangular systems SIAM J. Numer. Anal. 26 1252–1265

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:     uplo Nag_UploTypeInput
On entry: specifies whether A is upper or lower triangular.
uplo=Nag_Upper
A is upper triangular.
uplo=Nag_Lower
A is lower triangular.
Constraint: uplo=Nag_Upper or Nag_Lower.
3:     trans Nag_TransTypeInput
On entry: indicates the form of the equations.
trans=Nag_NoTrans
The equations are of the form AX=B.
trans=Nag_Trans
The equations are of the form ATX=B.
trans=Nag_ConjTrans
The equations are of the form AHX=B.
Constraint: trans=Nag_NoTrans, Nag_Trans or Nag_ConjTrans.
4:     diag Nag_DiagTypeInput
On entry: indicates whether A is a nonunit or unit triangular matrix.
diag=Nag_NonUnitDiag
A is a nonunit triangular matrix.
diag=Nag_UnitDiag
A is a unit triangular matrix; the diagonal elements are not referenced and are assumed to be 1.
Constraint: diag=Nag_NonUnitDiag or Nag_UnitDiag.
5:     n IntegerInput
On entry: n, the order of the matrix A.
Constraint: n0.
6:     nrhs IntegerInput
On entry: r, the number of right-hand sides.
Constraint: nrhs0.
7:     ap[dim] const ComplexInput
Note: the dimension, dim, of the array ap must be at least max1,n×n+1/2.
On entry: the n by n triangular matrix A, packed by rows or columns.
The storage of elements Aij depends on the order and uplo arguments as follows:
  • if order=Nag_ColMajor and uplo=Nag_Upper,
              Aij is stored in ap[j-1×j/2+i-1], for ij;
  • if order=Nag_ColMajor and uplo=Nag_Lower,
              Aij is stored in ap[2n-j×j-1/2+i-1], for ij;
  • if order=Nag_RowMajor and uplo=Nag_Upper,
              Aij is stored in ap[2n-i×i-1/2+j-1], for ij;
  • if order=Nag_RowMajor and uplo=Nag_Lower,
              Aij is stored in ap[i-1×i/2+j-1], for ij.
If diag=Nag_UnitDiag, the diagonal elements of AP are assumed to be 1, and are not referenced; the same storage scheme is used whether diag=Nag_NonUnitDiag or diag=Nag_UnitDiag.
8:     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: the n by r solution matrix X.
9:     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.
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.
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_SINGULAR
Element value of the diagonal is exactly zero. A is singular and the solution has not been computed.

7
Accuracy

The solutions of triangular systems of equations are usually computed to high accuracy. See Higham (1989).
For each right-hand side vector b, the computed solution x is the exact solution of a perturbed system of equations A+Ex=b, where
EcnεA ,  
cn is a modest linear function of n, and ε is the machine precision.
If x^ is the true solution, then the computed solution x satisfies a forward error bound of the form
x-x^ x cncondA,xε ,   provided   cncondA,xε<1 ,  
where condA,x=A-1Ax/x.
Note that condA,xcondA=A-1AκA; condA,x can be much smaller than condA and it is also possible for condAH, which is the same as condAT, to be much larger (or smaller) than condA.
Forward and backward error bounds can be computed by calling nag_ztprfs (f07uvc), and an estimate for κA can be obtained by calling nag_ztpcon (f07uuc) with norm=Nag_InfNorm.

8
Parallelism and Performance

nag_ztptrs (f07usc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_ztptrs (f07usc) 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 real floating-point operations is approximately 4n2r.
The real analogue of this function is nag_dtptrs (f07uec).

10
Example

This example solves the system of equations AX=B, where
A= 4.78+4.56i 0.00+0.00i 0.00+0.00i 0.00+0.00i 2.00-0.30i -4.11+1.25i 0.00+0.00i 0.00+0.00i 2.89-1.34i 2.36-4.25i 4.15+0.80i 0.00+0.00i -1.89+1.15i 0.04-3.69i -0.02+0.46i 0.33-0.26i  
and
B= -14.78-32.36i -18.02+28.46i 2.98-02.14i 14.22+15.42i -20.96+17.06i 5.62+35.89i 9.54+09.91i -16.46-01.73i ,  
using packed storage for A.

10.1
Program Text

Program Text (f07usce.c)

10.2
Program Data

Program Data (f07usce.d)

10.3
Program Results

Program Results (f07usce.r)