NAG Library Routine Document

M01DKF

M01DKF ranks columns N1 to N2 of a matrix, using the data in rows M1 to M2 of those columns. The ordering is determined by first ranking the data in row M1, then ranking any tied columns according to the data in row

M1 + 1

, and so on up to row M2.

M01DKF uses a variant of list-merging, as described on pages 165–166 in Knuth (1973). The routine takes advantage of natural ordering in the data, and uses a simple list insertion in a preparatory pass to generate ordered lists of length at least

10

. The ranking is stable: equal columns preserve their ordering in the input data.

4 References

Knuth D E (1973) The Art of Computer Programming (Volume 3) (2nd Edition) Addison–Wesley

5 Parameters

1: $IM (LDM, N2)$ – INTEGER arrayInput: On entry: rows M1 to M2 of columns N1 to N2 of IM must contain integer data to be ranked.
2: $LDM$ – INTEGERInput: On entry: the first dimension of the array IM as declared in the (sub)program from which M01DKF is called.

Constraint: $LDM \geq M2$ .
3: $M1$ – INTEGERInput: On entry: the index of the first row of IM to be used.

Constraint: $M1 > 0$ .
4: $M2$ – INTEGERInput: On entry: the index of the last row of IM to be used.

Constraint: $M2 \geq M1$ .
5: $N1$ – INTEGERInput: On entry: the index of the first column of IM to be ranked.

Constraint: $N1 > 0$ .
6: $N2$ – INTEGERInput: On entry: the index of the last column of IM to be ranked.

Constraint: $N2 \geq N1$ .
7: $ORDER$ – CHARACTER(1)Input: On entry: if $ORDER ='A'$ , the columns will be ranked in ascending (i.e., nondecreasing) order.
If $ORDER ='D'$ , into descending order.

Constraint: $ORDER ='A'$ or $'D'$ .
8: $IRANK (N2)$ – INTEGER arrayOutput: On exit: elements N1 to N2 of IRANK contain the ranks of the corresponding columns of IM. Note that the ranks are in the range N1 to N2: thus, if the $i$ th column of IM is the first in the rank order, $IRANK (i)$ is set to N1.
9: $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	$N2 < 1$ ,
or	$M1 < 1$ ,
or	$M1 > M2$ ,
or	$N1 < 1$ ,
or	$N1 > N2$ ,
or	$LDM < M2$ .

$IFAIL = 2$

On entry,

ORDER is not 'A' or 'D'.

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

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 \times \log (n)

, where

n = N2 - N1 + 1

10 Example

This example reads a matrix of integers and ranks the columns in descending order.

NAG Library Routine DocumentM01DKF

▸▿ Contents

1 Purpose

2 Specification

3 Description