x04cb prints a real matrix stored in a two-dimensional array.

# Syntax

C# |
---|

public static void x04cb( string matrix, string diag, int m, int n, double[,] a, string form, string title, string labrow, string[] rlabs, string labcol, string[] clabs, int ncols, int indent, out int ifail ) |

Visual Basic |
---|

Public Shared Sub x04cb ( _ matrix As String, _ diag As String, _ m As Integer, _ n As Integer, _ a As Double(,), _ form As String, _ title As String, _ labrow As String, _ rlabs As String(), _ labcol As String, _ clabs As String(), _ ncols As Integer, _ indent As Integer, _ <OutAttribute> ByRef ifail As Integer _ ) |

Visual C++ |
---|

public: static void x04cb( String^ matrix, String^ diag, int m, int n, array<double,2>^ a, String^ form, String^ title, String^ labrow, array<String^>^ rlabs, String^ labcol, array<String^>^ clabs, int ncols, int indent, [OutAttribute] int% ifail ) |

F# |
---|

static member x04cb : matrix : string * diag : string * m : int * n : int * a : float[,] * form : string * title : string * labrow : string * rlabs : string[] * labcol : string * clabs : string[] * ncols : int * indent : int * ifail : int byref -> unit |

#### Parameters

- matrix
- Type: System..::..String
*On entry*: indicates the part of the matrix to be printed.- ${\mathbf{matrix}}=\text{"G"}$
- The whole of the rectangular matrix.
- ${\mathbf{matrix}}=\text{"L"}$
- The lower triangle of the matrix, or the lower trapezium if the matrix has more rows than columns.
- ${\mathbf{matrix}}=\text{"U"}$
- The upper triangle of the matrix, or the upper trapezium if the matrix has more columns than rows.

*Constraint*: ${\mathbf{matrix}}=\text{"G"}$, $\text{"L"}$ or $\text{"U"}$.

- diag
- Type: System..::..String
*On entry*: unless ${\mathbf{matrix}}=\text{"G"}$, diag must specify whether the diagonal elements of the matrix are to be printed.- ${\mathbf{diag}}=\text{"B"}$
- The diagonal elements of the matrix are not referenced and not printed.
- ${\mathbf{diag}}=\text{"U"}$
- The diagonal elements of the matrix are not referenced, but are assumed all to be unity, and are printed as such.
- ${\mathbf{diag}}=\text{"N"}$
- The diagonal elements of the matrix are referenced and printed.

If ${\mathbf{matrix}}=\text{"G"}$, then diag need not be set.*Constraint*: if ${\mathbf{matrix}}\ne \text{"G"}$, ${\mathbf{diag}}=\text{"B"}$, $\text{"U"}$ or $\text{"N"}$.

- m
- Type: System..::..Int32

- n
- Type: System..::..Int32

- a
- Type: array<System..::..Double,2>[,](,)[,][,]An array of size [dim1, dim2]
**Note:**dim1 must satisfy the constraint: $\mathrm{dim1}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$**Note:**the second dimension of the array a must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.

- form
- Type: System..::..String
*On entry*: describes the Fortran format code for printing the elements of the matrix a. The format code may be any allowed on the system, whether it is standard Fortran or not. It may or may not be enclosed in brackets.In addition, there are the following special codes which force x04cb to choose its own format code:- ${\mathbf{form}}=\text{''}$
- x04cb will choose a format code such that numbers will be printed with an F8.4, an F11.4 or a 1PE13.4 format. The F8.4 code is chosen if the sizes of all the matrix elements to be printed lie between $0.001$ and $1.0$. The F11.4 code is chosen if the sizes of all the matrix elements to be printed lie between $0.001$ and $9999.9999$. Otherwise the 1PE13.4 code is chosen.
- ${\mathbf{form}}=\text{'*'}$
- x04cb will choose a format code such that numbers will be printed to as many significant digits as are necessary to distinguish between neighbouring machine numbers. Thus any two numbers that are stored with different internal representations should look different on output. Whether they do in fact look different will depend on the run-time library of the Fortran compiler in use.

By preceding the desired format code by the string ‘MATLAB’, x04cb will print the matrix such that it can be input into MATLAB, and title will be used as the name of the matrix.Examples of valid values for form are $\text{'F11.4'}$, $\text{'1PE13.5'}$, $\text{'G14.5'}$, $\text{'MATLABF11.4'}$, $\text{'MATLAB*'}$.

