NAG Toolbox: nag_file_print_matrix_complex_band_comp (x04df)

Purpose

Syntax

Description

References

Parameters

Compulsory Input Parameters

1:     $\mathrm{m}$ – int64int32nag_int scalar

2:     $\mathrm{n}$ – int64int32nag_int scalar

The number of rows and columns of the band matrix, respectively, to be printed.

If either m or n is less than $1$, nag_file_print_matrix_complex_band_comp (x04df) will exit immediately after printing title; no row or column labels are printed.

3:     $\mathrm{kl}$ – int64int32nag_int scalar

The number of subdiagonals of the band matrix $A$.

Constraint: $\mathbf{kl}\ge 0$.

4:     $\mathrm{ku}$ – int64int32nag_int scalar

The number of superdiagonals of the band matrix $A$.

Constraint: $\mathbf{ku}\ge 0$.

5:     $\mathrm{a}\left(\mathit{lda},:\right)$ – complex array

The first dimension of the array a must be at least $\mathbf{kl}+\mathbf{ku}+1$.

The second dimension of the array a must be at least $\max \left(1,\min \left(\mathbf{m}+\mathbf{ku},\mathbf{n}\right)\right)$.

The band matrix to be printed.

The matrix is stored in rows $1$ to $k_l+k_u+1$, more precisely, the element $A_{ij}$ must be stored in

$$\mathbf{a}\left(k_u+1+i-j,j\right)\text{\hspace{1em} for }\max \left(1,j-k_u\right)\le i\le \min \left(m,j+k_l\right)\text{.}$$

6:     $\mathrm{usefrm}$ – string (length ≥ 1)

Indicates how the value of form is to be used to print matrix elements, except in MATLAB mode where usefrm is ignored.

$\mathbf{usefrm}=\text{'A'}$

The format code in form is assumed to contain a single real edit-descriptor which is to be used to print the real and imaginary parts of each complex number one above the other. Each row of the matrix is separated by a blank line, and any row labels are attached only to the real parts. This option means that about twice as many columns can be fitted into ncols characters than if any other usefrm option is used. A typical value of form for this usefrm option might be $\text{'E13.4'}$, $\text{'*'}$ or $\text{' '}$.

$\mathbf{usefrm}=\text{'B'}$

The format code in form is assumed to contain a single edit-descriptor such as $\text{'E13.4'}$, $\text{'*'}$ or $\text{' '}$ which is used to print the real and imaginary parts of each complex number separated by a comma, and surrounded by brackets. Thus a matrix element printed with this usefrm option might look like this: $\left(12.345,-11.323\right)$.

$\mathbf{usefrm}=\text{'D'}$

The format code in form is used unaltered to print a complex number. This usefrm option allows you flexibility to specify exactly how the number is printed. With this option for usefrm and a suitable value for form it is possible, for example, to print a complex number in the form $\left(0.123+3.214i\right)$ or $\left(\text{0.123e−02},\text{0.234e−01}\right)$. See Example for an example illustrating this option.

Constraint: $\mathbf{usefrm}=\text{'A'}$, $\text{'B'}$ or $\text{'D'}$.

7:     $\mathrm{form}$ – string

Describes the Fortran format code that is used in conjunction with usefrm 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 nag_file_print_matrix_complex_band_comp (x04df) to choose its own format code:

$\mathbf{form}=\text{' '}$

nag_file_print_matrix_complex_band_comp (x04df) 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 the real and imaginary parts 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 numbers to be printed lie between $0.001$ and $9999.9999$. Otherwise the 1PE13.4 code is chosen.

$\mathbf{form}=\text{'*'}$

nag_file_print_matrix_complex_band_comp (x04df) 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’, nag_file_print_matrix_complex_band_comp (x04df) will print the matrix such that it can be input into MATLAB, and title will be used as the name of the matrix.

More complicated values of form, to print a complex number in a desired form, may be used. See the description of argument usefrm for more details.

Examples of valid values for form are $\text{'(F11.4)'}$, $\text{'1P,2E13.5'}$, $\text{'MATLABF11.4'}$, $\text{'MATLAB*'}$.

Constraint: the character length of the format specifier in form must be $\le 80$.

8:     $\mathrm{title}$ – string

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.

9:     $\mathrm{labrow}$ – string (length ≥ 1)

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'}$.

10:   $\mathrm{rlabs}\left(:\right)$ – cell array of strings

The dimension of the array rlabs must be at least $\mathbf{m}$ if $\mathbf{labrow}=\text{'C'}$, and at least $1$ otherwise

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.

11:   $\mathrm{labcol}$ – string (length ≥ 1)

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'}$.

12:   $\mathrm{clabs}\left(:\right)$ – cell array of strings

The dimension of the array clabs must be at least $\mathbf{n}$ if $\mathbf{labcol}=\text{'C'}$, and at least $1$ otherwise

If $\mathbf{labcol}=\text{'C'}$, clabs must contain labels for the columns of the matrix, except in MATLAB mode where clabs is ignored.

Labels are right-justified when output. Any label that is too long for the column width, which is determined by form, is truncated.

13:   $\mathrm{ncols}$ – int64int32nag_int scalar

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.

