NAG C Library Function Document

nag_zgbequ (f07btc)

1
Purpose

nag_zgbequ (f07btc) computes diagonal scaling matrices DR  and DC  intended to equilibrate a complex m  by n  band matrix A  of band width kl + ku + 1 , and reduce its condition number.

2
Specification

#include <nag.h>
#include <nagf07.h>
void  nag_zgbequ (Nag_OrderType order, Integer m, Integer n, Integer kl, Integer ku, const Complex ab[], Integer pdab, double r[], double c[], double *rowcnd, double *colcnd, double *amax, NagError *fail)

3
Description

nag_zgbequ (f07btc) 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 DR  and DC  are restricted to lie in the safe range δ,1/δ , where δ  is the value returned by function nag_real_safe_small_number (X02AMC). Use of these scaling factors is not guaranteed to reduce the condition number of A  but works well in practice.

4
References

None.

5
Arguments

1:     order Nag_OrderTypeInput
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.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     m IntegerInput
On entry: m, the number of rows of the matrix A.
Constraint: m0.
3:     n IntegerInput
On entry: n, the number of columns of the matrix A.
Constraint: n0.
4:     kl IntegerInput
On entry: kl, the number of subdiagonals of the matrix A.
Constraint: kl0.
5:     ku IntegerInput
On entry: ku, the number of superdiagonals of the matrix A.
Constraint: ku0.
6:     ab[dim] const ComplexInput
Note: the dimension, dim, of the array ab must be at least
  • max1,pdab×n when order=Nag_ColMajor;
  • max1,m×pdab when order=Nag_RowMajor.
On entry: the m by n band matrix A whose scaling factors are to be computed.
This is stored as a notional two-dimensional array with row elements or column elements stored contiguously. The storage of elements Aij, for row i=1,,m and column j=max1,i-kl,,minn,i+ku, depends on the order argument as follows:
  • if order=Nag_ColMajor, Aij is stored as ab[j-1×pdab+ku+i-j];
  • if order=Nag_RowMajor, Aij is stored as ab[i-1×pdab+kl+j-i].
See Section 9 in nag_zgbsv (f07bnc) for further details.
7:     pdab IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) of the matrix A in the array ab.
Constraint: pdabkl+ku+1.
8:     r[m] doubleOutput
On exit: if fail.code= NE_NOERROR or fail.code= NE_MAT_COL_ZERO, r contains the row scale factors, the diagonal elements of DR. The elements of r will be positive.
9:     c[n] doubleOutput
On exit: if fail.code= NE_NOERROR, c contains the column scale factors, the diagonal elements of DC. The elements of c will be positive.
10:   rowcnd double *Output
On exit: if fail.code= NE_NOERROR or fail.code= NE_MAT_COL_ZERO, rowcnd contains the ratio of the smallest value of r[i-1] to the largest value of r[i-1]. If rowcnd0.1 and amax is neither too large nor too small, it is not worth scaling by DR.
11:   colcnd double *Output
On exit: if fail.code= NE_NOERROR, colcnd contains the ratio of the smallest value of c[i-1] to the largest value of c[i-1].
If colcnd0.1, it is not worth scaling by DC.
12:   amax double *Output
On exit: maxaij. If amax is very close to overflow or underflow, the matrix A should be scaled.
13:   fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6
Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, kl=value.
Constraint: kl0.
On entry, ku=value.
Constraint: ku0.
On entry, m=value.
Constraint: m0.
On entry, n=value.
Constraint: n0.
On entry, pdab=value.
Constraint: pdab>0.
NE_INT_3
On entry, pdab=value, kl=value and ku=value.
Constraint: pdabkl+ku+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 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_MAT_COL_ZERO
Column value of A is exactly zero.
NE_MAT_ROW_ZERO
Row value of A is exactly zero.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

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

8
Parallelism and Performance

nag_zgbequ (f07btc) 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

The real analogue of this function is nag_dgbequ (f07bfc).

10
Example

This example equilibrates the complex band matrix A  given by
A = -1.65+2.26i -2.05-0.85i×10-10 -(0.97-2.84i ((0 -0.00+6.30i -1.48-1.75i×10-10 (-3.99+4.01i ((0.59-0.48i -0 (-0.77+2.83i -1.06+1.94i×1010 (3.33-1.04i×1010 -0 -(0 -(0.48-1.09i -0.46-1.72i .  
Details of the scaling factors, and the scaled matrix are output.

10.1
Program Text

Program Text (f07btce.c)

10.2
Program Data

Program Data (f07btce.d)

10.3
Program Results

Program Results (f07btce.r)