M01 Chapter Contents
M01 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentM01ECF

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

M01ECF rearranges a vector of character data into the order specified by a vector of ranks.

## 2  Specification

 SUBROUTINE M01ECF ( CH, M1, M2, IRANK, IFAIL)
 INTEGER M1, M2, IRANK(M2), IFAIL CHARACTER(*) CH(M2)

## 3  Description

M01ECF 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, M01ECF can be called to rearrange a vector of character data 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 M01ECF is called.
None.

## 5  Parameters

1:     $\mathrm{CH}\left({\mathbf{M2}}\right)$ – CHARACTER(*) arrayInput/Output
On entry: elements M1 to M2 of CH must contain character data to be rearranged.
Constraint: the length of each element of CH must not exceed $255$.
On exit: these values are rearranged into rank order. For example, if ${\mathbf{IRANK}}\left(i\right)={\mathbf{M1}}$, then the initial value of ${\mathbf{CH}}\left(i\right)$ is moved to ${\mathbf{CH}}\left({\mathbf{M1}}\right)$.
2:     $\mathrm{M1}$ – INTEGERInput
3:     $\mathrm{M2}$ – INTEGERInput
On entry: the range of the ranks supplied in IRANK and the elements of CH to be rearranged.
Constraint: $0<{\mathbf{M1}}\le {\mathbf{M2}}$.
4:     $\mathrm{IRANK}\left({\mathbf{M2}}\right)$ – 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:     $\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{M1}}<1$, or ${\mathbf{M1}}>{\mathbf{M2}}$.
${\mathbf{IFAIL}}=2$
 On entry, the length of each element of CH exceeds $255$.
${\mathbf{IFAIL}}=3$
Elements M1 to M2 of IRANK contain a value outside the range M1 to M2.
${\mathbf{IFAIL}}=4$
Elements M1 to M2 of IRANK contain a repeated value.
${\mathbf{IFAIL}}=-99$
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.
If ${\mathbf{IFAIL}}={\mathbf{3}}$ or ${\mathbf{4}}$, elements M1 to M2 of IRANK do not contain a permutation of the integers M1 to M2. On exit, the contents of CH may be corrupted. To check the validity of IRANK without the risk of corrupting CH, use M01ZBF.

Not applicable.

## 8  Parallelism and Performance

Not applicable.

The average time taken by the routine is approximately proportional to $n$, where $n={\mathbf{M2}}-{\mathbf{M1}}+1$.

## 10  Example

This example reads a file of $12$-character records, each of which contains in characters $1$ to $6$ a name of a NAG routine, and in characters $7$ to $12$ an integer frequency. The program first calls M01DBF to rank the integers in descending order, and then calls M01ECF to rearrange the names into the order specified by the ranks.

### 10.1  Program Text

Program Text (m01ecfe.f90)

### 10.2  Program Data

Program Data (m01ecfe.d)

### 10.3  Program Results

Program Results (m01ecfe.r)