nag_complex_sym_lin_solve (f04dhc) (PDF version)
f04 Chapter Contents
f04 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_complex_sym_lin_solve (f04dhc)

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_complex_sym_lin_solve (f04dhc) computes the solution to a complex system of linear equations AX=B, where A is an n by n complex symmetric 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_complex_sym_lin_solve (Nag_OrderType order, Nag_UploType uplo, Integer n, Integer nrhs, Complex a[], Integer pda, Integer ipiv[], Complex b[], Integer pdb, double *rcond, double *errbnd, NagError *fail)

3  Description

The diagonal pivoting method is used to factor A as A=UDUT, if uplo=Nag_Upper, or A=LDLT, if uplo=Nag_Lower, where U (or L) is a product of permutation and unit upper (lower) triangular matrices, and D is symmetric and block diagonal with 1 by 1 and 2 by 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 http://www.netlib.org/lapack/lug
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5  Arguments

1:     orderNag_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.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     uploNag_UploTypeInput
On entry: if uplo=Nag_Upper, the upper triangle of the matrix A is stored.
If uplo=Nag_Lower, the lower triangle of the matrix A is stored.
Constraint: uplo=Nag_Upper or Nag_Lower.
3:     nIntegerInput
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: n0.
4:     nrhsIntegerInput
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: nrhs0.
5:     a[dim]ComplexInput/Output
Note: the dimension, dim, of the array a must be at least max1,pda×n.
The i,jth element of the matrix A is stored in
  • a[j-1×pda+i-1] when order=Nag_ColMajor;
  • a[i-1×pda+j-1] when order=Nag_RowMajor.
On entry: the n by n complex symmetric matrix A.
If uplo=Nag_Upper, the leading n by n upper triangular part of the array a contains the upper triangular part of the matrix A, and the strictly lower triangular part of a is not referenced.
If uplo=Nag_Lower, the leading n by n lower triangular part of the array a contains the lower triangular part of the matrix A, and the strictly upper triangular part of a is not referenced.
On exit: if fail.code= NE_NOERROR, 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 nag_zsytrf (f07nrc).
6:     pdaIntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraint: pdamax1,n.
7:     ipiv[n]IntegerOutput
On exit: if fail.code= NE_NOERROR, details of the interchanges and the block structure of D, as determined by nag_zsytrf (f07nrc).
  • If ipiv[k-1]>0, then rows and columns k and ipiv[k-1] were interchanged, and dkk is a 1 by 1 diagonal block;
  • if uplo=Nag_Upper and ipiv[k-1]=ipiv[k-2]<0, then rows and columns k-1 and -ipiv[k-1] were interchanged and dk-1:k,k-1:k is a 2 by 2 diagonal block;
  • if uplo=Nag_Lower and ipiv[k-1]=ipiv[k]<0, then rows and columns k+1 and -ipiv[k-1] were interchanged and dk:k+1,k:k+1 is a 2 by 2 diagonal block.
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 matrix of right-hand sides B.
On exit: if fail.code= NE_NOERROR or NE_RCOND, the n by r solution matrix X.
9:     pdbIntegerInput
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:   rconddouble *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.
11:   errbnddouble *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, then errbnd is returned as unity.
12:   failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
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, pda=value.
Constraint: pda>0.
On entry, pdb=value.
Constraint: pdb>0.
NE_INT_2
On entry, pda=value and n=value.
Constraint: pdamax1,n.
On entry, pdb =value and n =value.
Constraint: pdbmax1,n.
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.
NE_RCOND
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.
NE_SINGULAR
Diagonal block value of the block diagonal matrix is zero. The factorization has been completed, but the solution could not be computed.

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. nag_complex_sym_lin_solve (f04dhc) uses the approximation E1=εA1 to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8  Further Comments

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.
Function nag_herm_lin_solve (f04chc) is for complex Hermitian matrices, and the real analogue of nag_complex_sym_lin_solve (f04dhc) is nag_real_sym_lin_solve (f04bhc).

9  Example

This example solves the equations
AX=B,
where A is the symmetric indefinite matrix
A= -0.56+0.12i -1.54-2.86i 5.32-1.59i 3.80+0.92i -1.54-2.86i -2.83-0.03i -3.52+0.58i -7.86-2.96i 5.32-1.59i -3.52+0.58i 8.86+1.81i 5.14-0.64i 3.80+0.92i -7.86-2.96i 5.14-0.64i -0.39-0.71i
and
B= -6.43+19.24i -4.59-35.53i -0.49-01.47i 6.95+20.49i -48.18+66.00i -12.08-27.02i -55.64+41.22i -19.09-35.97i .
An estimate of the condition number of A and an approximate error bound for the computed solutions are also printed.

9.1  Program Text

Program Text (f04dhce.c)

9.2  Program Data

Program Data (f04dhce.d)

9.3  Program Results

Program Results (f04dhce.r)


nag_complex_sym_lin_solve (f04dhc) (PDF version)
f04 Chapter Contents
f04 Chapter Introduction
NAG C Library Manual

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