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

Syntax

C#
public static void x04ca(
	string matrix,
	string diag,
	int m,
	int n,
	double[,] a,
	string title,
	out int ifail
)
Visual Basic
Public Shared Sub x04ca ( _
	matrix As String, _
	diag As String, _
	m As Integer, _
	n As Integer, _
	a As Double(,), _
	title As String, _
	<OutAttribute> ByRef ifail As Integer _
)
Visual C++
public:
static void x04ca(
	String^ matrix, 
	String^ diag, 
	int m, 
	int n, 
	array<double,2>^ a, 
	String^ title, 
	[OutAttribute] int% ifail
)
F#
static member x04ca : 
        matrix : string * 
        diag : string * 
        m : int * 
        n : int * 
        a : float[,] * 
        title : string * 
        ifail : int byref -> unit 

Parameters

matrix
Type: System..::..String
On entry: indicates the part of the matrix to be printed.
matrix="G"
The whole of the rectangular matrix.
matrix="L"
The lower triangle of the matrix, or the lower trapezium if the matrix has more rows than columns.
matrix="U"
The upper triangle of the matrix, or the upper trapezium if the matrix has more columns than rows.
Constraint: matrix="G", "L" or "U".
diag
Type: System..::..String
On entry: unless matrix="G", diag must specify whether the diagonal elements of the matrix are to be printed.
diag="B"
The diagonal elements of the matrix are not referenced and not printed.
diag="U"
The diagonal elements of the matrix are not referenced, but are assumed all to be unity, and are printed as such.
diag="N"
The diagonal elements of the matrix are referenced and printed.
If matrix="G", then diag need not be set.
Constraint: if matrix"G", diag="B", "U" or "N".
m
Type: System..::..Int32
On entry: the number of rows and columns of the matrix, respectively, to be printed.
If either m or n is less than 1, x04ca 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 matrix, respectively, to be printed.
If either m or n is less than 1, x04ca will exit immediately after printing title; no row or column labels are printed.
a
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, dim2]
Note: dim1 must satisfy the constraint: dim1max1,m
Note: the second dimension of the array a must be at least max1,n.
On entry: the matrix to be printed. Only the elements that will be referred to, as specified by parameters matrix and diag, need be set.
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

x04ca prints a real matrix. It is an easy-to-use driver for x04cb. The method uses default values for the format in which numbers are printed, for labelling the rows and columns, and for output record length.
x04ca 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.
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,matrix"G", "L" or "U".
ifail=2
On entry,matrix="L" or "U", but diag"N", "U" or "B".
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 x04ca is equivalent to a call to x04cb with the following argument values:

Example

This example program calls x04ca twice, first to print a 3 by 5 rectangular matrix, and then to print a 5 by 5 lower triangular matrix.

Example program (C#): x04cae.cs

Example program results: x04cae.r

See Also