NAG FL Interface
m01edf (cmplxvec_​rank_​rearrange)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

m01edf rearranges a vector of complex numbers into the order specified by a vector of ranks.

2 Specification

Fortran Interface
Subroutine m01edf ( cv, m1, m2, irank, ifail)
Integer, Intent (In) :: m1, m2
Integer, Intent (Inout) :: irank(m2), ifail
Complex (Kind=nag_wp), Intent (Inout) :: cv(m2)
C Header Interface
#include <nag.h>
void  m01edf_ (Complex cv[], const Integer *m1, const Integer *m2, Integer irank[], Integer *ifail)
The routine may be called by the names m01edf or nagf_sort_cmplxvec_rank_rearrange.

3 Description

m01edf is designed to be used typically in conjunction with the ranking routines m01daf, m01dbf, m01dcf, m01def, m01dff, m01djf, m01dkf and m01dzf. After one of those routines has been called to determine a vector of ranks, m01edf can be called to rearrange a vector of complex numbers 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 m01edf is called.

4 References

None.

5 Arguments

1: cv(m2) Complex (Kind=nag_wp) array Input/Output
On entry: elements m1 to m2 of cv must contain complex values to be rearranged.
On exit: these values are rearranged into rank order. For example, if irank(i)=m1, then the initial value of cv(i) is moved to cv(m1).
2: m1 Integer Input
3: m2 Integer Input
On entry: m1 and m2 must specify the range of the ranks supplied in irank and the elements of cv to be rearranged.
Constraint: 0<m1m2.
4: irank(m2) Integer array Input/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: 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: m11.
On entry, m1=value and m2=value.
Constraint: m1m2.
On entry, m2=value.
Constraint: m21.
ifail=2
irank(m1:m2) does not contain a permutation of the integers m1 to m2. irank(I) contains an out-of-range value: I=value, irank(I)=value.
Elements m1 to m2 of irank do not contain a permutation of the integers m1 to m2. On exit, the contents of cv may be corrupted. To check the validity of irank without the risk of corrupting cv, use m01zbf.
ifail=3
irank(m1:m2) does not contain a permutation of the integers m1 to m2. irank contains a repeated value: value.
Elements m1 to m2 of irank do not contain a permutation of the integers m1 to m2. On exit, the contents of cv may be corrupted. To check the validity of irank without the risk of corrupting cv, 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.
m01edf is not threaded in any implementation.

9 Further Comments

The average time taken by the routine is approximately proportional to n, where n=m2-m1+1.

10 Example

This example reads a matrix of complex numbers and rearranges its rows so that the elements in the kth column are in ascending order of modulus. To do this, the program first calls m01daf to rank the moduli of the elements in the kth column, and then calls m01edf to rearrange each column into the order specified by the ranks. The value of k is read from the datafile.

10.1 Program Text

Program Text (m01edfe.f90)

10.2 Program Data

Program Data (m01edfe.d)

10.3 Program Results

Program Results (m01edfe.r)