x04ce is an easy-to-use method to print a real band matrix stored in a packed two-dimensional array.

Syntax

C#
public static void x04ce( int m, int n, int kl, int ku, double[,] a, string title, out int ifail )

Visual Basic
Public Shared Sub x04ce ( _ m As Integer, _ n As Integer, _ kl As Integer, _ ku As Integer, _ a As Double(,), _ title As String, _ <OutAttribute> ByRef ifail As Integer _ )

Visual C++
public: static void x04ce( int m, int n, int kl, int ku, array<double,2>^ a, String^ title, [OutAttribute] int% ifail )

F#
static member x04ce : m : int * n : int * kl : int * ku : int * a : float[,] * title : string * ifail : int byref -> unit

Parameters

m: Type: System..::..Int32
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$ , x04ce will exit immediately after printing title; no row or column labels are printed.

n: Type: System..::..Int32
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$ , x04ce will exit immediately after printing title; no row or column labels are printed.

kl: Type: System..::..Int32
On entry: the number of subdiagonals of the band matrix $A$ .

Constraint: $kl \geq 0$ .

ku: Type: System..::..Int32
On entry: the number of superdiagonals of the band matrix $A$ .

Constraint: $ku \geq 0$ .

a

Type: array<System..::..Double,2>[,](,)[,][,]

An array of size [dim1, dim2]

Note: dim1 must satisfy the constraint:

dim1 \geq kl + ku + 1

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}) .

title: Type: System..::..String
On entry: a title to be printed above the matrix.
If $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.

ifail: Type: System..::..Int32%
On exit: $ifail = 0$ unless the method detects an error or a warning has been flagged (see [Error Indicators and Warnings]).

Description

x04ce prints a real band matrix stored in a packed two-dimensional array. It is an easy-to-use driver for (X04CFF not in this release). The method uses default values for the format in which numbers are printed, for labelling the rows and columns, and for output record length.

x04ce 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 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 not in this release).

References

None.

Error Indicators and Warnings

Errors or warnings detected by the method:

Some error messages may refer to parameters that are dropped from this interface (LDA) In these cases, an error in another parameter has usually caused an incorrect value to be inferred.

$ifail = 1$

On entry,

kl < 0

$ifail = 2$

On entry,

ku < 0

$ifail = -9000$: An error occured, see message report.
$ifail = -6000$: Invalid Parameters $〈value〉$
$ifail = -4000$: Invalid dimension for array $〈value〉$
$ifail = -8000$: Negative dimension for array $〈value〉$
$ifail = -6000$: Invalid Parameters $〈value〉$

Accuracy

Not applicable.

Parallelism and Performance

None.

Further Comments

A call to x04ce is equivalent to a call to (X04CFF not in this release) with the following argument values:

Example

The example program calls x04ce to print a

5

5

band matrix with one subdiagonal and one superdiagonal.

Example program (C#): x04cee.cs

Example program results: x04cee.r