NAG Library Function Document
nag_gen_complx_mat_print (x04dac) is an easy-to-use function to print a Complex matrix.
||nag_gen_complx_mat_print (Nag_OrderType order,
const Complex a,
const char *title,
const char *outfile,
nag_gen_complx_mat_print (x04dac) prints a Complex matrix. It is an easy-to-use driver for nag_gen_complx_mat_print_comp (x04dbc)
. The function uses default values for the format in which numbers are printed, for labelling the rows and columns, and for output record length.
nag_gen_complx_mat_print (x04dac) will choose a format code such that numbers will be printed with
a , a or a format.
code is chosen if the sizes of all the matrix elements to be printed lie between and . The
code is chosen if the sizes of all the matrix elements to be printed lie between and . Otherwise the
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 .
The matrix is output to the file specified by outfile
by default, to standard output.
order – Nag_OrderTypeInput
: the order
argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by
. See Section 188.8.131.52
in the Essential Introduction for a more detailed explanation of the use of this argument.
matrix – Nag_MatrixTypeInput
: indicates the part of the matrix to be printed.
- The whole of the rectangular matrix.
- The lower triangle of the matrix, or the lower trapezium if the matrix has more rows than columns.
- The upper triangle of the matrix, or the upper trapezium if the matrix has more columns than rows.
, or .
diag – Nag_DiagTypeInput
: indicates whether the diagonal elements of the matrix are to be printed.
- The diagonal elements of the matrix are not referenced and not printed.
- The diagonal elements of the matrix are not referenced, but are assumed all to be unity, and are printed as such.
- The diagonal elements of the matrix are referenced and printed.
, then diag
must be set to
- if , , or ;
- if , .
m – IntegerInput
n – IntegerInput
: the number of rows and columns of the matrix, respectively, to be printed.
If either m
is less than
, nag_gen_complx_mat_print (x04dac) will exit immediately after printing title
; no row or column labels are printed.
a – const ComplexInput
the dimension, dim
, of the array a
must be at least
th element of the matrix
is stored in
- when ;
- when .
: the matrix to be printed. Only the elements that will be referred to, as specified by arguments matrix
, need be set.
pda – IntegerInput
: the stride separating row or column elements (depending on the value of order
) in the array a
- if ,
- if , .
title – const char *Input
: a title to be printed above the matrix.
If , no title (and no blank line) will be printed.
contains more than
characters, the contents of title
will be wrapped onto more than one line, with the break after
Any trailing blank characters in title
outfile – const char *Input
: the name of a file to which output will be directed. If outfile
the output will be directed to standard output.
fail – NagError *Input/Output
The NAG error argument (see Section 3.6
in the Essential Introduction).
6 Error Indicators and Warnings
Memory allocation failed.
On entry, argument had an illegal value.
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG
Cannot open file for appending.
Cannot close file .
Cannot open file for writing.
8 Parallelism and Performance
A call to nag_gen_complx_mat_print (x04dac) is equivalent to a call to nag_gen_complx_mat_print_comp (x04dbc)
with the following argument values:
ncols = 80
indent = 0
labrow = Nag_IntegerLabels
labcol = Nag_IntegerLabels
form = 0
cmplxform = Nag_AboveForm