naginterfaces.library.rand.logical

naginterfaces.library.rand.logical(n, p, statecomm)

logical generates a vector of pseudorandom logical values – $True$ with probability $p$ and $False$ with probability $(1-p)$.

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

https://support.nag.com/numeric/nl/nagdoc_30/flhtml/g05/g05tbf.html

Parameters

nint

$n$, the number of pseudorandom logical values to be generated.

pfloat

Must contain the probability of logical returning $True$.

statecommdict, RNG communication object, modified in place

RNG communication structure.

This argument must have been initialized by a prior call to init_repeat() or init_nonrepeat().

Returns

xbool, ndarray, shape $\left(n\right)$

The $n$ logical values.

Raises

NagValueError

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 0$.

(errno $2$)

On entry, $p=⟨value⟩$.

Constraint: $0.0\le p\le 1.0$.

(errno $3$)

On entry, $statecomm$[‘state’] vector has been corrupted or not initialized.

Notes

logical generates $n$ logical values $x_i$ from the relation

$$y_i<p$$

where $y_i$ is a pseudorandom number from a uniform distribution over $(0,1]$, generated by dist_uniform01() using the values of $statecomm$[‘state’] as input to this function.

One of the initialization functions init_repeat() (for a repeatable sequence if computed sequentially) or init_nonrepeat() (for a non-repeatable sequence) must be called prior to the first call to logical.

References

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