hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_file_print_matrix_complex_gen (x04da)

Purpose

nag_file_print_matrix_complex_gen (x04da) is an easy-to-use function to print a complex matrix stored in a two-dimensional array.

Syntax

[ifail] = x04da(matrix, diag, a, title, 'm', m, 'n', n)
[ifail] = nag_file_print_matrix_complex_gen(matrix, diag, a, title, 'm', m, 'n', n)

Description

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 F8.4F8.4, an F11.4F11.4 or a 1PE13.41PE13.4 format. The F8.4F8.4 code is chosen if the sizes of all the matrix elements to be printed lie between 0.0010.001 and 1.01.0. The F11.4F11.4 code is chosen if the sizes of all the matrix elements to be printed lie between 0.0010.001 and 9999.99999999.9999. Otherwise the 1PE13.41PE13.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 8080.
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'matrix='G'
The whole of the rectangular matrix.
matrix = 'L'matrix='L'
The lower triangle of the matrix, or the lower trapezium if the matrix has more rows than columns.
matrix = 'U'matrix='U'
The upper triangle of the matrix, or the upper trapezium if the matrix has more columns than rows.
Constraint: matrix = 'G'matrix='G', 'L''L' or 'U''U'.
2:     diag – string (length ≥ 1)
Unless matrix = 'G'matrix='G', diag must specify whether the diagonal elements of the matrix are to be printed.
diag = 'B'diag='B'
The diagonal elements of the matrix are not referenced and not printed.
diag = 'U'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'diag='N'
The diagonal elements of the matrix are referenced and printed.
If matrix = 'G'matrix='G', then diag need not be set.
Constraint: if matrix'G'matrix'G', diag = 'B'diag='B', 'U''U' or 'N''N'.
3:     a(lda, : :) – complex array
The first dimension of the array a must be at least max (1,m)max(1,m)
The second dimension of the array must be at least max (1,n)max(1,n)
The matrix to be printed. Only the elements that will be referred to, as specified by parameters matrix and diag, need be set.
4:     title – string
A title to be printed above the matrix.
If title = ' 'title=' ', no title (and no blank line) will be printed.
If title contains more than 8080 characters, the contents of title will be wrapped onto more than one line, with the break after 8080 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 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 11, nag_file_print_matrix_complex_gen (x04da) will exit immediately after printing title; no row or column labels are printed.

Input Parameters Omitted from the MATLAB Interface

lda

Output Parameters

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

Error Indicators and Warnings

Errors or warnings detected by the function:
  ifail = 1ifail=1
On entry,matrix'G'matrix'G', 'L''L' or 'U''U'.
  ifail = 2ifail=2
On entry,matrix = 'L'matrix='L' or 'U''U', but diag'N'diag'N', 'U''U' or 'B''B'.
  ifail = 3ifail=3
On entry,lda < mlda<m.

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

function nag_file_print_matrix_complex_gen_example
matrix = 'General';
diag = ' ';
a = [ 11 - 11i,  12 - 12i,  13 - 13i;
      21 - 21i,  22 - 22i,  23 - 23i;
      31 - 31i,  32 - 32i,  33 - 33i;
      41 - 41i,  42 - 42i,  43 - 43i];
title = 'Example 1:';
[ifail] = nag_file_print_matrix_complex_gen(matrix, diag, a, title)
 
 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

ifail =

                    0


function x04da_example
matrix = 'General';
diag = ' ';
a = [ 11 - 11i,  12 - 12i,  13 - 13i;
      21 - 21i,  22 - 22i,  23 - 23i;
      31 - 31i,  32 - 32i,  33 - 33i;
      41 - 41i,  42 - 42i,  43 - 43i];
title = 'Example 1:';
[ifail] = x04da(matrix, diag, a, title)
 
 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

ifail =

                    0



PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2013