# NAG FL Interfaceg05zmf (field_​1d_​user_​setup)

## 1Purpose

g05zmf performs the setup required in order to simulate stationary Gaussian random fields in one dimension, for a user-defined variogram, using the circulant embedding method. Specifically, the eigenvalues of the extended covariance matrix (or embedding matrix) are calculated, and their square roots output, for use by g05zpf, which simulates the random field.

## 2Specification

Fortran Interface
 Subroutine g05zmf ( ns, xmin, xmax, maxm, var, cov1, pad, lam, xx, m, rho, eig,
 Integer, Intent (In) :: ns, maxm, pad, icorr Integer, Intent (Inout) :: iuser(*), ifail Integer, Intent (Out) :: m, approx, icount Real (Kind=nag_wp), Intent (In) :: xmin, xmax, var Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: lam(maxm), xx(ns), rho, eig(3) External :: cov1
#include <nag.h>
 void g05zmf_ (const Integer *ns, const double *xmin, const double *xmax, const Integer *maxm, const double *var, void (NAG_CALL *cov1)(const double *x, double *gamma, Integer iuser[], double ruser[]),const Integer *pad, const Integer *icorr, double lam[], double xx[], Integer *m, Integer *approx, double *rho, Integer *icount, double eig[], Integer iuser[], double ruser[], Integer *ifail)
The routine may be called by the names g05zmf or nagf_rand_field_1d_user_setup.

## 3Description

A one-dimensional random field $Z\left(x\right)$ in $ℝ$ is a function which is random at every point $x\in ℝ$, so $Z\left(x\right)$ is a random variable for each $x$. The random field has a mean function $\mu \left(x\right)=𝔼\left[Z\left(x\right)\right]$ and a symmetric positive semidefinite covariance function $C\left(x,y\right)=𝔼\left[\left(Z\left(x\right)-\mu \left(x\right)\right)\left(Z\left(y\right)-\mu \left(y\right)\right)\right]$. $Z\left(x\right)$ is a Gaussian random field if for any choice of $n\in ℕ$ and ${x}_{1},\dots ,{x}_{n}\in ℝ$, the random vector ${\left[Z\left({x}_{1}\right),\dots ,Z\left({x}_{n}\right)\right]}^{\mathrm{T}}$ follows a multivariate Normal distribution, which would have a mean vector $\stackrel{~}{\mathbf{\mu }}$ with entries ${\stackrel{~}{\mu }}_{i}=\mu \left({x}_{i}\right)$ and a covariance matrix $\stackrel{~}{C}$ with entries ${\stackrel{~}{C}}_{ij}=C\left({x}_{i},{x}_{j}\right)$. A Gaussian random field $Z\left(x\right)$ is stationary if $\mu \left(x\right)$ is constant for all $x\in ℝ$ and $C\left(x,y\right)=C\left(x+a,y+a\right)$ for all $x,y,a\in ℝ$ and hence we can express the covariance function $C\left(x,y\right)$ as a function $\gamma$ of one variable: $C\left(x,y\right)=\gamma \left(x-y\right)$. $\gamma$ is known as a variogram (or more correctly, a semivariogram) and includes the multiplicative factor ${\sigma }^{2}$ representing the variance such that $\gamma \left(0\right)={\sigma }^{2}$.
The routines g05zmf and g05zpf are used to simulate a one-dimensional stationary Gaussian random field, with mean function zero and variogram $\gamma \left(x\right)$, over an interval $\left[{x}_{\mathrm{min}},{x}_{\mathrm{max}}\right]$, using an equally spaced set of $N$ points on the interval. The problem reduces to sampling a Normal random vector $\mathbf{X}$ of size $N$, with mean vector zero and a symmetric Toeplitz covariance matrix $A$. Since $A$ is in general expensive to factorize, a technique known as the circulant embedding method is used. $A$ is embedded into a larger, symmetric circulant matrix $B$ of size $M\ge 2\left(N-1\right)$, which can now be factorized as $B=W\Lambda {W}^{*}={R}^{*}R$, where $W$ is the Fourier matrix (${W}^{*}$ is the complex conjugate of $W$), $\Lambda$ is the diagonal matrix containing the eigenvalues of $B$ and $R={\Lambda }^{\frac{1}{2}}{W}^{*}$. $B$ is known as the embedding matrix. The eigenvalues can be calculated by performing a discrete Fourier transform of the first row (or column) of $B$ and multiplying by $M$, and so only the first row (or column) of $B$ is needed – the whole matrix does not need to be formed.
As long as all of the values of $\Lambda$ are non-negative (i.e., $B$ is positive semidefinite), $B$ is a covariance matrix for a random vector $\mathbf{Y}$, two samples of which can now be simulated from the real and imaginary parts of ${R}^{*}\left(\mathbf{U}+i\mathbf{V}\right)$, where $\mathbf{U}$ and $\mathbf{V}$ have elements from the standard Normal distribution. Since ${R}^{*}\left(\mathbf{U}+i\mathbf{V}\right)=W{\Lambda }^{\frac{1}{2}}\left(\mathbf{U}+i\mathbf{V}\right)$, this calculation can be done using a discrete Fourier transform of the vector ${\Lambda }^{\frac{1}{2}}\left(\mathbf{U}+i\mathbf{V}\right)$. Two samples of the random vector $\mathbf{X}$ can now be recovered by taking the first $N$ elements of each sample of $\mathbf{Y}$ – because the original covariance matrix $A$ is embedded in $B$, $\mathbf{X}$ will have the correct distribution.
If $B$ is not positive semidefinite, larger embedding matrices $B$ can be tried; however if the size of the matrix would have to be larger than maxm, an approximation procedure is used. We write $\Lambda ={\Lambda }_{+}+{\Lambda }_{-}$, where ${\Lambda }_{+}$ and ${\Lambda }_{-}$ contain the non-negative and negative eigenvalues of $B$ respectively. Then $B$ is replaced by $\rho {B}_{+}$ where ${B}_{+}=W{\Lambda }_{+}{W}^{*}$ and $\rho \in \left(0,1\right]$ is a scaling factor. The error $\epsilon$ in approximating the distribution of the random field is given by
 $ε= 1-ρ 2 trace⁡Λ + ρ2 trace⁡Λ- M .$
Three choices for $\rho$ are available, and are determined by the input argument icorr:
• setting ${\mathbf{icorr}}=0$ sets
 $ρ= trace⁡Λ trace⁡Λ+ ,$
• setting ${\mathbf{icorr}}=1$ sets
 $ρ= trace⁡Λ trace⁡Λ+ ,$
• setting ${\mathbf{icorr}}=2$ sets $\rho =1$.
g05zmf finds a suitable positive semidefinite embedding matrix $B$ and outputs its size, m, and the square roots of its eigenvalues in lam. If approximation is used, information regarding the accuracy of the approximation is output. Note that only the first row (or column) of $B$ is actually formed and stored.

## 4References

Dietrich C R and Newsam G N (1997) Fast and exact simulation of stationary Gaussian processes through circulant embedding of the covariance matrix SIAM J. Sci. Comput. 18 1088–1107
Schlather M (1999) Introduction to positive definite functions and to unconditional simulation of random fields Technical Report ST 99–10 Lancaster University
Wood A T A and Chan G (1994) Simulation of stationary Gaussian processes in ${\left[0,1\right]}^{d}$ Journal of Computational and Graphical Statistics 3(4) 409–432

## 5Arguments

1: $\mathbf{ns}$Integer Input
On entry: the number of sample points to be generated in realizations of the random field.
Constraint: ${\mathbf{ns}}\ge 1$.
2: $\mathbf{xmin}$Real (Kind=nag_wp) Input
On entry: the lower bound for the interval over which the random field is to be simulated.
Constraint: ${\mathbf{xmin}}<{\mathbf{xmax}}$.
3: $\mathbf{xmax}$Real (Kind=nag_wp) Input
On entry: the upper bound for the interval over which the random field is to be simulated.
Constraint: ${\mathbf{xmin}}<{\mathbf{xmax}}$.
4: $\mathbf{maxm}$Integer Input
On entry: the maximum size of the circulant matrix to use. For example, if the embedding matrix is to be allowed to double in size three times before the approximation procedure is used, then choose ${\mathbf{maxm}}={2}^{k+2}$ where $k=1+⌈{\mathrm{log}}_{2}\left({\mathbf{ns}}-1\right)⌉$.
Suggested value: ${2}^{k+2}\text{​ where ​}k=1+⌈{\mathrm{log}}_{2}\left({\mathbf{ns}}-1\right)⌉$.
Constraint: ${\mathbf{maxm}}\ge {2}^{k}$, where $k$ is the smallest integer satisfying ${2}^{k}\ge 2\left({\mathbf{ns}}-1\right)$.
5: $\mathbf{var}$Real (Kind=nag_wp) Input
On entry: the multiplicative factor ${\sigma }^{2}$ of the variogram $\gamma \left(x\right)$.
Constraint: ${\mathbf{var}}\ge 0.0$.
6: $\mathbf{cov1}$Subroutine, supplied by the user. External Procedure
cov1 must evaluate the variogram $\gamma \left(x\right)$, without the multiplicative factor ${\sigma }^{2}$, for all $x\ge 0$. The value returned in gamma is multiplied internally by var.
The specification of cov1 is:
Fortran Interface
 Subroutine cov1 ( x,
 Integer, Intent (Inout) :: iuser(*) Real (Kind=nag_wp), Intent (In) :: x Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: gamma
 void cov1_ (const double *x, double *gamma, Integer iuser[], double ruser[])
1: $\mathbf{x}$Real (Kind=nag_wp) Input
On entry: the value $x$ at which the variogram $\gamma \left(x\right)$ is to be evaluated.
2: $\mathbf{gamma}$Real (Kind=nag_wp) Output
On exit: the value of the variogram $\frac{\gamma \left(x\right)}{{\sigma }^{2}}$.
3: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
4: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
cov1 is called with the arguments iuser and ruser as supplied to g05zmf. You should use the arrays iuser and ruser to supply information to cov1.
cov1 must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which g05zmf is called. Arguments denoted as Input must not be changed by this procedure.
Note: cov1 should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by g05zmf. If your code inadvertently does return any NaNs or infinities, g05zmf is likely to produce unexpected results.
7: $\mathbf{pad}$Integer Input
On entry: determines whether the embedding matrix is padded with zeros, or padded with values of the variogram. The choice of padding may affect how big the embedding matrix must be in order to be positive semidefinite.
${\mathbf{pad}}=0$
The embedding matrix is padded with zeros.
${\mathbf{pad}}=1$
The embedding matrix is padded with values of the variogram.
Suggested value: ${\mathbf{pad}}=1$.
Constraint: ${\mathbf{pad}}=0$ or $1$.
8: $\mathbf{icorr}$Integer Input
On entry: determines which approximation to implement if required, as described in Section 3.
Suggested value: ${\mathbf{icorr}}=0$.
Constraint: ${\mathbf{icorr}}=0$, $1$ or $2$.
9: $\mathbf{lam}\left({\mathbf{maxm}}\right)$Real (Kind=nag_wp) array Output
On exit: contains the square roots of the eigenvalues of the embedding matrix.
10: $\mathbf{xx}\left({\mathbf{ns}}\right)$Real (Kind=nag_wp) array Output
On exit: the points at which values of the random field will be output.
11: $\mathbf{m}$Integer Output
On exit: the size of the embedding matrix.
12: $\mathbf{approx}$Integer Output
On exit: indicates whether approximation was used.
${\mathbf{approx}}=0$
No approximation was used.
${\mathbf{approx}}=1$
Approximation was used.
13: $\mathbf{rho}$Real (Kind=nag_wp) Output
On exit: indicates the scaling of the covariance matrix. ${\mathbf{rho}}=1.0$ unless approximation was used with ${\mathbf{icorr}}=0$ or $1$.
14: $\mathbf{icount}$Integer Output
On exit: indicates the number of negative eigenvalues in the embedding matrix which have had to be set to zero.
15: $\mathbf{eig}\left(3\right)$Real (Kind=nag_wp) array Output
On exit: indicates information about the negative eigenvalues in the embedding matrix which have had to be set to zero. ${\mathbf{eig}}\left(1\right)$ contains the smallest eigenvalue, ${\mathbf{eig}}\left(2\right)$ contains the sum of the squares of the negative eigenvalues, and ${\mathbf{eig}}\left(3\right)$ contains the sum of the absolute values of the negative eigenvalues.
16: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
17: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
iuser and ruser are not used by g05zmf, but are passed directly to cov1 and may be used to pass information to this routine.
18: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, . If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value 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 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{ns}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ns}}\ge 1$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{xmin}}=〈\mathit{\text{value}}〉$ and ${\mathbf{xmax}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{xmin}}<{\mathbf{xmax}}$.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{maxm}}=〈\mathit{\text{value}}〉$.
Constraint: the minimum calculated value for maxm is $〈\mathit{\text{value}}〉$.
Where the minimum calculated value is given by ${2}^{k}$, where $k$ is the smallest integer satisfying ${2}^{k}\ge 2\left({\mathbf{ns}}-1\right)$.
${\mathbf{ifail}}=5$
On entry, ${\mathbf{var}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{var}}\ge 0.0$.
${\mathbf{ifail}}=7$
On entry, ${\mathbf{pad}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{pad}}=0$ or $1$.
${\mathbf{ifail}}=8$
On entry, ${\mathbf{icorr}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{icorr}}=0$, $1$ or $2$.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

If on exit ${\mathbf{approx}}=1$, see the comments in Section 3 regarding the quality of approximation; increase the value of maxm to attempt to avoid approximation.

## 8Parallelism and Performance

g05zmf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g05zmf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
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 calls g05zmf to calculate the eigenvalues of the embedding matrix for $8$ sample points of a random field characterized by the symmetric stable variogram:
 $γx = σ2 exp - x′ ν ,$
where ${x}^{\prime }=\frac{x}{\ell }$, and $\ell$ and $\nu$ are parameters.
It should be noted that the symmetric stable variogram is one of the pre-defined variograms available in g05znf. It is used here purely for illustrative purposes.

### 10.1Program Text

Program Text (g05zmfe.f90)

### 10.2Program Data

Program Data (g05zmfe.d)

### 10.3Program Results

Program Results (g05zmfe.r)