M01DKF (PDF version)
M01 Chapter Contents
M01 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentM01DKF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

M01DKF ranks the columns of a matrix of integer numbers in ascending or descending order.

## 2  Specification

 SUBROUTINE M01DKF ( IM, LDM, M1, M2, N1, N2, ORDER, IRANK, IFAIL)
 INTEGER IM(LDM,N2), LDM, M1, M2, N1, N2, IRANK(N2), IFAIL CHARACTER(1) ORDER

## 3  Description

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 ${\mathbf{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.
Knuth D E (1973) The Art of Computer Programming (Volume 3) (2nd Edition) Addison–Wesley

## 5  Parameters

1:     $\mathrm{IM}\left({\mathbf{LDM}},{\mathbf{N2}}\right)$ – INTEGER arrayInput
On entry: rows M1 to M2 of columns N1 to N2 of IM must contain integer data to be ranked.
2:     $\mathrm{LDM}$ – INTEGERInput
On entry: the first dimension of the array IM as declared in the (sub)program from which M01DKF is called.
Constraint: ${\mathbf{LDM}}\ge {\mathbf{M2}}$.
3:     $\mathrm{M1}$ – INTEGERInput
On entry: the index of the first row of IM to be used.
Constraint: ${\mathbf{M1}}>0$.
4:     $\mathrm{M2}$ – INTEGERInput
On entry: the index of the last row of IM to be used.
Constraint: ${\mathbf{M2}}\ge {\mathbf{M1}}$.
5:     $\mathrm{N1}$ – INTEGERInput
On entry: the index of the first column of IM to be ranked.
Constraint: ${\mathbf{N1}}>0$.
6:     $\mathrm{N2}$ – INTEGERInput
On entry: the index of the last column of IM to be ranked.
Constraint: ${\mathbf{N2}}\ge {\mathbf{N1}}$.
7:     $\mathrm{ORDER}$ – CHARACTER(1)Input
On entry: if ${\mathbf{ORDER}}=\text{'A'}$, the columns will be ranked in ascending (i.e., nondecreasing) order.
If ${\mathbf{ORDER}}=\text{'D'}$, into descending order.
Constraint: ${\mathbf{ORDER}}=\text{'A'}$ or $\text{'D'}$.
8:     $\mathrm{IRANK}\left({\mathbf{N2}}\right)$ – 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, ${\mathbf{IRANK}}\left(i\right)$ is set to N1.
9:     $\mathrm{IFAIL}$ – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ 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\text{​ 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 $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
 On entry, ${\mathbf{M2}}<1$, or ${\mathbf{N2}}<1$, or ${\mathbf{M1}}<1$, or ${\mathbf{M1}}>{\mathbf{M2}}$, or ${\mathbf{N1}}<1$, or ${\mathbf{N1}}>{\mathbf{N2}}$, or ${\mathbf{LDM}}<{\mathbf{M2}}$.
${\mathbf{IFAIL}}=2$
 On entry, ORDER is not 'A' or 'D'.
${\mathbf{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.
${\mathbf{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.
${\mathbf{IFAIL}}=-999$
Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

Not applicable.

Not applicable.

## 9  Further Comments

The average time taken by the routine is approximately proportional to $n×\mathrm{log}\left(n\right)$, where $n={\mathbf{N2}}-{\mathbf{N1}}+1$.

## 10  Example

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

### 10.1  Program Text

Program Text (m01dkfe.f90)

### 10.2  Program Data

Program Data (m01dkfe.d)

### 10.3  Program Results

Program Results (m01dkfe.r)

M01DKF (PDF version)
M01 Chapter Contents
M01 Chapter Introduction
NAG Library Manual