nag_file_print_matrix_complex_gen (x04da) prints a complex matrix. It is an easy-to-use driver for nag_file_print_matrix_complex_gen_comp (x04db). 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_file_print_matrix_complex_gen (x04da) 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 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

80

The matrix is output to the unit defined by nag_file_set_unit_advisory (x04ab).

References

None.

Parameters

Compulsory Input Parameters

1: $matrix$ – string (length ≥ 1)

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'

'U'

2: $diag$ – string (length ≥ 1)

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.

matrix ='G'

, then diag need not be set.

Constraint: if

matrix \neq'G'

diag ='B'

'U'

'N'

3: $a (lda :)$ – complex array

The first dimension of the array a must be at least

\max (1, m)

The second dimension of the array a must be at least

\max (1, n)

The matrix to be printed. Only the elements that will be referred to, as specified by arguments matrix and diag, need be set.

4: $title$ – string

A title to be printed above the matrix.

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.

Optional Input Parameters

1: $m$ – int64int32nag_int scalar
2: $n$ – int64int32nag_int scalar: Default: the first dimension of the array a and the second dimension of the array a.
The number of rows and columns of the matrix, respectively, to be printed.
If either m or n is less than $1$ , nag_file_print_matrix_complex_gen (x04da) will exit immediately after printing title; no row or column labels are printed.

Output Parameters

1: $ifail$ – int64int32nag_int scalar: $ifail = 0$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Errors or warnings detected by the function:

$ifail = 1$

On entry,

matrix \neq'G'

'L'

'U'

$ifail = 2$

On entry,

matrix ='L'

'U'

, but

diag \neq'N'

'U'

'B'

$ifail = 3$

On entry,

lda < m

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.

$ifail = - 999$: Dynamic memory allocation failed.

Accuracy

Not applicable.

Further Comments

A call to nag_file_print_matrix_complex_gen (x04da) is equivalent to a call to nag_file_print_matrix_complex_gen_comp (x04db) with the following argument values:


ncols = 80
indent = 0
labrow = 'I'
labcol = 'I'
form = ' '
usefrm = 'A'

Example

This example program calls nag_file_print_matrix_complex_gen (x04da) twice, first to print a

4

3

rectangular matrix, and then to print a

4

4

lower triangular matrix.

Open in the MATLAB editor: x04da_example

function x04da_example


fprintf('x04da example results\n\n');

nmax = 4;
b = zeros(nmax,nmax);
for j = 1:nmax
  b(j,:) = [1:nmax] + 10*j;
end

a = b - i*b;

% First matrix: 4x3 general matrix
mtitle = 'Example 1:';
matrix = 'General';
diag   = ' ';

[ifail] = x04da( ...
                 matrix, diag, a(:,1:3), mtitle);

fprintf('\n');
% Second matrix : 5x5 non-unit lower triangular 
mtitle = 'Example 2:';
matrix = 'Lower';
diag   = 'Non-unit';

[ifail] = x04da( ...
                 matrix, diag, a, mtitle);

x04da example results

 Example 1:
             1          2          3
 1     11.0000    12.0000    13.0000
      -11.0000   -12.0000   -13.0000

 2     21.0000    22.0000    23.0000
      -21.0000   -22.0000   -23.0000

 3     31.0000    32.0000    33.0000
      -31.0000   -32.0000   -33.0000

 4     41.0000    42.0000    43.0000
      -41.0000   -42.0000   -43.0000

 Example 2:
             1          2          3          4
 1     11.0000
      -11.0000

 2     21.0000    22.0000
      -21.0000   -22.0000

 3     31.0000    32.0000    33.0000
      -31.0000   -32.0000   -33.0000

 4     41.0000    42.0000    43.0000    44.0000
      -41.0000   -42.0000   -43.0000   -44.0000

PDF version (NAG web site, 64-bit version, 64-bit version)

Chapter Contents

Chapter Introduction

NAG Toolbox