g05tef generates a vector of pseudorandom integers from the discrete hypergeometric distribution of the number of specified items in a sample of size , taken from a population of size with specified items in it.
The routine may be called by the names g05tef or nagf_rand_int_hypergeom.
g05tef generates integers from a discrete hypergeometric distribution, where the probability of is
The variates can be generated with or without using a search table and index. If a search table is used then it is stored with the index in a reference vector and subsequent calls to g05tef with the same parameter values can then use this reference vector to generate further variates. The reference array is generated by a recurrence relation if , otherwise Stirling's approximation is used.
One of the initialization routines g05kff (for a repeatable sequence if computed sequentially) or g05kgf (for a non-repeatable sequence) must be called prior to the first call to g05tef.
Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley
1: – IntegerInput
On entry: a code for selecting the operation to be performed by the routine.
Set up reference vector only.
Generate variates using reference vector set up in a prior call to g05tef.
Set up reference vector and generate variates.
Generate variates without using the reference vector.
, , or .
2: – IntegerInput
On entry: , the number of pseudorandom numbers to be generated.
3: – IntegerInput
On entry: , the sample size of the hypergeometric distribution.
4: – IntegerInput
On entry: , the population size of the hypergeometric distribution.
5: – IntegerInput
On entry: , the number of specified items of the hypergeometric distribution.
6: – Real (Kind=nag_wp) arrayCommunication Array
On entry: if , the reference vector from the previous call to g05tef.
On entry: the dimension of the array r as declared in the (sub)program from which g05tef is called.
if , approximately;
if or , lr must not be too small, but the limit is too complicated to specify;
if , lr must remain unchanged from the previous call to g05tef.
8: – Integer arrayCommunication Array
Note: the actual argument supplied must be the array state supplied to the initialization routines g05kff or g05kgf.
On entry: contains information on the selected base generator and its current state.
On exit: contains updated information on the state of the generator.
9: – Integer arrayOutput
On exit: the pseudorandom numbers from the specified hypergeometric distribution.
10: – IntegerInput/Output
On entry: ifail must be set to , or to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of means that an error message is printed while a value of means that it is not.
If halting is not appropriate, the value or is recommended. If message printing is undesirable, then the value is recommended. Otherwise, the value is recommended. When the value or is used it is essential to test the value of ifail on exit.
On exit: unless the routine detects an error or a warning has been flagged (see Section 6).
6Error Indicators and Warnings
If on entry or , explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
On entry, .
Constraint: , , or .
On entry, .
On entry, and .
On entry, .
On entry, and .
On entry, some of the elements of the array r have been corrupted or have not been initialized.
The value of ns, np or m is not the same as when r was set up in a previous call with or .
On entry, lr is too small when or : , minimum length required .
On entry, state vector has been corrupted or not initialized.
An unexpected error has been triggered by this routine. Please
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.
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
g05tef 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 routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.
The example program prints pseudorandom integers from a hypergeometric distribution with , and , generated by a single call to g05tef, after initialization by g05kff.