naginterfaces.library.lapacklin.zsycon

naginterfaces.library.lapacklin.zsycon(uplo, a, ipiv, anorm)

zsycon estimates the condition number of a complex symmetric matrix $A$, where $A$ has been factorized by zsytrf().

For full information please refer to the NAG Library document for f07nu

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/f07/f07nuf.html

Parameters

uplostr, length 1

Specifies how $A$ has been factorized.

$uplo=\text{'U'}$

$A=PUD{U}^H{P}^T$, where $U$ is upper triangular.

$uplo=\text{'L'}$

$A=PLD{L}^H{P}^T$, where $L$ is lower triangular.

acomplex, array-like, shape $(n,n)$

Details of the factorization of $A$, as returned by zsytrf().

ipivint, array-like, shape $\left(n\right)$

Details of the interchanges and the block structure of $D$, as returned by zsytrf().

anormfloat

The $1$-norm of the original matrix $A$, which may be computed by calling blas.zlansy with its argument $\text{norm}=\text{'1'}$. $anorm$ must be computed either before calling zsytrf() or else from a copy of the original matrix $A$.

Returns

rcondfloat

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.

Raises

NagValueError

(errno $-1$)

On entry, error in parameter $uplo$.

Constraint: $uplo=\text{'U'}$ or $\text{'L'}$.

(errno $-2$)

On entry, error in parameter $\text{n}$.

Constraint: $n\ge 0$.

(errno $-6$)

On entry, error in parameter $anorm$.

Constraint: $anorm\ge 0.0$.

Notes

zsycon estimates the condition number (in the $1$-norm) of a complex symmetric matrix $A$:

$${\kappa }_1\left(A\right)={\parallel A\parallel }_1{\Vert A^{-1}\Vert }_1\text{.}$$

Since $A$ is symmetric, ${\kappa }_1\left(A\right)={\kappa }_{\infty }\left(A\right)={\parallel A\parallel }_{\infty }{\Vert A^{-1}\Vert }_{\infty }$.

Because ${\kappa }_1\left(A\right)$ is infinite if $A$ is singular, the function actually returns an estimate of the reciprocal of ${\kappa }_1\left(A\right)$.

The function should be preceded by a call to blas.zlansy to compute ${\parallel A\parallel }_1$ and a call to zsytrf() to compute the Bunch–Kaufman factorization of $A$. The function then uses Higham’s implementation of Hager’s method (see Higham (1988)) to estimate ${\Vert A^{-1}\Vert }_1$.

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