# NAG CL Interfacef07ftc (zpoequ)

Settings help

CL Name Style:

## 1Purpose

f07ftc computes a diagonal scaling matrix $S$ intended to equilibrate a complex $n×n$ Hermitian positive definite matrix $A$ and reduce its condition number.

## 2Specification

 #include
 void f07ftc (Nag_OrderType order, Integer n, const Complex a[], Integer pda, double s[], double *scond, double *amax, NagError *fail)
The function may be called by the names: f07ftc, nag_lapacklin_zpoequ or nag_zpoequ.

## 3Description

f07ftc computes a diagonal scaling matrix $S$ chosen so that
 $sj=1 / ajj .$
This means that the matrix $B$ given by
 $B=SAS ,$
has diagonal elements equal to unity. This in turn means that the condition number of $B$, ${\kappa }_{2}\left(B\right)$, is within a factor $n$ of the matrix of smallest possible condition number over all possible choices of diagonal scalings (see Corollary 7.6 of Higham (2002)).

## 4References

Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

## 5Arguments

1: $\mathbf{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 ${\mathbf{order}}=\mathrm{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: ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ or $\mathrm{Nag_ColMajor}$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
3: $\mathbf{a}\left[\mathit{dim}\right]$const Complex Input
Note: the dimension, dim, of the array a must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{pda}}×{\mathbf{n}}\right)$.
The $\left(i,j\right)$th element of the matrix $A$ is stored in
• ${\mathbf{a}}\left[\left(j-1\right)×{\mathbf{pda}}+i-1\right]$ when ${\mathbf{order}}=\mathrm{Nag_ColMajor}$;
• ${\mathbf{a}}\left[\left(i-1\right)×{\mathbf{pda}}+j-1\right]$ when ${\mathbf{order}}=\mathrm{Nag_RowMajor}$.
On entry: the matrix $A$ whose scaling factors are to be computed. Only the diagonal elements of the array a are referenced.
4: $\mathbf{pda}$Integer Input
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraint: ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
5: $\mathbf{s}\left[{\mathbf{n}}\right]$double Output
On exit: if ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_NOERROR, s contains the diagonal elements of the scaling matrix $S$.
6: $\mathbf{scond}$double * Output
On exit: if ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_NOERROR, scond contains the ratio of the smallest value of s to the largest value of s. If ${\mathbf{scond}}\ge 0.1$ and amax is neither too large nor too small, it is not worth scaling by $S$.
7: $\mathbf{amax}$double * Output
On exit: $\mathrm{max}|{a}_{ij}|$. If amax is very close to overflow or underflow, the matrix $A$ should be scaled.
8: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

## 6Error 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.
On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.
NE_INT
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 0$.
On entry, ${\mathbf{pda}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pda}}>0$.
NE_INT_2
On entry, ${\mathbf{pda}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
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_MAT_NOT_POS_DEF
The $⟨\mathit{\text{value}}⟩$th diagonal element of $A$ is not positive (and hence $A$ cannot be positive definite).
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.

## 7Accuracy

The computed scale factors will be close to the exact scale factors.

## 8Parallelism and Performance

f07ftc is not threaded in any implementation.

The real analogue of this function is f07ffc.

## 10Example

This example equilibrates the Hermitian positive definite matrix $A$ given by
 $A = ( (3.23 -(1.51-1.92i (1.90+0.84i)×1050 -0.42+2.50i (1.51+1.92i -(3.58 (-0.23+1.11i)×1050 -1.18+1.37i (1.90-0.84i)×105 (-0.23-1.11i)×105 -4.09×1010 ((2.33-0.14i)×105 (0.42-2.50i (-1.18-1.37i (2.33+0.14i)×1050 -4.29 ) .$
Details of the scaling factors and the scaled matrix are output.

### 10.1Program Text

Program Text (f07ftce.c)

### 10.2Program Data

Program Data (f07ftce.d)

### 10.3Program Results

Program Results (f07ftce.r)