NAG Library Routine Document
g13bef (multi_inputmod_estim)
1
Purpose
g13bef fits a multiinput model relating one output series to the input series with a choice of three different estimation criteria: nonlinear least squares, exact likelihood and marginal likelihood. When no input series are present, g13bef fits a univariate ARIMA model.
2
Specification
Fortran Interface
Subroutine g13bef ( 
mr, nser, mt, para, npara, kfc, nxxy, xxy, ldxxy, kef, nit, kzsp, zsp, itc, sd, cm, ldcm, s, d, ndf, kzef, res, sttf, isttf, nsttf, wa, iwa, mwa, imwa, kpriv, ifail) 
Integer, Intent (In)  ::  mr(7), nser, mt(4,nser), npara, kfc, nxxy, ldxxy, kef, nit, kzsp, ldcm, kzef, isttf, iwa, imwa, kpriv  Integer, Intent (Inout)  ::  ifail  Integer, Intent (Out)  ::  itc, ndf, nsttf, mwa(imwa)  Real (Kind=nag_wp), Intent (Inout)  ::  para(npara), xxy(ldxxy,nser), zsp(4), cm(ldcm,npara)  Real (Kind=nag_wp), Intent (Out)  ::  sd(npara), s, d, res(nxxy), sttf(isttf), wa(iwa) 

C Header Interface
#include nagmk26.h
void 
g13bef_ (const Integer mr[], const Integer *nser, const Integer mt[], double para[], const Integer *npara, const Integer *kfc, const Integer *nxxy, double xxy[], const Integer *ldxxy, const Integer *kef, const Integer *nit, const Integer *kzsp, double zsp[], Integer *itc, double sd[], double cm[], const Integer *ldcm, double *s, double *d, Integer *ndf, const Integer *kzef, double res[], double sttf[], const Integer *isttf, Integer *nsttf, double wa[], const Integer *iwa, Integer mwa[], const Integer *imwa, const Integer *kpriv, Integer *ifail) 

3
Description
The output series ${y}_{\mathit{t}}$, for $\mathit{t}=1,2,\dots ,n$, is assumed to be the sum of (unobserved) components ${z}_{i,t}$ which are due respectively to the inputs ${x}_{\mathit{i},t}$, for $\mathit{i}=1,2,\dots ,m$.
Thus ${y}_{t}={z}_{1,t}+\cdots +{z}_{m,t}+{n}_{t}$ where ${n}_{t}$ is the error, or output noise component.
A typical component
${z}_{t}$ may be either
(a) 
a simple regression component, ${z}_{t}=\omega {x}_{t}$ (here ${x}_{t}$ is called a simple input), or 
(b) 
a transfer function model component which allows for the effect of lagged values of the variable, related to ${x}_{t}$ by

