# NAG Library Routine Document

## 1Purpose

g05smf generates a vector of pseudorandom numbers from a log-normal distribution with parameters $\mu$ and ${\sigma }^{2}$.

## 2Specification

Fortran Interface
 Subroutine g05smf ( n, xmu, var, x,
 Integer, Intent (In) :: n Integer, Intent (Inout) :: state(*), ifail Real (Kind=nag_wp), Intent (In) :: xmu, var Real (Kind=nag_wp), Intent (Out) :: x(n)
#include nagmk26.h
 void g05smf_ (const Integer *n, const double *xmu, const double *var, Integer state[], double x[], Integer *ifail)

## 3Description

The distribution has PDF (probability density function)
 $fx = 1 xσ⁢2π exp - ln⁡x-μ 2 2σ2 if ​ x>0 , fx=0 otherwise,$
i.e., $\mathrm{ln}x$ is normally distributed with mean $\mu$ and variance ${\sigma }^{2}$. g05smf evaluates $\mathrm{exp}{y}_{i}$, where the ${y}_{i}$ are generated by g05skf from a Normal distribution with mean $\mu$ and variance ${\sigma }^{2}$, for $\mathit{i}=1,2,\dots ,n$.
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 g05smf.

## 4References

Kendall M G and Stuart A (1969) The Advanced Theory of Statistics (Volume 1) (3rd Edition) Griffin
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{xmu}$ – Real (Kind=nag_wp)Input
On entry: $\mu$, the mean of the distribution of $\mathrm{ln}x$.
3:     $\mathbf{var}$ – Real (Kind=nag_wp)Input
On entry: ${\sigma }^{2}$, the variance of the distribution of $\mathrm{ln}x$.
Constraint: ${\mathbf{var}}\ge 0.0$.
4:     $\mathbf{state}\left(*\right)$ – 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.
5:     $\mathbf{x}\left({\mathbf{n}}\right)$ – Real (Kind=nag_wp) arrayOutput
On exit: the $n$ pseudorandom numbers from the specified log-normal distribution.
6:     $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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).

## 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, xmu is too large to take the exponential of ${\mathbf{xmu}}=〈\mathit{\text{value}}〉$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{var}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{var}}\ge 0.0$.
${\mathbf{ifail}}=4$
On entry, state vector has been corrupted or not initialized.
${\mathbf{ifail}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

Not applicable.

## 8Parallelism and Performance

g05smf 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 five pseudorandom numbers from a log-normal distribution with mean $1.0$ and variance $2.0$, generated by a single call to g05smf, after initialization by g05kff.

### 10.1Program Text

Program Text (g05smfe.f90)

### 10.2Program Data

Program Data (g05smfe.d)

### 10.3Program Results

Program Results (g05smfe.r)

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