NAG CL Interface
g05ndc (sample)

Settings help

CL Name Style:

1 Purpose

g05ndc selects a pseudorandom sample without replacement from an integer vector.

2 Specification

#include <nag.h>
void  g05ndc (const Integer ipop[], Integer n, Integer isampl[], Integer m, Integer state[], NagError *fail)
The function may be called by the names: g05ndc or nag_rand_sample.

3 Description

g05ndc selects m elements from a population vector ipop of length n and places them in a sample vector isampl. Their order in ipop will be preserved in isampl. Each of the ( n m ) possible combinations of elements of isampl may be regarded as being equally probable.
For moderate or large values of n it is theoretically impossible that all combinations of size m may occur, unless m is near 1 or near n. This is because ( n m ) exceeds the cycle length of any of the base generators. For practical purposes this is irrelevant, as the time taken to generate all possible combinations is many millenia.
One of the initialization functions g05kfc (for a repeatable sequence if computed sequentially) or g05kgc (for a non-repeatable sequence) must be called prior to the first call to g05ndc.

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: ipop[n] const Integer Input
On entry: the population to be sampled.
2: n Integer Input
On entry: the number of elements in the population to be sampled.
Constraint: n1.
3: isampl[m] Integer Output
On exit: the selected sample.
4: m Integer Input
On entry: the sample size.
Constraint: 1mn.
5: state[dim] Integer Communication 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.
6: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument value had an illegal value.
On entry, n=value.
Constraint: n1.
On entry, m=value and n=value.
Constraint: 1mn.
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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
On entry, state vector has been corrupted or not initialized.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
g05ndc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The time taken by g05ndc is of order n.
In order to sample other kinds of vectors, or matrices of higher dimension, the following technique may be used:
  1. (a)set ipop[i-1]=i, for i=1,2,,n;
  2. (b)use g05ndc to take a sample from ipop and put it into isampl;
  3. (c)use the contents of isampl as a set of indices to access the relevant vector or matrix.
In order to divide a population into several groups, g05ncc is more efficient.

10 Example

In the example program random samples of size 1,2,,8 are selected from a vector containing the first eight positive integers in ascending order. The samples are generated and printed for each sample size by a call to g05ndc after initialization by g05kfc.

10.1 Program Text

Program Text (g05ndce.c)

10.2 Program Data


10.3 Program Results

Program Results (g05ndce.r)