# NAG FL Interfaceg05tbf (logical)

## 1Purpose

g05tbf generates a vector of pseudorandom logical values – .TRUE. with probability $p$ and .FALSE. with probability $\left(1-p\right)$.

## 2Specification

Fortran Interface
 Subroutine g05tbf ( n, p, x,
 Integer, Intent (In) :: n Integer, Intent (Inout) :: state(*), ifail Real (Kind=nag_wp), Intent (In) :: p Logical, Intent (Out) :: x(n)
#include <nag.h>
 void g05tbf_ (const Integer *n, const double *p, Integer state[], logical x[], Integer *ifail)
The routine may be called by the names g05tbf or nagf_rand_logical.

## 3Description

g05tbf generates $n$ logical values ${x}_{i}$ from the relation
 $yi
where ${y}_{i}$ is a pseudorandom number from a uniform distribution over $\left(0,1\right]$, generated by g05saf using the values of state as input to this routine.
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 g05tbf.
Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley

## 5Arguments

1: $\mathbf{n}$Integer Input
On entry: $n$, the number of pseudorandom logical values to be generated.
Constraint: ${\mathbf{n}}\ge 0$.
2: $\mathbf{p}$Real (Kind=nag_wp) Input
On entry: must contain the probability of g05tbf returning .TRUE..
Constraint: $0.0\le {\mathbf{p}}\le 1.0$.
3: $\mathbf{state}\left(*\right)$Integer array Communication 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.
4: $\mathbf{x}\left({\mathbf{n}}\right)$Logical array Output
On exit: the $n$ logical values.
5: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, . If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 0$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{p}}=〈\mathit{\text{value}}〉$.
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$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
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.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

Not applicable.

## 8Parallelism and Performance

g05tbf 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.

None.

## 10Example

This example prints the first $20$ pseudorandom logical values generated by g05tbf after initialization by g05kff, when the probability of a .TRUE. value is $0.5$.

### 10.1Program Text

Program Text (g05tbfe.f90)

### 10.2Program Data

Program Data (g05tbfe.d)

### 10.3Program Results

Program Results (g05tbfe.r)