The noise
${n}_{t}$ is assumed to follow a (possibly seasonal) ARIMA model, i.e., may be represented in terms of an uncorrelated series,
${a}_{t}$, by the hierarchy of equations
(i) 
${\nabla}^{d}{\nabla}_{s}^{D}{n}_{t}=c+{w}_{t}$ 
(ii) 
${w}_{t}={\Phi}_{1}{w}_{ts}+{\Phi}_{2}{w}_{t2\times s}+\cdots +{\Phi}_{P}{w}_{tP\times s}+{e}_{t}{\Theta}_{1}{e}_{ts}{\Theta}_{2}{e}_{t2\times s}\cdots {\Theta}_{Q}{e}_{tQ\times s}$ 
(iii) 
${e}_{t}={\varphi}_{1}{e}_{t1}+{\varphi}_{2}{e}_{t2}+\cdots +{\varphi}_{p}{e}_{tp}+{a}_{t}{\theta}_{1}{a}_{t1}{\theta}_{2}{a}_{t2}\cdots {\theta}_{q}{a}_{tq}$ 
as outlined in
Section 3 in
g13aef.
Note: the orders $p,q$ appearing in each of the transfer function models and the ARIMA model are not necessarily the same; ${\nabla}^{d}{\nabla}_{s}^{D}{n}_{t}$ is the result of applying nonseasonal differencing of order $d$ and seasonal differencing of seasonality $s$ and order $D$ to the series ${n}_{t}$: the differenced series is then of length $N=nds\times D$; the constant term parameter $c$ may optionally be held fixed at its initial value (usually, but not necessarily zero) rather than being estimated.
For the purpose of defining an estimation criterion it is assumed that the series ${a}_{t}$ is a sequence of independent Normal variates having mean $0$ and variance ${\sigma}_{a}^{2}$. An allowance has to be made for the effects of unobserved data prior to the observation period. For the noise component an allowance is always made using a form of backforecasting.
For each transfer function input, you have to decide what values are to be assumed for the preperiod terms ${z}_{0},{z}_{1},\dots ,{z}_{1p}$ and ${x}_{0},{x}_{1},\dots ,{x}_{1bq}$ which are in theory necessary to recreate the component series ${z}_{1},{z}_{2},\dots ,{z}_{n}$, during the estimation procedure.
The first choice is to assume that all these values are zero. In this case, in order to avoid undesirable transient distortion of the early values ${z}_{1},{z}_{2},\dots \text{}$, you are advised first to correct the input series ${x}_{t}$ by subtracting from all the terms a suitable constant to make the early values ${x}_{1},{x}_{2},\dots \text{}$, close to zero. The series mean $\stackrel{}{x}$ is one possibility, but for a series with strong trend the constant might be simply ${x}_{1}$.
The second choice is to treat the unknown preperiod terms as nuisance parameters and estimate them along with the other parameters. This choice should be used with caution. For example, if $p=1$ and $b=q=0$, it is equivalent to fitting to the data a decaying geometric curve of the form $A{\delta}^{\mathit{t}}$, for $\mathit{t}=1,2,\dots $, along with the other inputs, this being the form of the transient. If the output ${y}_{t}$ contains a strong trend of this form, which is not otherwise represented in the model, it will have a tendency to influence the estimate of $\delta $ away from the value appropriate to the transfer function model.
In most applications the first choice should be adequate, with the option possibly being used as a refinement at the end of the modelling process. The number of nuisance parameters is then $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(p,b+q\right)$, with a corresponding loss of degrees of freedom in the residuals. If you align the input ${x}_{t}$ with the output by using in its place the shifted series ${x}_{tb}$, then setting $b=0$ in the transfer function model, there is some improvement in efficiency. On some occasions when the model contains two or more inputs, each with estimation of preperiod nuisance parameters, these parameters may be colinear and lead to failure of the routine. The option must then be ‘switched off’ for one or more inputs.
3.2
The Estimation Criterion
This is a measure of how well a proposed set of parameters in the transfer function and noise ARIMA models matches the data. The estimation routine searches for parameter values which minimize this criterion. For a proposed set of parameter values it is derived by calculating
(i) 
the components ${z}_{1,t},{z}_{2,t},\dots ,{z}_{m,t}$ as the responses to the input series ${x}_{1,t},{x}_{2,t}\dots ,{x}_{m,t}$ using the equations (a) or (b) above, 
(ii) 
the discrepancy between the output and the sum of these components, as the noise

