NAG Library Function Document

1Purpose

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

2Specification

 #include #include
 void nag_rand_triangular (Integer n, double xmin, double xmed, double xmax, Integer state[], double x[], NagError *fail)

3Description

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 functions nag_rand_init_repeatable (g05kfc) (for a repeatable sequence if computed sequentially) or nag_rand_init_nonrepeatable (g05kgc) (for a non-repeatable sequence) must be called prior to the first call to nag_rand_triangular (g05spc).

4References

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

5Arguments

1:    $\mathbf{n}$IntegerInput
On entry: $n$, the number of pseudorandom numbers to be generated.
Constraint: ${\mathbf{n}}\ge 0$.
2:    $\mathbf{xmin}$doubleInput
On entry: the end point ${x}_{\mathrm{min}}$ of the triangular distribution.
3:    $\mathbf{xmed}$doubleInput
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:    $\mathbf{xmax}$doubleInput
On entry: the end point ${x}_{\mathrm{max}}$ of the triangular distribution.
Constraint: ${\mathbf{xmax}}\ge {\mathbf{xmed}}$.
5:    $\mathbf{state}\left[\mathit{dim}\right]$IntegerCommunication Array
Note: the dimension, $\mathit{dim}$, of this array is dictated by the requirements of associated functions that must have been previously called. This array MUST be the same array passed as argument state in the previous call to nag_rand_init_repeatable (g05kfc) or nag_rand_init_nonrepeatable (g05kgc).
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:    $\mathbf{x}\left[{\mathbf{n}}\right]$doubleOutput
On exit: the $n$ pseudorandom numbers from the specified triangular distribution.
7:    $\mathbf{fail}$NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
NE_INT
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 0$.
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.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_INVALID_STATE
On entry, state vector has been corrupted or not initialized.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
NE_REAL_2
On entry, ${\mathbf{xmax}}=〈\mathit{\text{value}}〉$ and ${\mathbf{xmed}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{xmax}}\ge {\mathbf{xmed}}$.
On entry, ${\mathbf{xmed}}=〈\mathit{\text{value}}〉$ and ${\mathbf{xmin}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{xmed}}\ge {\mathbf{xmin}}$.

Not applicable.

8Parallelism and Performance

nag_rand_triangular (g05spc) 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

None.

10Example

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 nag_rand_triangular (g05spc), after initialization by nag_rand_init_repeatable (g05kfc).

10.1Program Text

Program Text (g05spce.c)

None.

10.3Program Results

Program Results (g05spce.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017