NAG FL Interface
g05zmf (field_1d_user_setup)
1
Purpose
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.
2
Specification
Fortran Interface
Subroutine g05zmf ( |
ns, xmin, xmax, maxm, var, cov1, pad, icorr, lam, xx, m, approx, rho, icount, eig, iuser, ruser, ifail) |
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 |
|
C Header Interface
#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) |
|
C++ Header Interface
#include <nag.h> extern "C" {
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.
3
Description
A one-dimensional random field in is a function which is random at every point , so is a random variable for each . The random field has a mean function and a symmetric positive semidefinite covariance function . is a Gaussian random field if for any choice of and , the random vector follows a multivariate Normal distribution, which would have a mean vector with entries and a covariance matrix with entries . A Gaussian random field is stationary if is constant for all and for all and hence we can express the covariance function as a function of one variable: . is known as a variogram (or more correctly, a semivariogram) and includes the multiplicative factor representing the variance such that .
The routines
g05zmf and
g05zpf are used to simulate a one-dimensional stationary Gaussian random field, with mean function zero and variogram
, over an interval
, using an equally spaced set of
points on the interval. The problem reduces to sampling a Normal random vector
of size
, with mean vector zero and a symmetric Toeplitz covariance matrix
. Since
is in general expensive to factorize, a technique known as the
circulant embedding method is used.
is embedded into a larger, symmetric circulant matrix
of size
, which can now be factorized as
, where
is the Fourier matrix (
is the complex conjugate of
),
is the diagonal matrix containing the eigenvalues of
and
.
is known as the embedding matrix. The eigenvalues can be calculated by performing a discrete Fourier transform of the first row (or column) of
and multiplying by
, and so only the first row (or column) of
is needed – the whole matrix does not need to be formed.
As long as all of the values of are non-negative (i.e., is positive semidefinite), is a covariance matrix for a random vector , two samples of which can now be simulated from the real and imaginary parts of , where and have elements from the standard Normal distribution. Since , this calculation can be done using a discrete Fourier transform of the vector . Two samples of the random vector can now be recovered by taking the first elements of each sample of – because the original covariance matrix is embedded in , will have the correct distribution.
If
is not positive semidefinite, larger embedding matrices
can be tried; however if the size of the matrix would have to be larger than
maxm, an approximation procedure is used. We write
, where
and
contain the non-negative and negative eigenvalues of
respectively. Then
is replaced by
where
and
is a scaling factor. The error
in approximating the distribution of the random field is given by
Three choices for
are available, and are determined by the input argument
icorr:
- setting sets
- setting sets
- setting sets .
g05zmf finds a suitable positive semidefinite embedding matrix
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
is actually formed and stored.
4
References
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 Journal of Computational and Graphical Statistics 3(4) 409–432
5
Arguments
-
1:
– Integer
Input
-
On entry: the number of sample points to be generated in realizations of the random field.
Constraint:
.
-
2:
– Real (Kind=nag_wp)
Input
-
On entry: the lower bound for the interval over which the random field is to be simulated.
Constraint:
.
-
3:
– Real (Kind=nag_wp)
Input
-
On entry: the upper bound for the interval over which the random field is to be simulated.
Constraint:
.
-
4:
– 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 where .
Suggested value:
.
Constraint:
, where is the smallest integer satisfying .
-
5:
– Real (Kind=nag_wp)
Input
-
On entry: the multiplicative factor of the variogram .
Constraint:
.
-
6:
– Subroutine, supplied by the user.
External Procedure
-
cov1 must evaluate the variogram
, without the multiplicative factor
, for all
. The value returned in
gamma is multiplied internally by
var.
The specification of
cov1 is:
Fortran Interface
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 |
|
C++ Header Interface
#include <nag.h> extern "C" {
}
|
-
1:
– Real (Kind=nag_wp)
Input
-
On entry: the value at which the variogram is to be evaluated.
-
2:
– Real (Kind=nag_wp)
Output
-
On exit: the value of the variogram .
-
3:
– Integer array
User Workspace
-
4:
– 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:
– 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.
- The embedding matrix is padded with zeros.
- The embedding matrix is padded with values of the variogram.
Suggested value:
.
Constraint:
or .
-
8:
– Integer
Input
-
On entry: determines which approximation to implement if required, as described in
Section 3.
Suggested value:
.
Constraint:
, or .
-
9:
– Real (Kind=nag_wp) array
Output
-
On exit: contains the square roots of the eigenvalues of the embedding matrix.
-
10:
– Real (Kind=nag_wp) array
Output
-
On exit: the points at which values of the random field will be output.
-
11:
– Integer
Output
-
On exit: the size of the embedding matrix.
-
12:
– Integer
Output
-
On exit: indicates whether approximation was used.
- No approximation was used.
- Approximation was used.
-
13:
– Real (Kind=nag_wp)
Output
-
On exit: indicates the scaling of the covariance matrix. unless approximation was used with or .
-
14:
– Integer
Output
-
On exit: indicates the number of negative eigenvalues in the embedding matrix which have had to be set to zero.
-
15:
– 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. contains the smallest eigenvalue, contains the sum of the squares of the negative eigenvalues, and contains the sum of the absolute values of the negative eigenvalues.
-
16:
– Integer array
User Workspace
-
17:
– 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:
– Integer
Input/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
On entry, .
Constraint: .
-
On entry, and .
Constraint: .
-
On entry,
.
Constraint: the minimum calculated value for
maxm is
.
Where the minimum calculated value is given by
, where
is the smallest integer satisfying
.
-
On entry, .
Constraint: .
-
On entry, .
Constraint: or .
-
On entry, .
Constraint: , or .
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 7 in the Introduction to the NAG Library FL Interface for further information.
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.
Dynamic memory allocation failed.
See
Section 9 in the Introduction to the NAG Library FL Interface for further information.
7
Accuracy
If on exit
, see the comments in
Section 3 regarding the quality of approximation; increase the value of
maxm to attempt to avoid approximation.
8
Parallelism 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.
10
Example
This example calls
g05zmf to calculate the eigenvalues of the embedding matrix for
sample points of a random field characterized by the symmetric stable variogram:
where
, and
and
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.1
Program Text
10.2
Program Data
10.3
Program Results