# NAG FL Interfaceg05phf (times_​arma)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

g05phf generates a realization of a univariate time series from an autoregressive moving average (ARMA) model. The realization may be continued or a new realization generated at subsequent calls to g05phf.

## 2Specification

Fortran Interface
 Subroutine g05phf ( mode, n, ip, phi, iq, avar, r, lr, var, x,
 Integer, Intent (In) :: mode, n, ip, iq, lr Integer, Intent (Inout) :: state(*), ifail Real (Kind=nag_wp), Intent (In) :: xmean, phi(ip), theta(iq), avar Real (Kind=nag_wp), Intent (Inout) :: r(lr) Real (Kind=nag_wp), Intent (Out) :: var, x(n)
#include <nag.h>
 void g05phf_ (const Integer *mode, const Integer *n, const double *xmean, const Integer *ip, const double phi[], const Integer *iq, const double theta[], const double *avar, double r[], const Integer *lr, Integer state[], double *var, double x[], Integer *ifail)
The routine may be called by the names g05phf or nagf_rand_times_arma.

## 3Description

Let the vector ${x}_{t}$, denote a time series which is assumed to follow an autoregressive moving average (ARMA) model of the form:
 $xt-μ= ϕ1(xt-1-μ)+ϕ2(xt-2-μ)+⋯+ϕp(xt-p-μ)+ εt-θ1εt-1-θ2εt-2-⋯-θqεt-q$
where ${\epsilon }_{t}$, is a residual series of independent random perturbations assumed to be Normally distributed with zero mean and variance ${\sigma }^{2}$. The parameters $\left\{{\varphi }_{i}\right\}$, for $\mathit{i}=1,2,\dots ,p$, are called the autoregressive (AR) parameters, and $\left\{{\theta }_{j}\right\}$, for $\mathit{j}=1,2,\dots ,q$, the moving average (MA) parameters. The parameters in the model are thus the $p$ $\varphi$ values, the $q$ $\theta$ values, the mean $\mu$ and the residual variance ${\sigma }^{2}$.
g05phf sets up a reference vector containing initial values corresponding to a stationary position using the method described in Tunnicliffe–Wilson (1979). The routine can then return a realization of ${x}_{1},{x}_{2},\dots ,{x}_{n}$. On a successful exit, the recent history is updated and saved in the reference vector r so that g05phf may be called again to generate a realization of ${x}_{n+1},{x}_{n+2},\dots$, etc. See the description of the argument mode in Section 5 for details.
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 g05phf.

## 4References

Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley
Tunnicliffe–Wilson G (1979) Some efficient computational procedures for high order ARMA models J. Statist. Comput. Simulation 8 301–309

## 5Arguments

1: $\mathbf{mode}$Integer Input
On entry: a code for selecting the operation to be performed by the routine.
${\mathbf{mode}}=0$
Set up reference vector only.
${\mathbf{mode}}=1$
Generate terms in the time series using reference vector set up in a prior call to g05phf.
${\mathbf{mode}}=2$
Set up reference vector and generate terms in the time series.
Constraint: ${\mathbf{mode}}=0$, $1$ or $2$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the number of observations to be generated.
Constraint: ${\mathbf{n}}\ge 0$.
3: $\mathbf{xmean}$Real (Kind=nag_wp) Input
On entry: the mean of the time series.
4: $\mathbf{ip}$Integer Input
On entry: $p$, the number of autoregressive coefficients supplied.
Constraint: ${\mathbf{ip}}\ge 0$.
5: $\mathbf{phi}\left({\mathbf{ip}}\right)$Real (Kind=nag_wp) array Input
On entry: the autoregressive coefficients of the model, ${\varphi }_{1},{\varphi }_{2},\dots ,{\varphi }_{p}$.
6: $\mathbf{iq}$Integer Input
On entry: $q$, the number of moving average coefficients supplied.
Constraint: ${\mathbf{iq}}\ge 0$.
7: $\mathbf{theta}\left({\mathbf{iq}}\right)$Real (Kind=nag_wp) array Input
On entry: the moving average coefficients of the model, ${\theta }_{1},{\theta }_{2},\dots ,{\theta }_{q}$.
8: $\mathbf{avar}$Real (Kind=nag_wp) Input
On entry: ${\sigma }^{2}$, the variance of the Normal perturbations.
Constraint: ${\mathbf{avar}}\ge 0.0$.
9: $\mathbf{r}\left({\mathbf{lr}}\right)$Real (Kind=nag_wp) array Communication Array
On entry: if ${\mathbf{mode}}=1$, the reference vector from the previous call to g05phf.
On exit: the reference vector.
10: $\mathbf{lr}$Integer Input
On entry: the dimension of the array r as declared in the (sub)program from which g05phf is called.
Constraint: ${\mathbf{lr}}\ge {\mathbf{ip}}+{\mathbf{iq}}+6+\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{ip}},{\mathbf{iq}}+1\right)$.
11: $\mathbf{state}\left(*\right)$Integer array Communication 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.
12: $\mathbf{var}$Real (Kind=nag_wp) Output
On exit: the proportion of the variance of a term in the series that is due to the moving-average (error) terms in the model. The smaller this is, the nearer is the model to non-stationarity.
13: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: contains the next $n$ observations from the time series.
14: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ 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{mode}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{mode}}=0$, $1$ or $2$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 0$.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{ip}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ip}}\ge 0$.
${\mathbf{ifail}}=5$
On entry, the AR parameters are outside the stationarity region.
${\mathbf{ifail}}=6$
On entry, ${\mathbf{iq}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{iq}}\ge 0$.
${\mathbf{ifail}}=8$
On entry, ${\mathbf{avar}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{avar}}\ge 0.0$.
${\mathbf{ifail}}=9$
ip or iq is not the same as when r was set up in a previous call.
Previous value of ${\mathbf{ip}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{ip}}=⟨\mathit{\text{value}}⟩$.
Previous value of ${\mathbf{iq}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{iq}}=⟨\mathit{\text{value}}⟩$.
Reference vector r has been corrupted or not initialized correctly.
${\mathbf{ifail}}=10$
On entry, lr is not large enough, ${\mathbf{lr}}=⟨\mathit{\text{value}}⟩$: minimum length required $\text{}=⟨\mathit{\text{value}}⟩$.
${\mathbf{ifail}}=11$
On entry, state vector has been corrupted or not initialized.
${\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

Any errors in the reference vector's initial values should be very much smaller than the error term; see Tunnicliffe–Wilson (1979).

## 8Parallelism and Performance

g05phf 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.

The time taken by g05phf is essentially of order ${\left({\mathbf{ip}}\right)}^{2}$.
Note:  The reference vector, r, contains a copy of the recent history of the series. If attempting to re-initialize the series by calling g05kff or g05kgf a call to g05phf with ${\mathbf{mode}}=0$ must also be made. In the repeatable case the calls to g05phf should be performed in the same order (at the same point(s) in simulation) every time g05kff is used. When the generator state is saved and restored using the argument state, the time series reference vector must be saved and restored as well.
The ARMA model for a time series can also be written as:
 $(xn-E) = A1 (xn-1-E) + ⋯ + ANA (xn-NA-E) + B1 an + ⋯ + BNB an-NB+1$
where
• ${x}_{n}$ is the observed value of the time series at time $n$,
• $\mathit{NA}$ is the number of autoregressive parameters, ${A}_{i}$,
• $\mathit{NB}$ is the number of moving average parameters, ${B}_{i}$,
• $E$ is the mean of the time series,
and
• ${a}_{t}$ is a series of independent random Standard Normal perturbations.
This is the form used in g05phf. This is related to the form given in Section 3 by:
• ${B}_{1}^{2}={\sigma }^{2}$,
• ${B}_{i+1}=-{\theta }_{i}\sigma =-{\theta }_{i}{B}_{1}\text{, }i=1,2,\dots ,q$,
• $\mathit{NB}=q+1$,
• $E=\mu$,
• ${A}_{i}={\varphi }_{i}\text{, }i=1,2,\dots ,p$,
• $\mathit{NA}=p$.

## 10Example

This example generates values for an autoregressive model given by
 $xt=0.4xt-1+0.2xt-2+εt$
where ${\epsilon }_{t}$ is a series of independent random Normal perturbations with variance $1.0$. The random number generators are initialized by g05kff and then g05phf is called to initialize a reference vector and generate a sample of ten observations.

### 10.1Program Text

Program Text (g05phfe.f90)

### 10.2Program Data

Program Data (g05phfe.d)

### 10.3Program Results

Program Results (g05phfe.r)