NAG Library Routine Document

m01dcf  (charvec_rank)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{ch}\left(\mathbf{m2}\right)$ – Character(*) arrayInput

On entry: elements m1 to m2 of ch must contain character data to be ranked.

Constraint: the length of each element of ch must not exceed $255$.

2:     $\mathbf{m1}$ – IntegerInput

On entry: the index of the first element of ch to be ranked.

Constraint: $\mathbf{m1}>0$.

3:     $\mathbf{m2}$ – IntegerInput

On entry: the index of the last element of ch to be ranked.

Constraint: $\mathbf{m2}\ge \mathbf{m1}$.

4:     $\mathbf{l1}$ – IntegerInput

5:     $\mathbf{l2}$ – IntegerInput

On entry: only the substring (l1:l2) of each element of ch is to be used in determining the rank order.

Constraint: $0<\mathbf{l1}\le \mathbf{l2}\le \mathrm{len}\left(\mathbf{ch}\left(1\right)\right)$.

6:     $\mathbf{order}$ – Character(1)Input

On entry: if $\mathbf{order}=\text{'A'}$, the values will be ranked in ASCII order.

If $\mathbf{order}=\text{'R'}$, in reverse ASCII order.

Constraint: $\mathbf{order}=\text{'A'}$ or $\text{'R'}$.

7:     $\mathbf{irank}\left(\mathbf{m2}\right)$ – Integer arrayOutput

On exit: elements m1 to m2 of irank contain the ranks of the corresponding elements of ch. Note that the ranks are in the range m1 to m2: thus, if $\mathbf{ch}\left(i\right)$ is the first element in the rank order, $\mathbf{irank}\left(i\right)$ is set to m1.

8:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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

$\mathbf{ifail}=1$

On entry,	$\mathbf{m2}<1$,
or	$\mathbf{m1}<1$,
or	$\mathbf{m1}>\mathbf{m2}$,
or	$\mathbf{l2}<1$,
or	$\mathbf{l1}<1$,
or	$\mathbf{l1}>\mathbf{l2}$,
or	$\mathbf{l2}>\mathrm{len}\left(\mathbf{ch}\left(1\right)\right)$.

$\mathbf{ifail}=2$

On entry,

order is not 'A' or 'R'.

$\mathbf{ifail}=3$

On entry,

the length of each element of ch exceeds $255$.

$\mathbf{ifail}=-99$

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

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

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

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (m01dcfe.f90)

10.2

Program Data

Program Data (m01dcfe.d)

10.3

Program Results

Program Results (m01dcfe.r)