NAG Toolbox: nag_rand_logical (g05tb)

Purpose

Syntax

Description

References

Parameters

Compulsory Input Parameters

1:     $\mathrm{n}$ – int64int32nag_int scalar

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

Constraint: $\mathbf{n}\ge 0$.

2:     $\mathrm{p}$ – double scalar

Must contain the probability of nag_rand_logical (g05tb) returning true.

Constraint: $0.0\le \mathbf{p}\le 1.0$.

3:     $\mathrm{state}\left(:\right)$ – int64int32nag_int array

Note: the actual argument supplied must be the array state supplied to the initialization routines nag_rand_init_repeat (g05kf) or nag_rand_init_nonrepeat (g05kg).

Contains information on the selected base generator and its current state.

Optional Input Parameters

None.

Output Parameters

1:     $\mathrm{state}\left(:\right)$ – int64int32nag_int array

Contains updated information on the state of the generator.

2:     $\mathrm{x}\left(\mathbf{n}\right)$ – logical array

The $n$ logical values.

3:     $\mathrm{ifail}$ – int64int32nag_int scalar

$\mathbf{ifail}=\mathbf{0}$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

   $\mathbf{ifail}=1$

Constraint: $\mathbf{n}\ge 0$.

   $\mathbf{ifail}=2$

Constraint: $0.0\le \mathbf{p}\le 1.0$.

   $\mathbf{ifail}=3$

On entry, state vector has been corrupted or not initialized.

   $\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

   $\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

   $\mathbf{ifail}=-999$

Dynamic memory allocation failed.

Accuracy

Further Comments

Example

Open in the MATLAB editor: g05tb_example

function g05tb_example


fprintf('g05tb example results\n\n');

% Initialize the base generator to a repeatable sequence
seed  = [int64(1762543)];
genid = int64(1);
subid = int64(1);
[state, ifail] = g05kf( ...
                        genid, subid, seed);

% Number of variates
n = int64(20);

% Parameters
p = 0.5;

% Generate variates from a logical distribution
[state, x, ifail] = g05tb( ...
                           n, p, state);

disp('Variates');
for i = 1:n
  if x(i)
    fprintf('    true\n');
  else
    fprintf('    false\n');
  end
end

g05tb example results

Variates
    false
    true
    false
    false
    true
    true
    true
    false
    true
    false
    true
    true
    false
    true
    false
    true
    true
    false
    false
    false