NAG Library Routine Document

x04def  (print_matrix_complex_band)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{m}$ – IntegerInput

2:     $\mathbf{n}$ – IntegerInput

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:     $\mathbf{kl}$ – IntegerInput

On entry: the number of subdiagonals of the band matrix $A$.

Constraint: $\mathbf{kl}\ge 0$.

4:     $\mathbf{ku}$ – IntegerInput

On entry: the number of superdiagonals of the band matrix $A$.

Constraint: $\mathbf{ku}\ge 0$.

5:     $\mathbf{a}\left(\mathbf{lda},*\right)$ – Complex (Kind=nag_wp) arrayInput

Note: the second dimension of the array a must be at least $\max \left(1,\min \left(\mathbf{m}+\mathbf{ku},\mathbf{n}\right)\right)$.

On entry: the band matrix to be printed.

The matrix is stored in rows $1$ to $k_l+k_u+1$, more precisely, the element $A_{ij}$ must be stored in

$$\mathbf{a}\left(k_u+1+i-j,j\right)\text{\hspace{1em} for }\max \left(1,j-k_u\right)\le i\le \min \left(m,j+k_l\right)\text{.}$$

6:     $\mathbf{lda}$ – IntegerInput

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

Constraint: $\mathbf{lda}\ge \mathbf{kl}+\mathbf{ku}+1$.

7:     $\mathbf{title}$ – Character(*)Input

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

If $\mathbf{title}=\text{' '}$, 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:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of ifail on exit.

On exit: $\mathbf{ifail}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

On entry,

$\mathbf{kl}<0$.

$\mathbf{ifail}=2$

On entry,

$\mathbf{ku}<0$.

$\mathbf{ifail}=3$

On entry,

$\mathbf{lda}<\mathbf{kl}+\mathbf{ku}+1$.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

NCOLS = 80
INDENT = 0
LABROW = 'I'
LABCOL = 'I'
FORM = ' '
USEFRM = 'A' 

10

Example

10.1

Program Text

Program Text (x04defe.f90)

10.2

Program Data

10.3

Program Results

Program Results (x04defe.r)