NAG Library Function Document

nag_zgetri (f07awc)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

nag_zgetri (f07awc) computes the inverse of a complex matrix A, where A has been factorized by nag_zgetrf (f07arc).

2
Specification

#include <nag.h>
#include <nagf07.h>
void  nag_zgetri (Nag_OrderType order, Integer n, Complex a[], Integer pda, const Integer ipiv[], NagError *fail)

3
Description

nag_zgetri (f07awc) is used to compute the inverse of a complex matrix A, the function must be preceded by a call to nag_zgetrf (f07arc), which computes the LU factorization of A as A=PLU. The inverse of A is computed by forming U-1 and then solving the equation XPL=U-1 for X.

4
References

Du Croz J J and Higham N J (1992) Stability of methods for matrix inversion IMA J. Numer. Anal. 12 1–19

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:     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 LU factorization of A, as returned by nag_zgetrf (f07arc).
On exit: the factorization is overwritten by the n by n matrix A-1.
4:     pda IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraint: pdamax1,n.
5:     ipiv[dim] const IntegerInput
Note: the dimension, dim, of the array ipiv must be at least max1,n.
On entry: the pivot indices, as returned by nag_zgetrf (f07arc).
6:     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, pda=value.
Constraint: pda>0.
NE_INT_2
On entry, pda=value and n=value.
Constraint: pdamax1,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.
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 zero. U is singular, and the inverse of A cannot be computed.

7
Accuracy

The computed inverse X satisfies a bound of the form:
XA-IcnεXPLU ,  
where cn is a modest linear function of n, and ε is the machine precision.
Note that a similar bound for AX-I cannot be guaranteed, although it is almost always satisfied. See Du Croz and Higham (1992).

8
Parallelism and Performance

nag_zgetri (f07awc) 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 163n3.
The real analogue of this function is nag_dgetri (f07ajc).

10
Example

This example computes the inverse of the matrix A, 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 .  
Here A is nonsymmetric and must first be factorized by nag_zgetrf (f07arc).

10.1
Program Text

Program Text (f07awce.c)

10.2
Program Data

Program Data (f07awce.d)

10.3
Program Results

Program Results (f07awce.r)

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