naginterfaces.library.sort.permute_​check

naginterfaces.library.sort.permute_check(iperm, m1)

permute_check checks the validity of a permutation.

For full information please refer to the NAG Library document for m01zb

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/m01/m01zbf.html

Parameters

ipermint, array-like, shape $\left(\text{m2}\right)$

Elements $m1-1$ to $\text{m2}-1$ of $iperm$ must be set to values which are supposed to be a permutation of the integers $m1$ to $\text{m2}$. If they are a valid permutation, the function exits with no exception or warning is raised.

m1int

Note: this argument represents an array index; the value you supply must be base-1 for compatibility with the NAG Engine.

The range of elements used in the array $iperm$ and the range of values in the permutation, as specified under $iperm$.

Returns

ipermint, ndarray, shape $\left(\text{m2}\right)$

Used as internal workpsace prior to being restored and hence is unchanged.

Raises

NagValueError

(errno $1$)

On entry, $m1=⟨value⟩$ and $\text{m2}=⟨value⟩$.

Constraint: $m1\le \text{m2}$.

(errno $1$)

On entry, $m1=⟨value⟩$.

Constraint: $m1\ge 1$.

(errno $1$)

On entry, $\text{m2}=⟨value⟩$.

Constraint: $\text{m2}\ge 1$.

(errno $2$)

$iperm[m1:\text{m2}-1]$ does not contain a permutation of the integers $m1$ to $\text{m2}$. $iperm[I-1]$ contains an out-of-range value: $I=⟨value⟩$, $iperm[I-1]=⟨value⟩$.

(errno $3$)

$iperm[m1:\text{m2}-1]$ does not contain a permutation of the integers $m1$ to $\text{m2}$. $iperm$ contains a repeated value: $⟨value⟩$.

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

permute_check can be used to check the validity of user-supplied ranks or indices, without the ranks or indices being corrupted.