NAG C Library Function Document

nag_zsycon (f07nuc)

1
Purpose

nag_zsycon (f07nuc) estimates the condition number of a complex symmetric matrix A, where A has been factorized by nag_zsytrf (f07nrc).

2
Specification

#include <nag.h>
#include <nagf07.h>
void  nag_zsycon (Nag_OrderType order, Nag_UploType uplo, Integer n, const Complex a[], Integer pda, const Integer ipiv[], double anorm, double *rcond, NagError *fail)

3
Description

nag_zsycon (f07nuc) estimates the condition number (in the 1-norm) of a complex symmetric matrix A:
κ1A=A1A-11 .  
Since A is symmetric, κ1A=κA=AA-1.
Because κ1A is infinite if A is singular, the function actually returns an estimate of the reciprocal of κ1A.
The function should be preceded by a call to nag_zsy_norm (f16ufc) to compute A1 and a call to nag_zsytrf (f07nrc) to compute the Bunch–Kaufman factorization of A. The function then uses Higham's implementation of Hager's method (see Higham (1988)) to estimate A-11.

4
References

Higham N J (1988) FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation ACM Trans. Math. Software 14 381–396

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 how A has been factorized.
uplo=Nag_Upper
A=PUDUTPT, where U is upper triangular.
uplo=Nag_Lower
A=PLDLTPT, where L is lower triangular.
Constraint: uplo=Nag_Upper or Nag_Lower.
3:     n IntegerInput
On entry: n, the order of the matrix A.
Constraint: n0.
4:     a[dim] const ComplexInput
Note: the dimension, dim, of the array a must be at least max1,pda×n.
On entry: details of the factorization of A, as returned by nag_zsytrf (f07nrc).
5:     pda IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) of the matrix in the array a.
Constraint: pdamax1,n.
6:     ipiv[dim] const IntegerInput
Note: the dimension, dim, of the array ipiv must be at least max1,n.
On entry: details of the interchanges and the block structure of D, as returned by nag_zsytrf (f07nrc).
7:     anorm doubleInput
On entry: the 1-norm of the original matrix A, which may be computed by calling nag_zsy_norm (f16ufc) with its argument norm=Nag_OneNorm. anorm must be computed either before calling nag_zsytrf (f07nrc) or else from a copy of the original matrix A.
Constraint: anorm0.0.
8:     rcond double *Output
On exit: an estimate of the reciprocal of the condition number of A. rcond is set to zero if exact singularity is detected or the estimate underflows. If rcond is less than machine precision, A is singular to working precision.
9:     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_REAL
On entry, anorm=value.
Constraint: anorm0.0.

7
Accuracy

The computed estimate rcond is never less than the true value ρ, and in practice is nearly always less than 10ρ, although examples can be constructed where rcond is much larger.

8
Parallelism and Performance

nag_zsycon (f07nuc) 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

A call to nag_zsycon (f07nuc) involves solving a number of systems of linear equations of the form Ax=b; the number is usually 5 and never more than 11. Each solution involves approximately 8n2 real floating-point operations but takes considerably longer than a call to nag_zsytrs (f07nsc) with one right-hand side, because extra care is taken to avoid overflow when A is approximately singular.
The real analogue of this function is nag_dsycon (f07mgc).

10
Example

This example estimates the condition number in the 1-norm (or -norm) of the matrix A, where
A= -0.39-0.71i 5.14-0.64i -7.86-2.96i 3.80+0.92i 5.14-0.64i 8.86+1.81i -3.52+0.58i 5.32-1.59i -7.86-2.96i -3.52+0.58i -2.83-0.03i -1.54-2.86i 3.80+0.92i 5.32-1.59i -1.54-2.86i -0.56+0.12i .  
Here A is symmetric and must first be factorized by nag_zsytrf (f07nrc). The true condition number in the 1-norm is 32.92.

10.1
Program Text

Program Text (f07nuce.c)

10.2
Program Data

Program Data (f07nuce.d)

10.3
Program Results

Program Results (f07nuce.r)