NAG CL Interface
g05tbc (logical)

1 Purpose

g05tbc generates a vector of pseudorandom logical values – Nag_TRUE with probability p and Nag_FALSE with probability 1-p.

2 Specification

#include <nag.h>
void  g05tbc (Integer n, double p, Integer state[], Nag_Boolean x[], NagError *fail)
The function may be called by the names: g05tbc or nag_rand_logical.

3 Description

g05tbc generates n logical values xi from the relation
where yi is a pseudorandom number from a uniform distribution over 0,1, generated by g05sac using the values of state as input to this function.
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 g05tbc.

4 References

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

5 Arguments

1: n Integer Input
On entry: n, the number of pseudorandom logical values to be generated.
Constraint: n0.
2: p double Input
On entry: must contain the probability of g05tbc returning Nag_TRUE.
Constraint: 0.0p1.0.
3: 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.
4: x[n] Nag_Boolean Output
On exit: the n logical values.
5: 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: n0.
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.
On entry, p=value.
Constraint: 0.0p1.0.

7 Accuracy

Not applicable.

8 Parallelism and Performance

g05tbc 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


10 Example

This example prints the first 20 pseudorandom logical values generated by g05tbc after initialization by g05kfc, when the probability of a Nag_TRUE value is 0.5.

10.1 Program Text

Program Text (g05tbce.c)

10.2 Program Data


10.3 Program Results

Program Results (g05tbce.r)