ncols must be large enough to hold at least one column of the matrix using the format specifier in form. If a value less than 0 or greater than $132$ is supplied for ncols, then the value $80$ is used instead.

14:   $\mathrm{indent}$ – int64int32nag_int scalar

The number of columns by which the matrix (and any title and labels) should be indented. The effective value of ncols is reduced by indent columns. If a value less than $0$ or greater than ncols is supplied for indent, the value $0$ is used instead.

Optional Input Parameters

None.

Output Parameters

1:     $\mathrm{ifail}$ – int64int32nag_int scalar

$\mathbf{ifail}=\mathbf{0}$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

   $\mathbf{ifail}=1$

On entry,

$\mathbf{kl}<0$.

   $\mathbf{ifail}=2$

On entry,

$\mathbf{ku}<0$.

   $\mathbf{ifail}=3$

On entry,

$\mathit{lda}<\mathbf{kl}+\mathbf{ku}+1$.

   $\mathbf{ifail}=4$

On entry,

$\mathbf{usefrm}\ne \text{'A'}$, $\text{'B'}$ or $\text{'D'}$.

   $\mathbf{ifail}=5$

On entry,

the format specifier in form is more than $80$ characters long.

   $\mathbf{ifail}=6$

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}=7$

On entry,

either labrow or $\mathbf{labcol}\ne \text{'N'}$, $\text{'I'}$ or $\text{'C'}$.

   $\mathbf{ifail}=8$

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}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

   $\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

   $\mathbf{ifail}=-999$

Dynamic memory allocation failed.

Accuracy

Further Comments

Example

Open in the MATLAB editor: x04df_example

function x04df_example


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

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

a = b - i*b;

% Example 1 5x5 tridiagonal matrix
mtitle = 'Example 1:';
m = int64(nmax);
n = m;
kl = int64(1);
ku = kl;

% Bracketed representation of complex numbers and Default formatting
usefrm = 'Bracketed';
format = ' ';

% Integer labels
labrow = 'Integer';
labcol = labrow;
rlabs = {'       '};
clabs = {'       '};

% 80 colunms wide, no indent
ncols  = int64(80);
indent = int64(0);

[ifail] = x04df( ...
                 m, n, kl, ku, a, usefrm, format, mtitle, labrow, ...
                 rlabs, labcol, clabs, ncols, indent);

fprintf('\n');
% Second matrix : 4x4 2 super-diagonals + 1 sub-diagonal
mtitle = 'Example 2:';
m = int64(nmax-1);
n = m;
kl = int64(1);
ku = int64(2);

% Define formatting of complex numbers
usefrm = 'Direct';
format = 'SS,F7.1,SP,F6.1,''i''';

% Character labels
labrow = 'Character';
labcol = labrow;
rlabs  = {'Uno    '; 'Due    '; 'Tre    '; 'Quattro'};
clabs  = {'Un     '; 'Deux   '; 'Trois  '; 'Quatre '};

[ifail] = x04df( ...
                 m, n, kl, ku, a, usefrm, format, mtitle, labrow, ...
                 rlabs, labcol, clabs, ncols, indent);

fprintf('\n Example 3:\n');
% Third matrix: As above in Matlab format 
mtitle = 'A';
usefrm = ' ';
format = 'MATLABF7.1';
labrow = 'No labels';
labcol = labrow;

[ifail] = x04df( ...
                 m, n, kl, ku, a, usefrm, format, mtitle, labrow, ...
                 rlabs, labcol, clabs, ncols, indent);

x04df example results

 Example 1:
                            1                         2
 1  (    21.0000,   -21.0000) (    12.0000,   -12.0000)
 2  (    31.0000,   -31.0000) (    22.0000,   -22.0000)
 3                            (    32.0000,   -32.0000)
 4
 5

                            3                         4
 1
 2  (    13.0000,   -13.0000)
 3  (    23.0000,   -23.0000) (    14.0000,   -14.0000)
 4  (    33.0000,   -33.0000) (    24.0000,   -24.0000)
 5                            (    34.0000,   -34.0000)

                            5
 1
 2
 3
 4  (    15.0000,   -15.0000)
 5  (    25.0000,   -25.0000)

 Example 2:
                     Un          Deux         Trois        Quatre
     Uno    31.0 -31.0i   22.0 -22.0i   13.0 -13.0i
     Due    41.0 -41.0i   32.0 -32.0i   23.0 -23.0i   14.0 -14.0i
     Tre                  42.0 -42.0i   33.0 -33.0i   24.0 -24.0i
 Quattro                                43.0 -43.0i   34.0 -34.0i

 Example 3:
 A = [
   (   31.0  -31.0i) (   22.0  -22.0i) (   13.0  -13.0i) (    0.0   +0.0i);
   (   41.0  -41.0i) (   32.0  -32.0i) (   23.0  -23.0i) (   14.0  -14.0i);
   (    0.0   +0.0i) (   42.0  -42.0i) (   33.0  -33.0i) (   24.0  -24.0i);
   (    0.0   +0.0i) (    0.0   +0.0i) (   43.0  -43.0i) (   34.0  -34.0i);
     ];