NAG Library Function Document

nag_complex_gen_lin_solve (f04cac)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

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

3
Description

The LU decomposition with partial pivoting and row interchanges is used to factor A as A=PLU, where P is a permutation matrix, L is unit lower triangular, and U is upper triangular. 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:     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:     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 coefficient matrix A.
On exit: if fail.code= NE_NOERROR, the factors L and U from the factorization A=PLU. The unit diagonal elements of L are not stored.
5:     pda IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraint: pdamax1,n.
6:     ipiv[n] IntegerOutput
On exit: if fail.code= NE_NOERROR, the pivot indices that define the permutation matrix P; at the ith step row i of the matrix was interchanged with row ipiv[i-1]. ipiv[i-1]=i indicates a row interchange was not required.
7:     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.
8:     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.
9:     rcond double *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.
10:   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.
11:   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 Complex allocatable memory required is 2×n, and the double allocatable memory required is 2×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, 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.
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_RCOND
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.
NE_SINGULAR
Diagonal element value of the upper triangular factor 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_gen_lin_solve (f04cac) 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_complex_gen_lin_solve (f04cac) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_complex_gen_lin_solve (f04cac) 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 23n3+n2r. 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 real analogue of nag_complex_gen_lin_solve (f04cac) is nag_real_gen_lin_solve (f04bac).

10
Example

This example solves the equations
AX=B,  
where
A = -1.34+2.55i 0.28+3.17i -6.39-2.20i 0.72-0.92i -0.17-1.41i 3.31-0.15i -0.15+1.34i 1.29+1.38i -3.29-2.39i -1.91+4.42i -0.14-1.35i 1.72+1.35i 2.41+0.39i -0.56+1.47i -0.83-0.69i -1.96+0.67i  
and
B= 26.26+51.78i 31.32-06.70i 6.43-08.68i 15.86-01.42i -5.75+25.31i -2.15+30.19i 1.16+02.57i -2.56+07.55i .  
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 (f04cace.c)

10.2
Program Data

Program Data (f04cace.d)

10.3
Program Results

Program Results (f04cace.r)

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