(iii) 
the residual series ${a}_{t}$ from ${n}_{t}$ by reversing the recursive equations (i), (ii) and (iii) above. 
This last step again requires treatment of the effect of unknown preperiod values of
${n}_{t}$ and other terms in the equations regenerating
${a}_{t}$.
This is identical to the treatment given in
Section 3 in
g13aef, and leads to a criterion which is a sum of squares function
$S$, of the residuals
${a}_{t}$.
It may be shown that the finite algorithm presented there is equivalent to taking the infinite set of past values
${n}_{0},{n}_{1},{n}_{2},\dots $, as (linear) nuisance parameters.
There is no loss of degrees of freedom however, because the sum of squares function
$S$ may be expressed as including the corresponding set of past residuals; see page 273 of
Box and Jenkins (1976), who prove that
The function $D=S$ is the first of the three possible criteria, and is quite adequate for moderate to long series with no seasonal parameters. The second is the exact likelihood criterion which considers the past set ${n}_{0},{n}_{1},{n}_{2}$ not as simple nuisance parameters, but as unobserved random variables with known distribution. Calculation of the likelihood of the observed set ${n}_{1},{n}_{2},\dots ,{n}_{n}$ requires theoretical integration over the range of the past set. Fortunately this yields a criterion of the form $D=M\times S$ (whose minimization is equivalent to maximizing the exact likelihood of the data), where $S$ is exactly as before, and the multiplier $M$ is a function calculated from the ARIMA model parameters. The value of $M$ is always $\text{}\ge 1$, and $M$ tends to $1$ for any fixed parameter set as the sample size $n$ tends to $\infty $. There is a moderate computational overhead in using this option, but its use avoids appreciable bias in the ARIMA model parameters and yields a better conditioned estimation problem.
The third criterion of marginal likelihood treats the coefficients of the simple inputs in a manner analogous to that given to the past set ${n}_{0},{n}_{1},{n}_{2},\dots \text{}$. These coefficients, together with the constant term $c$ used to represent the mean of ${w}_{t}$, are in effect treated as random variables with highly dispersed distributions. This leads to the criterion $D=M\times S$ again, but with a different value of $M$ which now depends on the simple input series values ${x}_{t}$. In the presence of a moderate to large number of simple inputs, the marginal likelihood criterion can counteract bias in the ARIMA model parameters which is caused by estimation of the simple inputs. This is particularly important in relatively short series.
g13bef can be used with no input series present, to estimate a univariate ARIMA model for the output alone. The marginal likelihood criterion is then distinct from exact likelihood only if a constant term is being estimated in the model, because this is treated as an implicit simple input.
3.3
The Estimation Procedure
This is the minimization of the estimation criterion or objective function
$D$ (for deviance). The routine uses an extension of the algorithm of
Marquardt (1963). The step size in the minimization is inversely related to a parameter
$\alpha $, which is increased or decreased by a factor
$\beta $ at successive iterations, depending on the progress of the minimization. Convergence is deemed to have occurred if the fractional reduction of
$D$ in successive iterations is less than a value
$\gamma $, while
$\alpha <1$.
Certain model parameters (in fact all excluding the $\omega $s) are subject to stability constraints which are checked throughout to within a specified tolerance multiple $\delta $ of machine accuracy. Using the least squares criterion, the minimization may halt prematurely when some parameters ‘stick’ at a constraint boundary. This can happen particularly with short seasonal series (with a small number of whole seasons). It will not happen using the exact likelihood criterion, although convergence to a point on the boundary may sometimes be rather slow, because the criterion function may be very flat in such a region. There is also a smaller risk of a premature halt at a constraint boundary when marginal likelihood is used.
A positive, or zero number of iterations can be specified. In either case, the value $D$ of the objective function at iteration zero is presented at the initial parameter values, except for estimation of any preperiod terms for the input series, backforecasts for the noise series, and the coefficients of any simple inputs, and the constant term (unless this is held fixed).
At any later iteration, the value of $D$ is computed after reestimation of the backforecasts to their optimal values, corresponding to the model parameters presented at that iteration. This is not true for any preperiod terms for the input series which, although they are updated from the previous iteration, may not be precisely optimal for the parameter values presented, unless convergence of those parameters has occurred. However, in the case of marginal likelihood being specified, the coefficients of the simple inputs and the constant term are also reestimated together with the backforecasts at each iteration, to values which are optimal for the other parameter values presented.
3.4
Further Results
The residual variance is taken as $\mathit{erv}=\frac{S}{\mathit{df}}$, where $\mathit{df}=N\text{}$(total number of parameters estimated), is the residual degrees of freedom.
The preperiod nuisance parameters for the input series are included in the reduction of $\mathit{df}$, as is the constant if it is estimated.
The covariance matrix of the vector of model parameter estimates is given by
where
$H$ is the linearized least squares matrix taken from the final iteration of the algorithm of Marquardt. From this expression are derived the vector of standard deviations, and the correlation matrix of parameter estimates. These are approximations which are only valid asymptotically, and must be treated with great caution when the parameter estimates are close to their constraint boundaries.
The residual series ${a}_{t}$ is available upon completion of the iterations over the range $t=1+d+s\times D,\dots ,n$ corresponding to the differenced noise series ${w}_{t}$.
Because of the algorithm used for backforecasting, these are only true residuals for $t\ge 1+q+s\times Qps\times Pds\times D$, provided this is positive. Estimation of preperiod terms for the inputs will also tend to reduce the magnitude of the early residuals, sometimes severely.
The model component series ${z}_{1,t},\dots ,{z}_{m,t}$ and ${n}_{t}$ may optionally be returned in place of the supplied series values, in order to assess the effects of the various inputs on the output.
3.5
Forecasting Information
For the purpose of constructing forecasts of the output series at future time points
$t=n+1,n+2,\dots \text{}$ using
g13bhf, it is not necessary to use the whole set of observations
${y}_{t}$ and
${x}_{1,\mathit{t}},{x}_{2,\mathit{t}},\dots ,{x}_{m,\mathit{t}}$, for
$\mathit{t}=1,2,\dots ,m$. It is sufficient to retain a limited set of quantities constituting the ‘state set’ as follows: for each series which appears with lagged subscripts in equations
(a),
(b),
(i),
(ii) and
(iii) above, include the values at times
$n+1k$ for
$k=1$ up to the maximum lag associated with that series in the equations. Note that
(i) implicitly includes past values of
${n}_{t}$ and intermediate differences of
${n}_{t}$ such as
${\nabla}^{d1}{\nabla}_{s}^{D}$.
If later observations of the series become available, it is possible to update the state set (without reestimating the model) using
g13bgf. If time series data is supplied with a previously estimated model, it is possible to construct the state set (and forecasts) using
g13bjf.
4
References
Box G E P and Jenkins G M (1976) Time Series Analysis: Forecasting and Control (Revised Edition) Holden–Day
Marquardt D W (1963) An algorithm for least squares estimation of nonlinear parameters J. Soc. Indust. Appl. Math. 11 431
5
Arguments
 1: $\mathbf{mr}\left(7\right)$ – Integer arrayInput

