Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_rand_int_uniform (g05tl)

## Purpose

nag_rand_int_uniform (g05tl) generates a vector of pseudorandom integers uniformly distributed over the interval $\left[a,b\right]$.

## Syntax

[state, x, ifail] = g05tl(n, a, b, state)
[state, x, ifail] = nag_rand_int_uniform(n, a, b, state)

## Description

nag_rand_int_uniform (g05tl) generates the next $n$ values ${y}_{i}$ from a uniform $\left(0,1\right]$ generator (see nag_rand_dist_uniform01 (g05sa) for details) and applies the transformation
 $xi = a+ b-a+1 yi ,$
where $⌊z⌋$ is the integer part of the real value $z$. The function ensures that the values ${x}_{i}$ lie in the closed interval $\left[a,b\right]$.
One of the initialization functions nag_rand_init_repeat (g05kf) (for a repeatable sequence if computed sequentially) or nag_rand_init_nonrepeat (g05kg) (for a non-repeatable sequence) must be called prior to the first call to nag_rand_int_uniform (g05tl).

## References

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

## Parameters

### Compulsory Input Parameters

1:     $\mathrm{n}$int64int32nag_int scalar
$n$, the number of pseudorandom numbers to be generated.
Constraint: ${\mathbf{n}}\ge 0$.
2:     $\mathrm{a}$int64int32nag_int scalar
3:     $\mathrm{b}$int64int32nag_int scalar
The end points $a$ and $b$ of the uniform distribution.
Constraint: ${\mathbf{a}}\le {\mathbf{b}}$.
4:     $\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.

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)$int64int32nag_int array
The $n$ pseudorandom numbers from the specified uniform distribution.
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

Errors or warnings detected by the function:
${\mathbf{ifail}}=1$
Constraint: ${\mathbf{n}}\ge 0$.
${\mathbf{ifail}}=3$
Constraint: ${\mathbf{b}}\ge {\mathbf{a}}$.
${\mathbf{ifail}}=4$
On entry, state vector has been corrupted or not initialized.
${\mathbf{ifail}}=-99$
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.

Not applicable.

None.

## Example

This example prints five pseudorandom integers from a discrete uniform distribution between $-5$ and $5$, generated by a single call to nag_rand_int_uniform (g05tl), after initialization by nag_rand_init_repeat (g05kf).
```function g05tl_example

fprintf('g05tl 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(5);

% Parameters
a = int64(-5);
b = int64(5);

% Generate integer variates from Uniform (a,b) distribution
[state, x, ifail] = g05tl( ...
n, a, b, state);

disp('Variates');
disp(double(x));

```
```g05tl example results

Variates
2
-4
3
3
-4

```