# NAG FL Interfacef07bff (dgbequ)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

f07bff computes diagonal scaling matrices ${D}_{R}$ and ${D}_{C}$ intended to equilibrate a real $m×n$ band matrix $A$ of band width $\left({k}_{l}+{k}_{u}+1\right)$, and reduce its condition number.

## 2Specification

Fortran Interface
 Subroutine f07bff ( m, n, kl, ku, ab, ldab, r, c, amax, info)
 Integer, Intent (In) :: m, n, kl, ku, ldab Integer, Intent (Out) :: info Real (Kind=nag_wp), Intent (In) :: ab(ldab,*) Real (Kind=nag_wp), Intent (Out) :: r(m), c(n), rowcnd, colcnd, amax
#include <nag.h>
 void f07bff_ (const Integer *m, const Integer *n, const Integer *kl, const Integer *ku, const double ab[], const Integer *ldab, double r[], double c[], double *rowcnd, double *colcnd, double *amax, Integer *info)
The routine may be called by the names f07bff, nagf_lapacklin_dgbequ or its LAPACK name dgbequ.

## 3Description

f07bff computes the diagonal scaling matrices. The diagonal scaling matrices are chosen to try to make the elements of largest absolute value in each row and column of the matrix $B$ given by
 $B = DR A DC$
have absolute value $1$. The diagonal elements of ${D}_{R}$ and ${D}_{C}$ are restricted to lie in the safe range $\left(\delta ,1/\delta \right)$, where $\delta$ is the value returned by routine x02amf. Use of these scaling factors is not guaranteed to reduce the condition number of $A$ but works well in practice.

None.

## 5Arguments

1: $\mathbf{m}$Integer Input
On entry: $m$, the number of rows of the matrix $A$.
Constraint: ${\mathbf{m}}\ge 0$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the number of columns of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
3: $\mathbf{kl}$Integer Input
On entry: ${k}_{l}$, the number of subdiagonals of the matrix $A$.
Constraint: ${\mathbf{kl}}\ge 0$.
4: $\mathbf{ku}$Integer Input
On entry: ${k}_{u}$, the number of superdiagonals of the matrix $A$.
Constraint: ${\mathbf{ku}}\ge 0$.
5: $\mathbf{ab}\left({\mathbf{ldab}},*\right)$Real (Kind=nag_wp) array Input
Note: the second dimension of the array ab must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry: the $m×n$ band matrix $A$ whose scaling factors are to be computed.
The matrix is stored in rows $1$ to ${k}_{l}+{k}_{u}+1$, more precisely, the element ${A}_{ij}$ must be stored in
 $ab(ku+1+i-j,j) for ​max(1,j-ku)≤i≤min(m,j+kl).$
See Section 9 in f07baf for further details.
6: $\mathbf{ldab}$Integer Input
On entry: the first dimension of the array ab as declared in the (sub)program from which f07bff is called.
Constraint: ${\mathbf{ldab}}\ge {\mathbf{kl}}+{\mathbf{ku}}+1$.
7: $\mathbf{r}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Output
On exit: if ${\mathbf{info}}={\mathbf{0}}$ or ${\mathbf{info}}>\mathbf{m}$, r contains the row scale factors, the diagonal elements of ${D}_{R}$. The elements of r will be positive.
8: $\mathbf{c}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: if ${\mathbf{info}}={\mathbf{0}}$, c contains the column scale factors, the diagonal elements of ${D}_{C}$. The elements of c will be positive.
9: $\mathbf{rowcnd}$Real (Kind=nag_wp) Output
On exit: if ${\mathbf{info}}={\mathbf{0}}$ or ${\mathbf{info}}>\mathbf{m}$, rowcnd contains the ratio of the smallest value of ${\mathbf{r}}\left(i\right)$ to the largest value of ${\mathbf{r}}\left(i\right)$. If ${\mathbf{rowcnd}}\ge 0.1$ and amax is neither too large nor too small, it is not worth scaling by ${D}_{R}$.
10: $\mathbf{colcnd}$Real (Kind=nag_wp) Output
On exit: if ${\mathbf{info}}={\mathbf{0}}$, colcnd contains the ratio of the smallest value of ${\mathbf{c}}\left(i\right)$ to the largest value of ${\mathbf{c}}\left(i\right)$.
If ${\mathbf{colcnd}}\ge 0.1$, it is not worth scaling by ${D}_{C}$.
11: $\mathbf{amax}$Real (Kind=nag_wp) Output
On exit: $\mathrm{max}|{a}_{ij}|$. If amax is very close to overflow or underflow, the matrix $A$ should be scaled.
12: $\mathbf{info}$Integer Output
On exit: ${\mathbf{info}}=0$ unless the routine detects an error (see Section 6).

## 6Error 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.
${\mathbf{info}}>0 \text{and} {\mathbf{info}}\le {\mathbf{m}}$
Row $⟨\mathit{\text{value}}⟩$ of $A$ is exactly zero.
${\mathbf{info}}>{\mathbf{m}}$
Column $⟨\mathit{\text{value}}⟩$ of $A$ is exactly zero.

## 7Accuracy

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

## 8Parallelism and Performance

f07bff is not threaded in any implementation.

The complex analogue of this routine is f07btf.

## 10Example

This example equilibrates the band matrix $A$ given by
 $A = ( -0.23 2.54 -3.66×10−10 -0 -6.98×1010 2.46×1010 -2.73 -2.13×1010 -0 2.56 -2.46×10−10 -4.07 -0 0 -4.78×10−10 -3.82 ) .$
Details of the scaling factors, and the scaled matrix are output.

### 10.1Program Text

Program Text (f07bffe.f90)

### 10.2Program Data

Program Data (f07bffe.d)

### 10.3Program Results

Program Results (f07bffe.r)