NAG FL Interface
m01zcf (permute_​decompose)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

m01zcf decomposes a permutation into cycles, as an aid to reordering ranked data.

2 Specification

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

3 Description

m01zcf is provided as an aid to reordering arbitrary data structures without using additional storage. However, you should consider carefully whether it is necessary to rearrange yourr data, or whether it would be simpler and more efficient to refer to the data in sorted order using an index vector, or to create a copy of the data in sorted order.
To rearrange data into a different order without using additional storage, the simplest method is to decompose the permutation which specifies the new order into cycles and then to do a cyclic permutation of the data items in each cycle. (This is the method used by the reordering routines m01eaf, m01ebf, m01ecf and m01edf.) Given a vector IRANK which specifies the ranks of the data (as generated by the routines m01daf, m01dbf, m01dcf, m01def, m01dff, m01djf, m01dkf and m01dzf), m01zcf generates a new vector icycl, in which the permutation is represented in its component cycles, with the first element of each cycle negated. For example, the permutation
5 7 4 2 1 6 3  
is composed of the cycles
( 1 5 ) ( 2 7 3 4 ) ( 6 )  
and the vector icycl generated by m01zcf contains
−1 5 −2 7 3 4 −6  
In order to rearrange the data according to the specified ranks:
The complete rearrangement can be achieved by the following code:
do k = m1, m2
  i = icycl(k)
  if (i < 0) then
    j = -i
    [swap items i and j]
  end if
end do

4 References


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: is used as internal workpsace prior to being restored and hence is unchanged.
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<m1m2.
4: icycl(m2) Integer array Output
On exit: elements m1 to m2 of icycl contain a representation of the permutation as a list of cycles, with the first integer in each cycle negated. (See Section 3.)
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:
On entry, m1=value.
Constraint: m11.
On entry, m1=value and m2=value.
Constraint: m1m2.
On entry, m2=value.
Constraint: m21.
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.
iperm(m1:m2) does not contain a permutation of the integers m1 to m2. iperm contains a repeated value: value.
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.
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.
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.
m01zcf is not threaded in any implementation.

9 Further Comments


10 Example

This example reads a matrix of real numbers and rearranges its columns so that the elements of the lth row are in ascending order. To do this, the program first calls m01djf to rank the elements of the lth row, and then calls m01zcf to decompose the rank vector into cycles. It then rearranges the columns using the framework of code suggested in Section 3. The value of l is read from the data file.

10.1 Program Text

Program Text (m01zcfe.f90)

10.2 Program Data

Program Data (m01zcfe.d)

10.3 Program Results

Program Results (m01zcfe.r)