NAG Library Function Document

nag_rngs_logical (g05kec)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:     p – doubleInput

On entry: must contain the probability of nag_rngs_logical (g05kec) returning Nag_TRUE.

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

2:     igen – IntegerInput

On entry: must contain the identification number for the generator to be used to return a pseudorandom number and should remain unchanged following initialization by a prior call to nag_rngs_init_repeatable (g05kbc) or nag_rngs_init_nonrepeatable (g05kcc).

3:     iseed[$4$] – IntegerCommunication Array

On entry: contains values which define the current state of the selected generator.

On exit: contains updated values defining the new state of the selected generator.

4:     fail – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_INTERNAL_ERROR

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.

NE_REAL

On entry, $\mathbf{p}<0.0$ or $\mathbf{p}>1.0$: $\mathbf{p}=〈\mathit{\text{value}}〉$.

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (g05kece.c)

9.2  Program Data

9.3  Program Results

Program Results (g05kece.r)