NAG Library Manual, Mark 29.3
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01za:  FL   CL   CPP   AD   PY   MB 

NAG FL Interface
m01zaf (permute_​invert)

NAG Library Manual, Mark 29.3
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01za:  FL   CL   CPP   AD   PY   MB 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2023
Settings help

FL Name Style:


FL Specification Language:


1 Purpose

m01zaf inverts a permutation, and hence converts a rank vector to an index vector, or vice versa.

2 Specification

Fortran Interface
Subroutine m01zaf ( iperm, m1, m2, ifail)
Integer, Intent (In) :: m1, m2
Integer, Intent (Inout) :: iperm(m2), ifail
C Header Interface
#include <nag.h>
void  m01zaf_ (Integer iperm[], const Integer *m1, const Integer *m2, Integer *ifail)
The routine may be called by the names m01zaf or nagf_sort_permute_invert.

3 Description

There are two common ways of describing a permutation using an integer vector iperm. The first uses ranks: iperm(i) holds the position to which the ith data element should be moved in order to sort the data; in other words its rank in the sorted order. The second uses indices: iperm(i) holds the current position of the data element which would occur in ith position in sorted order. For example, given the values
3.5 5.9 2.9 0.5  
to be sorted in ascending order, the ranks would be
3.0   4.0   2.0   1.0  
and the indices would be
4.0   3.0   1.0   2.0  
The routines m01daf, m01dbf, m01dcf, m01def, m01dff, m01djf, m01dkf and m01dzf generate ranks, and the routines m01eaf, m01ebf, m01ecf and m01edf require ranks to be supplied to specify the reordering. However if it is desired simply to refer to the data in sorted order without actually reordering them, indices are more convenient than ranks.
m01zaf can be used to convert ranks to indices, or indices to ranks, as the two permutations are inverses of each another.

4 References

None.

5 Arguments

1: iperm(m2) – Integer array Input/Output
On entry: elements m1 to m2 of iperm must contain a permutation of the integers m1 to m2.
On exit: these elements contain the inverse permutation of the integers m1 to m2.
2: m1 – Integer Input
3: m2 – Integer Input
On entry: m1 and m2 must specify the range of elements used in the array iperm and the range of values in the permutation, as specified under iperm.
Constraint: 0<m1≤m2.
4: ifail – Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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 or −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, m1=⟨value⟩.
Constraint: m1≥1.
On entry, m1=⟨value⟩ and m2=⟨value⟩.
Constraint: m1≤m2.
On entry, m2=⟨value⟩.
Constraint: m2≥1.
ifail=2
iperm(m1:m2) does not contain a permutation of the integers m1 to m2. iperm(I) contains an out-of-range value: I=⟨value⟩, iperm(I)=⟨value⟩.
Elements m1 to m2 of iperm do not contain a permutation of the integers m1 to m2; on exit these elements are usually corrupted. To check the validity of a permutation without the risk of corrupting it, use m01zbf.
ifail=3
iperm(m1:m2) does not contain a permutation of the integers m1 to m2. iperm contains a repeated value: ⟨value⟩.
Elements m1 to m2 of iperm do not contain a permutation of the integers m1 to m2; on exit these elements are usually corrupted. To check the validity of a permutation without the risk of corrupting it, use m01zbf.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
m01zaf is not threaded in any implementation.

9 Further Comments

None.

10 Example

This example reads a matrix of real numbers and prints its rows in ascending order as ranked by m01def. The program first calls m01def to rank the rows, and then calls m01zaf to convert the rank vector to an index vector, which is used to refer to the rows in sorted order.

10.1 Program Text

Program Text (m01zafe.f90)

10.2 Program Data

Program Data (m01zafe.d)

10.3 Program Results

Program Results (m01zafe.r)
NAG Library Manual, Mark 29.3
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
M01 (Sort) Chapter Contents
M01 (Sort) Chapter Introduction
m01za:  FL   CL   CPP   AD   PY   MB 
© The Numerical Algorithms Group Ltd. 2023