Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_lapack_dtpcon (f07ug)

## Purpose

nag_lapack_dtpcon (f07ug) estimates the condition number of a real triangular matrix, using packed storage.

## Syntax

[rcond, info] = f07ug(norm_p, uplo, diag, n, ap)
[rcond, info] = nag_lapack_dtpcon(norm_p, uplo, diag, n, ap)

## Description

nag_lapack_dtpcon (f07ug) estimates the condition number of a real triangular matrix $A$, in either the $1$-norm or the $\infty$-norm, using packed storage:
 $κ1 A = A1 A-11 or κ∞ A = A∞ A-1∞ .$
Note that ${\kappa }_{\infty }\left(A\right)={\kappa }_{1}\left({A}^{\mathrm{T}}\right)$.
Because the condition number is infinite if $A$ is singular, the function actually returns an estimate of the reciprocal of the condition number.
The function computes ${‖A‖}_{1}$ or ${‖A‖}_{\infty }$ exactly, and uses Higham's implementation of Hager's method (see Higham (1988)) to estimate ${‖{A}^{-1}‖}_{1}$ or ${‖{A}^{-1}‖}_{\infty }$.

## 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

## Parameters

### Compulsory Input Parameters

1:     $\mathrm{norm_p}$ – string (length ≥ 1)
Indicates whether ${\kappa }_{1}\left(A\right)$ or ${\kappa }_{\infty }\left(A\right)$ is estimated.
${\mathbf{norm_p}}=\text{'1'}$ or $\text{'O'}$
${\kappa }_{1}\left(A\right)$ is estimated.
${\mathbf{norm_p}}=\text{'I'}$
${\kappa }_{\infty }\left(A\right)$ is estimated.
Constraint: ${\mathbf{norm_p}}=\text{'1'}$, $\text{'O'}$ or $\text{'I'}$.
2:     $\mathrm{uplo}$ – string (length ≥ 1)
Specifies whether $A$ is upper or lower triangular.
${\mathbf{uplo}}=\text{'U'}$
$A$ is upper triangular.
${\mathbf{uplo}}=\text{'L'}$
$A$ is lower triangular.
Constraint: ${\mathbf{uplo}}=\text{'U'}$ or $\text{'L'}$.
3:     $\mathrm{diag}$ – string (length ≥ 1)
Indicates whether $A$ is a nonunit or unit triangular matrix.
${\mathbf{diag}}=\text{'N'}$
$A$ is a nonunit triangular matrix.
${\mathbf{diag}}=\text{'U'}$
$A$ is a unit triangular matrix; the diagonal elements are not referenced and are assumed to be $1$.
Constraint: ${\mathbf{diag}}=\text{'N'}$ or $\text{'U'}$.
4:     $\mathrm{n}$int64int32nag_int scalar
$n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
5:     $\mathrm{ap}\left(:\right)$ – double array
The dimension of the array ap must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
The $n$ by $n$ triangular matrix $A$, packed by columns.
More precisely,
• if ${\mathbf{uplo}}=\text{'U'}$, the upper triangle of $A$ must be stored with element ${A}_{ij}$ in ${\mathbf{ap}}\left(i+j\left(j-1\right)/2\right)$ for $i\le j$;
• if ${\mathbf{uplo}}=\text{'L'}$, the lower triangle of $A$ must be stored with element ${A}_{ij}$ in ${\mathbf{ap}}\left(i+\left(2n-j\right)\left(j-1\right)/2\right)$ for $i\ge j$.
If ${\mathbf{diag}}=\text{'U'}$, the diagonal elements of $A$ are assumed to be $1$, and are not referenced; the same storage scheme is used whether ${\mathbf{diag}}=\text{'N'}$ or ‘U’.

None.

### Output Parameters

1:     $\mathrm{rcond}$ – double scalar
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.
2:     $\mathrm{info}$int64int32nag_int scalar
${\mathbf{info}}=0$ unless the function detects an error (see Error Indicators and Warnings).

## Error Indicators and Warnings

${\mathbf{info}}<0$
If ${\mathbf{info}}=-i$, argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

## Accuracy

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

A call to nag_lapack_dtpcon (f07ug) involves solving a number of systems of linear equations of the form $Ax=b$ or ${A}^{\mathrm{T}}x=b$; the number is usually $4$ or $5$ and never more than $11$. Each solution involves approximately ${n}^{2}$ floating-point operations but takes considerably longer than a call to nag_lapack_dtptrs (f07ue) with one right-hand side, because extra care is taken to avoid overflow when $A$ is approximately singular.
The complex analogue of this function is nag_lapack_ztpcon (f07uu).

## Example

This example estimates the condition number in the $1$-norm of the matrix $A$, where
 $A= 4.30 0.00 0.00 0.00 -3.96 -4.87 0.00 0.00 0.40 0.31 -8.02 0.00 -0.27 0.07 -5.95 0.12 ,$
using packed storage. The true condition number in the $1$-norm is $116.41$.
```function f07ug_example

fprintf('f07ug example results\n\n');

% Estimate condition number of A, where A is Lower triangular and packed
n = int64(4);
ap = [ 4.30; -3.96;  0.40; -0.27;
-4.87;  0.31;  0.07;
-8.02; -5.95;
0.12];

% Estimate condition number
norm_p = '1';
uplo = 'L';
diag = 'N';
[rcond, info] = f07ug( ...
norm_p, uplo, diag, n, ap);

fprintf('Estimate of condition number = %9.2e\n', 1/rcond);

```
```f07ug example results

Estimate of condition number =  1.16e+02
```