NAG CL Interface
f07vuc (ztbcon)

Settings help

CL Name Style:


1 Purpose

f07vuc estimates the condition number of a complex triangular band matrix.

2 Specification

#include <nag.h>
void  f07vuc (Nag_OrderType order, Nag_NormType norm, Nag_UploType uplo, Nag_DiagType diag, Integer n, Integer kd, const Complex ab[], Integer pdab, double *rcond, NagError *fail)
The function may be called by the names: f07vuc, nag_lapacklin_ztbcon or nag_ztbcon.

3 Description

f07vuc estimates the condition number of a complex triangular band matrix A, in either the 1-norm or the -norm:
κ1(A)=A1A-11   or   κ(A)=AA-1 .  
Note that κ(A)=κ1(AT).
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 A1 or A exactly, and uses Higham's implementation of Hager's method (see Higham (1988)) to estimate A-11 or A-1.

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_OrderType Input
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.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2: norm Nag_NormType Input
On entry: indicates whether κ1(A) or κ(A) is estimated.
norm=Nag_OneNorm
κ1(A) is estimated.
norm=Nag_InfNorm
κ(A) is estimated.
Constraint: norm=Nag_OneNorm or Nag_InfNorm.
3: uplo Nag_UploType Input
On entry: specifies whether A is upper or lower triangular.
uplo=Nag_Upper
A is upper triangular.
uplo=Nag_Lower
A is lower triangular.
Constraint: uplo=Nag_Upper or Nag_Lower.
4: diag Nag_DiagType Input
On entry: indicates whether A is a nonunit or unit triangular matrix.
diag=Nag_NonUnitDiag
A is a nonunit triangular matrix.
diag=Nag_UnitDiag
A is a unit triangular matrix; the diagonal elements are not referenced and are assumed to be 1.
Constraint: diag=Nag_NonUnitDiag or Nag_UnitDiag.
5: n Integer Input
On entry: n, the order of the matrix A.
Constraint: n0.
6: kd Integer Input
On entry: kd, the number of superdiagonals of the matrix A if uplo=Nag_Upper, or the number of subdiagonals if uplo=Nag_Lower.
Constraint: kd0.
7: ab[dim] const Complex Input
Note: the dimension, dim, of the array ab must be at least max(1,pdab×n).
On entry: the n×n triangular band matrix A.
This is stored as a notional two-dimensional array with row elements or column elements stored contiguously. The storage of elements of Aij, depends on the order and uplo arguments as follows:
if order=Nag_ColMajor and uplo=Nag_Upper,
Aij is stored in ab[kd+i-j+(j-1)×pdab], for j=1,,n and i=max(1,j-kd),,j;
if order=Nag_ColMajor and uplo=Nag_Lower,
Aij is stored in ab[i-j+(j-1)×pdab], for j=1,,n and i=j,,min(n,j+kd);
if order=Nag_RowMajor and uplo=Nag_Upper,
Aij is stored in ab[j-i+(i-1)×pdab], for i=1,,n and j=i,,min(n,i+kd);
if order=Nag_RowMajor and uplo=Nag_Lower,
Aij is stored in ab[kd+j-i+(i-1)×pdab], for i=1,,n and j=max(1,i-kd),,i.
If diag=Nag_UnitDiag, the diagonal elements of AB are assumed to be 1, and are not referenced.
8: pdab Integer Input
On entry: the stride separating row or column elements (depending on the value of order) of the matrix A in the array ab.
Constraint: pdabkd+1.
9: 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.
10: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, kd=value.
Constraint: kd0.
On entry, n=value.
Constraint: n0.
On entry, pdab=value.
Constraint: pdab>0.
NE_INT_2
On entry, pdab=value and kd=value.
Constraint: pdabkd+1.
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 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

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

f07vuc 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 f07vuc involves solving a number of systems of linear equations of the form Ax=b or AHx=b; the number is usually 5 and never more than 11. Each solution involves approximately 8nk real floating-point operations (assuming nk) but takes considerably longer than a call to f07vsc 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 f07vgc.

10 Example

This example estimates the condition number in the 1-norm of the matrix A, where
A= ( -1.94+4.43i 0.00+0.00i 0.00+0.00i 0.00+0.00i -3.39+3.44i 4.12-4.27i 0.00+0.00i 0.00+0.00i 1.62+3.68i -1.84+5.53i 0.43-2.66i 0.00+0.00i 0.00+0.00i -2.77-1.93i 1.74-0.04i 0.44+0.10i ) .  
Here A is treated as a lower triangular band matrix with two subdiagonals. The true condition number in the 1-norm is 71.51.

10.1 Program Text

Program Text (f07vuce.c)

10.2 Program Data

Program Data (f07vuce.d)

10.3 Program Results

Program Results (f07vuce.r)