On entry: the orders vector
$\left(p,d,q,P,D,Q,s\right)$ of the ARIMA model for the output noise component.
$p$, $q$, $P$ and $Q$ refer respectively to the number of autoregressive $\left(\varphi \right)$, moving average $\left(\theta \right)$, seasonal autoregressive $\left(\Phi \right)$ and seasonal moving average $\left(\Theta \right)$ parameters.
$d$, $D$ and $s$ refer respectively to the order of nonseasonal differencing, the order of seasonal differencing and the seasonal period.
Constraints:
 $p$, $d$, $q$, $P$, $D$, $Q$, $s\ge 0$;
 $p+q+P+Q>0$;
 $s\ne 1$;
 if $s=0$, $P+D+Q=0$;
 if $s>1$, $P+D+Q>0$;
 $d+s\times \left(P+D\right)\le n$;
 $p+dq+s\times \left(P+DQ\right)\le n$.
 2: $\mathbf{nser}$ – IntegerInput

On entry: the total number of input and output series. There may be any number of input series (including none), but always one output series.
Constraints:
 ${\mathbf{nser}}\ge 1$;
 if there are no parameters in the model (that is, $p=q=P=Q=0$ and ${\mathbf{kfc}}=0$), ${\mathbf{nser}}>1$.
 3: $\mathbf{mt}\left(4,{\mathbf{nser}}\right)$ – Integer arrayInput

