void	x04def_ (const Integer m, const Integer n, const Integer kl, const Integer ku, const Complex a[], const Integer lda, const char title, Integer *ifail, const Charlen length_title)

The routine may be called by the names x04def or nagf_file_print_matrix_complex_band.

3 Description

x04def prints a complex band matrix stored in a packed two-dimensional array. It is an easy-to-use driver for x04dff. The routine uses default values for the format in which numbers are printed, for labelling the rows and columns, and for output record length.

x04def will choose a format code such that numbers will be printed with an

F 8.4

, an

F 11.4

or a

1 PE 13.4

format. The

F 8.4

code is chosen if the sizes of all the matrix elements to be printed lie between

0.001

and

1.0

. The

F 11.4

code is chosen if the sizes of all the matrix elements to be printed lie between

0.001

and

9999.9999

. Otherwise the

1 PE 13.4

code is chosen. The chosen code is used to print each complex element of the matrix with the real part above the imaginary part.

The matrix is printed with integer row and column labels, and with a maximum record length of

80

The matrix is output to the unit defined by x04abf.

4 References

None.

5 Arguments

1: $m$ – Integer Input

2: $n$ – Integer Input

On entry: the number of rows and columns of the band matrix, respectively, to be printed.

If either m or n is less than

1

, x04def will exit immediately after printing title; no row or column labels are printed.

3: $kl$ – Integer Input

On entry: the number of subdiagonals of the band matrix

A

Constraint:

kl \geq 0

4: $ku$ – Integer Input

On entry: the number of superdiagonals of the band matrix

A

Constraint:

ku \geq 0

5: $a (lda, *)$ – Complex (Kind=nag_wp) array Input

Note: the second dimension of the array a must be at least

\max (1, \min (m + ku, n))

On entry: the band matrix to be printed.

The matrix is stored in rows

1

k_{l} + k_{u} + 1

, more precisely, the element

A_{i j}

must be stored in

a (k_{u} + 1 + i - j, j) for ​ \max (1, j - k_{u}) \leq i \leq \min (m, j + k_{l}) .

6: $lda$ – Integer Input

On entry: the first dimension of the array a as declared in the (sub)program from which x04def is called.

Constraint:

lda \geq kl + ku + 1

7: $title$ – Character(*) Input

On entry: a title to be printed above the matrix.

title =' '

, no title (and no blank line) will be printed.

If title contains more than

80

characters, the contents of title will be wrapped onto more than one line, with the break after

80

characters.

Any trailing blank characters in title are ignored.

8: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $kl = ⟨ value ⟩$ .
Constraint: $kl \geq 0$ .

$ifail = 2$: On entry, $ku = ⟨ value ⟩$ .
Constraint: $ku \geq 0$ .

$ifail = 3$: On entry, $lda < kl + ku + 1$ : $lda = ⟨ value ⟩$ , $kl = ⟨ value ⟩$ , $ku = ⟨ value ⟩$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.