NAG Library Routine Document

M01EDF

M01EDF is designed to be used typically in conjunction with the M01D ranking routines. After one of the M01D routines has been called to determine a vector of ranks, M01EDF can be called to rearrange a vector of complex numbers into the rank order. If the vector of ranks has been generated in some other way, then M01ZBF should be called to check its validity before M01EDF is called.

4 References

None.

5 Parameters

1: $CV (M2)$ – COMPLEX (KIND=nag_wp) arrayInput/Output: On entry: elements M1 to M2 of CV must contain complex values to be rearranged.

On exit: these values are rearranged into rank order. For example, if $IRANK (i) = M1$ , then the initial value of $CV (i)$ is moved to $CV (M1)$ .
2: $M1$ – INTEGERInput
3: $M2$ – INTEGERInput: On entry: M1 and M2 must specify the range of the ranks supplied in IRANK and the elements of CV to be rearranged.

Constraint: $0 < M1 \leq M2$ .
4: $IRANK (M2)$ – INTEGER arrayInput/Output: On entry: elements M1 to M2 of IRANK must contain a permutation of the integers M1 to M2, which are interpreted as a vector of ranks.
On exit: used as internal workspace prior to being restored and hence is unchanged.
5: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$ . When the value $- 1 or 1$ is used it is essential to test the value of IFAIL on exit.

On exit: $IFAIL = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

IFAIL = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by X04AAF).

Errors or warnings detected by the routine:

$IFAIL = 1$

On entry,	$M2 < 1$ ,
or	$M1 < 1$ ,
or	$M1 > M2$ .

$IFAIL = 2$: Elements M1 to M2 of IRANK contain a value outside the range M1 to M2.

$IFAIL = 3$: Elements M1 to M2 of IRANK contain a repeated value.

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

IFAIL = 2

3

, elements M1 to M2 of IRANK do not contain a permutation of the integers M1 to M2. On exit, the contents of CV may be corrupted. To check the validity of IRANK without the risk of corrupting CV, use M01ZBF.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Not applicable.

9 Further Comments

The average time taken by the routine is approximately proportional to

n

, where

n = M2 - M1 + 1

10 Example

This example reads a matrix of complex numbers and rearranges its rows so that the elements in the

k

th column are in ascending order of modulus. To do this, the program first calls M01DAF to rank the moduli of the elements in the

k

th column, and then calls M01EDF to rearrange each column into the order specified by the ranks. The value of

k

is read from the datafile.

NAG Library Routine DocumentM01EDF

▸▿ Contents

1 Purpose

2 Specification

3 Description