NAG C Library Function Document

nag_make_indices (m01zac)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{ranks}\left[\mathbf{n}\right]$ – size_tInput/Output

On entry: ranks must contain a permutation of the Integers 0 to $\mathbf{n}-1$.

On exit: ranks contains the inverse permutation.

2:    $\mathbf{n}$ – size_tInput

On entry: the length of the array ranks.

Constraint: $0\le \mathbf{n}\le \mathrm{MAX\_LENGTH}$, where $\mathrm{MAX\_LENGTH}$ is an implementation-dependent value for the maximum size of an array.

3:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_BAD_RANK

Invalid ranks vector.
Elements of ranks contain a value outside the range 0 to $\mathbf{n}-1$ or contain a repeated value. ranks does not contain a permutation of the Integers 0 to $\mathbf{n}-1$; on exit these elements are usually corrupted.

NE_INT_ARG_GT

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\le 〈\mathit{\text{value}}〉$, an implementation-dependent size that is printed in the error message.

NE_INT_ARG_LT

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (m01zace.c)

10.2

Program Data

Program Data (m01zace.d)

10.3

Program Results

Program Results (m01zace.r)