G05SPF (PDF version)
G05 Chapter Contents
G05 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentG05SPF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

G05SPF generates a vector of pseudorandom numbers from a triangular distribution with parameters ${x}_{\mathrm{min}}$, ${x}_{\mathrm{med}}$ and ${x}_{\mathrm{max}}$.

## 2  Specification

 SUBROUTINE G05SPF ( N, XMIN, XMED, XMAX, STATE, X, IFAIL)
 INTEGER N, STATE(*), IFAIL REAL (KIND=nag_wp) XMIN, XMED, XMAX, X(N)

## 3  Description

The triangular distribution has a PDF (probability density function) that is triangular in profile. The base of the triangle ranges from $x={x}_{\mathrm{min}}$ to $x={x}_{\mathrm{max}}$ and the PDF has a maximum value of $\frac{2}{{x}_{\mathrm{max}}-{x}_{\mathrm{min}}}$ at $x={x}_{\mathrm{med}}$. If ${x}_{\mathrm{min}}={x}_{\mathrm{med}}={x}_{\mathrm{max}}$ then $x={x}_{\mathrm{med}}$ with probability 1; otherwise the triangular distribution has PDF:
 $fx = x-xmin xmed-xmin × 2 xmax-xmin ​ if ​xmin≤x≤xmed, fx= xmax-x xmax-xmed ×2xmax-xmin ​ if ​xmed
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 G05SPF.

## 4  References

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

## 5  Parameters

1:     N – INTEGERInput
On entry: $n$, the number of pseudorandom numbers to be generated.
Constraint: ${\mathbf{N}}\ge 0$.
2:     XMIN – REAL (KIND=nag_wp)Input
On entry: the end point ${x}_{\mathrm{min}}$ of the triangular distribution.
3:     XMED – REAL (KIND=nag_wp)Input
On entry: the median of the distribution ${x}_{\mathrm{med}}$ (also the location of the vertex of the triangular distribution at which the PDF reaches a maximum).
Constraint: ${\mathbf{XMED}}\ge {\mathbf{XMIN}}$.
4:     XMAX – REAL (KIND=nag_wp)Input
On entry: the end point ${x}_{\mathrm{max}}$ of the triangular distribution.
Constraint: ${\mathbf{XMAX}}\ge {\mathbf{XMED}}$.
5:     STATE($*$) – INTEGER arrayCommunication 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.
6:     X(N) – REAL (KIND=nag_wp) arrayOutput
On exit: the $n$ pseudorandom numbers from the specified triangular distribution.
7:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ or ​}1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ or ​}\mathbf{1}$ 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).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{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}}<0$.
${\mathbf{IFAIL}}=3$
On entry, ${\mathbf{XMED}}<{\mathbf{XMIN}}$.
${\mathbf{IFAIL}}=4$
On entry, ${\mathbf{XMAX}}<{\mathbf{XMED}}$.
${\mathbf{IFAIL}}=5$
 On entry, STATE vector was not initialized or has been corrupted.

Not applicable.

None.

## 9  Example

This example prints five pseudorandom numbers from a triangular distribution with parameters ${x}_{\mathrm{min}}=-1.0$, ${x}_{\mathrm{med}}=0.5$ and ${x}_{\mathrm{max}}=1.0$, generated by a single call to G05SPF, after initialization by G05KFF.

### 9.1  Program Text

Program Text (g05spfe.f90)

### 9.2  Program Data

Program Data (g05spfe.d)

### 9.3  Program Results

Program Results (g05spfe.r)

G05SPF (PDF version)
G05 Chapter Contents
G05 Chapter Introduction
NAG Library Manual