On entry: the transfer function model orders
$b$,
$p$ and
$q$ of each of the input series. The order arguments for input series
$i$ are held in column
$i$. Row
$1$ holds the value
${b}_{i}$, row 2 holds the value
${q}_{i}$ and row 3 holds the value
${p}_{i}$. For a simple input,
${b}_{i}={q}_{i}={p}_{i}=0$.
Row 4 holds the value ${r}_{i}$, where ${r}_{i}=1$ for a simple input, ${r}_{i}=2$ for a transfer function input for which no allowance is to be made for preobservation period effects, and ${r}_{i}=3$ for a transfer function input for which preobservation period effects will be treated by estimation of appropriate nuisance parameters.
When ${r}_{i}=1$, any nonzero contents of rows 1, 2, and 3 of column $i$ are ignored.
Constraint:
${\mathbf{mt}}\left(4,\mathit{i}\right)=1\text{,}2\text{ or}3$, for $\mathit{i}=1,2,\dots ,{\mathbf{nser}}1$.
 4: $\mathbf{para}\left({\mathbf{npara}}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: initial values of the multiinput model parameters. These are in order, firstly the ARIMA model parameters:
$p$ values of
$\varphi $ parameters,
$q$ values of
$\theta $ parameters,
$P$ values of
$\Phi $ parameters and
$Q$ values of
$\Theta $ parameters. These are followed by initial values of the transfer function model parameters
${\omega}_{0},{\omega}_{1},\dots ,{\omega}_{{q}_{1}}$,
${\delta}_{1},{\delta}_{2},\dots ,{\delta}_{{p}_{1}}$ for the first of any input series and similarly for each subsequent input series. The final component of
para is the initial value of the constant
$c$, whether it is fixed or is to be estimated.
On exit: the latest values of the estimates of these parameters.
 5: $\mathbf{npara}$ – IntegerInput

On entry: the exact number of $\varphi ,\theta ,\Phi ,\Theta $, $\omega ,\delta $ and $c$ parameters.
Constraint:
${\mathbf{npara}}=p+q+P+Q+{\mathbf{nser}}+\sum \left({p}_{i}+{q}_{i}\right)$, the summation being over all the
${p}_{i}\ne {q}_{i}$ supplied in
mt.
$c$ must be included, whether fixed or estimated.
 6: $\mathbf{kfc}$ – IntegerInput

On entry: must be set to $0$ if the constant $c$ is to remain fixed at its initial value, and $1$ if it is to be estimated.
Constraint:
${\mathbf{kfc}}=0$ or $1$.
 7: $\mathbf{nxxy}$ – IntegerInput

On entry: the (common) length of the original, undifferenced input and output time series.
 8: $\mathbf{xxy}\left({\mathbf{ldxxy}},{\mathbf{nser}}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: the columns of
xxy must contain the
nxxy original, undifferenced values of each of the input series and the output series
${x}_{t}$ in that order.
On exit: if
${\mathbf{kzef}}=0$,
xxy remains unchanged on exit.
If
${\mathbf{kzef}}\ne 0$, the columns of
xxy hold the corresponding values of the input component series
${z}_{t}$ in place of
${x}_{t}$ and the output noise component
${n}_{t}$ in place of
${y}_{t}$, in that order.
 9: $\mathbf{ldxxy}$ – IntegerInput

On entry: the first dimension of the array
xxy as declared in the (sub)program from which
g13bef is called.
Constraint:
${\mathbf{ldxxy}}\ge {\mathbf{nxxy}}$.
 10: $\mathbf{kef}$ – IntegerInput

On entry: indicates the likelihood option.
 ${\mathbf{kef}}=1$
 Gives least squares.
 ${\mathbf{kef}}=2$
 Gives exact likelihood.
 ${\mathbf{kef}}=3$
 Gives marginal likelihood.
Constraint:
${\mathbf{kef}}=1$, $2$ or $3$.
 11: $\mathbf{nit}$ – IntegerInput

On entry: the maximum required number of iterations.
 ${\mathbf{nit}}=0$
 No change is made to any of the model parameters in array para except that the constant $c$ (if ${\mathbf{kfc}}=1$) and any $\omega $ relating to simple input series are estimated. (Apart from these, estimates are always derived for the nuisance parameters relating to any backforecasts and any preobservation period effects for transfer function inputs.)
Constraint:
${\mathbf{nit}}\ge 0$.
 12: $\mathbf{kzsp}$ – IntegerInput

On entry: must be set to
$1$ if the routine is to use the input values of
zsp in the minimization procedure, and to any other value if the default values of
zsp are to be used.
 13: $\mathbf{zsp}\left(4\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if
${\mathbf{kzsp}}=1$, then
zsp must contain the four values used to control the strategy of the search procedure.
 ${\mathbf{zsp}}\left(1\right)$
 Contains $\alpha $, the value used to constrain the magnitude of the search procedure steps.
 ${\mathbf{zsp}}\left(2\right)$
 Contains $\beta $, the multiplier which regulates the value of $\alpha $.
 ${\mathbf{zsp}}\left(3\right)$
 Contains $\delta $, the value of the stationarity and invertibility test tolerance factor.
 ${\mathbf{zsp}}\left(4\right)$
 Contains $\gamma $, the value of the convergence criterion.
If
${\mathbf{kzsp}}\ne 1$ before entry, default values of
zsp are supplied by the routine. These are
$0.01$,
$10.0$,
$1000.0$ and
$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(100\times \mathit{machineprecision},0.0000001\right)$, respectively.
On exit: contains the values, default or otherwise, used by the routine.
Constraint:
if ${\mathbf{kzsp}}=1$, ${\mathbf{zsp}}\left(1\right)>0.0$, ${\mathbf{zsp}}\left(2\right)>1.0$, ${\mathbf{zsp}}\left(3\right)\ge 1.0$, $0\le {\mathbf{zsp}}\left(4\right)<1.0$.
 14: $\mathbf{itc}$ – IntegerOutput

On exit: the number of iterations carried out.
 ${\mathbf{itc}}=1$
 Indicates that the only estimates obtained up to this point have been for the nuisance parameters relating to backforecasts, unless the marginal likelihood option is used, in which case estimates have also been obtained for simple input coefficients $\omega $ and for the constant $c$ (if ${\mathbf{kfc}}=1$). This value of itc usually indicates a failure in a consequent step of estimating transfer function input preobservation period nuisance parameters.
 ${\mathbf{itc}}=0$
 Indicates that estimates have been obtained up to this point for the constant $c$ (if ${\mathbf{kfc}}=1$), for simple input coefficients $\omega $ and for the nuisance parameters relating to the backforecasts and to transfer function input preobservation period effects.
 15: $\mathbf{sd}\left({\mathbf{npara}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
npara values of the standard deviations corresponding to each of the parameters in
para. When the constant is fixed its standard deviation is returned as zero. When the values of
para are valid, the values of
sd are usually also valid. However, if an exit value of
${\mathbf{ifail}}={\mathbf{3}}$,
${\mathbf{8}}$ or
${\mathbf{10}}$, then the contents of
sd will be indeterminate.
 16: $\mathbf{cm}\left({\mathbf{ldcm}},{\mathbf{npara}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the first
npara rows and columns of
cm contain the correlation coefficients relating to each pair of parameters in
para. All coefficients relating to the constant will be zero if the constant is fixed. The contents of
cm will be indeterminate under the same conditions as
sd.
 17: $\mathbf{ldcm}$ – IntegerInput

On entry: the first dimension of the array
cm as declared in the (sub)program from which
g13bef is called.
Constraint:
${\mathbf{ldcm}}\ge {\mathbf{npara}}$.
 18: $\mathbf{s}$ – Real (Kind=nag_wp)Output

On exit: the residual sum of squares, $S$, at the latest set of valid parameter estimates.
 19: $\mathbf{d}$ – Real (Kind=nag_wp)Output

On exit: the objective function, $D$, at the latest set of valid parameter estimates.
 20: $\mathbf{ndf}$ – IntegerOutput

On exit: the number of degrees of freedom associated with $S$.
 21: $\mathbf{kzef}$ – IntegerInput

On entry: must not be set to
$0$, if the values of the input component series
${z}_{t}$ and the values of the output noise component
${n}_{t}$ are to overwrite the contents of
xxy on exit, and must be set to
$0$ if
xxy is to remain unchanged.
 22: $\mathbf{res}\left({\mathbf{nxxy}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the values of the residuals relating to the differenced values of the output series. The remainder of the first
nxxy terms in the array will be zero.
 23: $\mathbf{sttf}\left({\mathbf{isttf}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
nsttf values of the state set array.
 24: $\mathbf{isttf}$ – IntegerInput

On entry: the dimension of the array
sttf as declared in the (sub)program from which
g13bef is called.
Constraint:
${\mathbf{isttf}}\ge \left(P\times s\right)+d+\left(D\times s\right)+q+\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(p,Q\times s\right)+\mathit{ncg}$, where $\mathit{ncg}=\sum \left({b}_{i}+{q}_{i}+{p}_{i}\right)$ over all input series for which ${r}_{i}>1$.
 25: $\mathbf{nsttf}$ – IntegerOutput

On exit: the number of values in the state set array
sttf.
 26: $\mathbf{wa}\left({\mathbf{iwa}}\right)$ – Real (Kind=nag_wp) arrayOutput
 27: $\mathbf{iwa}$ – IntegerInput
 28: $\mathbf{mwa}\left({\mathbf{imwa}}\right)$ – Integer arrayOutput
 29: $\mathbf{imwa}$ – IntegerInput

These arguments are no longer referenced, but are included for backwards compatability.
 30: $\mathbf{kpriv}$ – IntegerInput

On entry: must not be set to
$0$, if it is required to monitor the course of the optimization. The course of the optimization is monitored by printing out at each iteration the iteration count (
itc), the residual sum of squares (
s), the objective function (
d) and a description and value for each of the parameters in the
para array. The descriptions are PHI for
$\varphi $, THETA for
$\theta $, SPHI for
$\Phi $, STHETA for
$\Theta $, OMEGA/SI for
$\omega $ in a simple input, OMEGA for
$\omega $ in a transfer function input, DELTA for
$\delta $ and CONSTANT for
$c$. In addition SERIES 1, SERIES 2, etc. indicate the input series relevant to the OMEGA and DELTA parameters.
kpriv must be set to
$0$ if the printout of the above information is not required.
 31: $\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, because for this routine the values of the output arguments may be useful even if
${\mathbf{ifail}}\ne {\mathbf{0}}$ on exit, the recommended value is
$1$.
When the value $\mathbf{1}\text{ or}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).
6
Error 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).
Note: g13bef may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
 ${\mathbf{ifail}}=1$

On entry,  ${\mathbf{kfc}}<0$, 
or  ${\mathbf{kfc}}>1$, 
or  ${\mathbf{ldxxy}}<{\mathbf{nxxy}}$, 
or  ${\mathbf{ldcm}}<{\mathbf{npara}}$, 
or  ${\mathbf{kef}}<1$, 
or  ${\mathbf{kef}}>3$, 
or  ${\mathbf{nit}}<0$, 
or  ${\mathbf{nser}}<1$, 
or  ${\mathbf{nser}}=1$ and there are no parameters in the model ($p=q=P=Q=0$ and ${\mathbf{kfc}}=0$). 
 ${\mathbf{ifail}}=2$

On entry, there is inconsistency between
npara and
kfc on the one hand and the orders in arrays
mr and
mt on the other, or one of the
${r}_{i}$, stored in
${\mathbf{mt}}\left(4,i\right)\ne 1$,
$2$ or
$3$.
 ${\mathbf{ifail}}=3$

On entry or during execution, one or more sets of $\delta $ parameters do not satisfy the stationarity or invertibility test conditions.
 ${\mathbf{ifail}}=4$

On entry,  when ${\mathbf{kzsp}}=1$, ${\mathbf{zsp}}\left(1\right)\le 0.0$, 
or  ${\mathbf{zsp}}\left(2\right)\le 1.0$, 
or  ${\mathbf{zsp}}\left(3\right)<1.0$, 
or  ${\mathbf{zsp}}\left(4\right)<0.0$, 
or  ${\mathbf{zsp}}\left(4\right)\ge 1.0$. 
 ${\mathbf{ifail}}=8$

Unable to calculate the latest parameter estimates.
 ${\mathbf{ifail}}=9$

This indicates a failure in the inversion of the second derivative matrix. This is needed in the calculation of the correlation matrix and the standard deviations of the parameter estimates.
 ${\mathbf{ifail}}=10$

On entry or during execution, one or more sets of the ARIMA ($\varphi $, $\theta $, $\Phi $ or $\Theta $) parameters do not satisfy the stationarity or invertibility test conditions.
 ${\mathbf{ifail}}=11$

On entry,
isttf is too small. The state set information will not be produced and if
${\mathbf{kzef}}\ne 0$ array
xxy will remain unchanged. All other arguments will be produced correctly.
 ${\mathbf{ifail}}=12$

The routine has failed to converge after
nit iterations. If steady decreases in the objective function,
$D$, were monitored up to the point where this exit occurred, then the exit probably occurred because
nit was set too small, so the calculations should be restarted from the final point held in
para.
 ${\mathbf{ifail}}=13$

On entry,
isttf is too small (see
${\mathbf{ifail}}={\mathbf{11}}$) and
nit iterations were carried out without the convergence conditions being satisfied (see
${\mathbf{ifail}}={\mathbf{12}}$).
 ${\mathbf{ifail}}=99$
An unexpected error has been triggered by this routine. Please
contact
NAG.
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.
7
Accuracy
The computation used is believed to be stable.
8
Parallelism and Performance
g13bef is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g13bef 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 implementationspecific information.
The time taken by g13bef is approximately proportional to ${\mathbf{nxxy}}\times {\mathbf{itc}}\times {{\mathbf{npara}}}^{2}$.
10
Example
After the full
$11$ iterations, the following are computed and printed out: the final values of the
para parameters and their standard errors, the correlation matrix, the residuals for the
$36$ differenced values, the values of
${z}_{t}$ and
${n}_{t}$, the values of the state set and the number of degrees of freedom.
10.1
Program Text
Program Text (g13befe.f90)
10.2
Program Data
Program Data (g13befe.d)
10.3
Program Results
Program Results (g13befe.r)