NAG Library Function Document

nag_rand_permute (g05ncc)

is likely to exceed the cycle length of any of the base generators. For practical purposes this is irrelevant, as the time necessary to generate all possible permutations is many millenia.

One of the initialization functions nag_rand_init_repeatable (g05kfc) (for a repeatable sequence if computed sequentially) or nag_rand_init_nonrepeatable (g05kgc) (for a non-repeatable sequence) must be called prior to the first call to nag_rand_permute (g05ncc).

4 References

Kendall M G and Stuart A (1969) The Advanced Theory of Statistics (Volume 1) (3rd Edition) Griffin

Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley

5 Arguments

1: indx[n] – IntegerInput/Output: On entry: the $n$ integer values to be permuted.

On exit: the $n$ permuted integer values.
2: n – IntegerInput: On entry: the number of values to be permuted.
Constraint: $n \geq 1$ .
3: state[ $\dim$ ] – IntegerCommunication Array: Note: the dimension, $\dim$ , of this array is dictated by the requirements of associated functions that must have been previously called. This array MUST be the same array passed as argument state in the previous call to nag_rand_init_repeatable (g05kfc) or nag_rand_init_nonrepeatable (g05kgc).
On entry: contains information on the selected base generator and its current state.

On exit: contains updated information on the state of the generator.
4: fail – NagError *Input/Output: The NAG error argument (see Section 3.6 in the Essential Introduction).

6 Error Indicators and Warnings

NE_BAD_PARAM: On entry, argument $⟨value⟩$ had an illegal value.
NE_INT: On entry, $n = ⟨value⟩$ .
Constraint: $n \geq 1$ .
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
NE_INVALID_STATE: On entry, state vector has been corrupted or not initialized.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Not applicable.

9 Further Comments

None.

10 Example

In the example program a vector containing the first eight positive integers in ascending order is permuted by a call to nag_rand_permute (g05ncc) and the permutation is printed. This is repeated a total of ten times, after initialization by nag_rand_init_repeatable (g05kfc).