- title
- Type: System..::..String
*On entry*: a title to be printed above the matrix, or name of the matrix.If ${\mathbf{title}}=\text{''}$, no title (and no blank line) will be printed.If title contains more than ncols characters, the contents of title will be wrapped onto more than one line, with the break after ncols characters.Any trailing blank characters in title are ignored.If printing in MATLAB mode, title will be used as the name of the matrix.

- labrow
- Type: System..::..String
*On entry*: indicates the type of labelling to be applied to the rows of the matrix, except in MATLAB mode where labrow is ignored.- ${\mathbf{labrow}}=\text{"N"}$
- Prints no row labels.
- ${\mathbf{labrow}}=\text{"I"}$
- Prints integer row labels.
- ${\mathbf{labrow}}=\text{"C"}$
- Prints character labels, which must be supplied in array rlabs.

*Constraint*: ${\mathbf{labrow}}=\text{"N"}$, $\text{"I"}$ or $\text{"C"}$.

- rlabs
- Type: array<System..::..String>[]()[][]An array of size [dim1]
**Note:**the dimension of the array rlabs must be at least ${\mathbf{m}}$ if ${\mathbf{labrow}}=\text{"C"}$, and at least $1$ otherwise.*On entry*: if ${\mathbf{labrow}}=\text{"C"}$, rlabs must contain labels for the rows of the matrix, except in MATLAB mode where rlabs is ignored.Labels are right-justified when output, in a field which is as wide as necessary to hold the longest row label. Note that this field width is subtracted from the number of usable columns, ncols.

- labcol
- Type: System..::..String
*On entry*: indicates the type of labelling to be applied to the columns of the matrix, except in MATLAB mode where labcol is ignored.- ${\mathbf{labcol}}=\text{"N"}$
- Prints no column labels.
- ${\mathbf{labcol}}=\text{"I"}$
- Prints integer column labels.
- ${\mathbf{labcol}}=\text{"C"}$
- Prints character labels, which must be supplied in array clabs.

*Constraint*: ${\mathbf{labcol}}=\text{"N"}$, $\text{"I"}$ or $\text{"C"}$.

- clabs
- Type: array<System..::..String>[]()[][]An array of size [dim1]
**Note:**the dimension of the array clabs must be at least ${\mathbf{n}}$ if ${\mathbf{labcol}}=\text{"C"}$, and at least $1$ otherwise.

- ncols
- Type: System..::..Int32
*On entry*: the maximum output record length. If the number of columns of the matrix is too large to be accommodated in ncols characters, the matrix will be printed in parts, containing the largest possible number of matrix columns, and each part separated by a blank line.

- indent
- Type: System..::..Int32

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

# Description

x04cb prints a real matrix, or part of it, using a format specifier supplied by you.
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.

- ${\mathbf{ifail}}=1$
On entry, ${\mathbf{matrix}}\ne \text{"G"}$, $\text{"L"}$ or $\text{"U"}$.

- ${\mathbf{ifail}}=2$
On entry, ${\mathbf{matrix}}=\text{"L"}$ or $\text{"U"}$, but ${\mathbf{diag}}\ne \text{"N"}$, $\text{"U"}$ or $\text{"B"}$.

- ${\mathbf{ifail}}=4$
On entry, the format specifier in form is more than $80$ characters long.

- ${\mathbf{ifail}}=5$
- The format specifier in form cannot be used to output a number. The specifier probably has too wide a field width or contains an illegal edit descriptor.

- ${\mathbf{ifail}}=6$
On entry, either labrow or ${\mathbf{labcol}}\ne \text{"N"}$, $\text{"I"}$ or $\text{"C"}$.

- ${\mathbf{ifail}}=7$
- The quantity ${\mathbf{ncols}}-{\mathbf{indent}}-\mathit{labwid}$ (where $\mathit{labwid}$ is the width needed for the row labels), is not large enough to hold at least one column of the matrix.

- ${\mathbf{ifail}}=-9000$
- An error occured, see message report.
- ${\mathbf{ifail}}=-6000$
- Invalid Parameters $\u2329\mathit{\text{value}}\u232a$
- ${\mathbf{ifail}}=-4000$
- Invalid dimension for array $\u2329\mathit{\text{value}}\u232a$
- ${\mathbf{ifail}}=-8000$
- Negative dimension for array $\u2329\mathit{\text{value}}\u232a$
- ${\mathbf{ifail}}=-6000$
- Invalid Parameters $\u2329\mathit{\text{value}}\u232a$

# Accuracy

Not applicable.

# Parallelism and Performance

None.

# Further Comments

x04cb may be used to print a vector, either as a row or as a column. The following code fragment illustrates possible calls.

# Example

This example calls x04cb twice, to print matrices of different orders and bandwidths; various options for labelling and formatting are illustrated.