NAG Library Routine Document

g13asf (uni_arima_resid)


    1  Purpose
    7  Accuracy


g13asf is a diagnostic checking routine suitable for use after fitting a Box–Jenkins ARMA model to a univariate time series using g13aef or g13aff. The residual autocorrelation function is returned along with an estimate of its asymptotic standard errors and correlations. Also, g13asf calculates the Box–Ljung portmanteau statistic and its significance level for testing model adequacy.


Fortran Interface
Subroutine g13asf ( n, v, mr, m, par, npar, ishow, r, rcm, ldrcm, chi, idf, siglev, iw, liw, work, lwork, ifail)
Integer, Intent (In):: n, mr(7), m, npar, ishow, ldrcm, liw, lwork
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: idf, iw(liw)
Real (Kind=nag_wp), Intent (In):: v(n), par(npar)
Real (Kind=nag_wp), Intent (Inout):: rcm(ldrcm,m)
Real (Kind=nag_wp), Intent (Out):: r(m), chi, siglev, work(lwork)
C Header Interface
#include nagmk26.h
void  g13asf_ (const Integer *n, const double v[], const Integer mr[], const Integer *m, const double par[], const Integer *npar, const Integer *ishow, double r[], double rcm[], const Integer *ldrcm, double *chi, Integer *idf, double *siglev, Integer iw[], const Integer *liw, double work[], const Integer *lwork, Integer *ifail)


Consider the univariate multiplicative autoregressive-moving average model
ϕBΦBsWt-μ=θBΘBsεt (1)
where Wt, for t=1,2,,n, denotes a time series and εt, for t=1,2,,n, is a residual series assumed to be normally distributed with zero mean and variance σ2 (>0). The εt's are also assumed to be uncorrelated. Here μ is the overall mean term, s is the seasonal period and B is the backward shift operator such that BrWt=Wt-r. The polynomials in (1) are defined as follows:
is the non-seasonal autoregressive (AR) operator;
θ B= 1-θ1B-θ2B2--θqBq  
is the non-seasonal moving average (MA) operator;
is the seasonal AR operator; and
Θ Bs= 1-Θ1Bs-Θ2B2s--ΘQBQs  
is the seasonal MA operator. The model (1) is assumed to be stationary, that is the zeros of ϕB and ΦBs are assumed to lie outside the unit circle. The model (1) is also assumed to be invertible, that is the zeros of θB and ΘBs are assumed to lie outside the unit circle. When both ΦBs and ΘBs are absent from the model, that is when P=Q=0, then the model is said to be non-seasonal.
The estimated residual autocorrelation coefficient at lag l, r^l, is computed as:
r^l=t=l+1nε^t-l-ε-ε^t-ε- t=1n ε^t-ε- 2 ,  l=1,2,  
where ε^t denotes an estimate of the tth residual, εt, and ε-=t=1nε^t/n. A portmanteau statistic, Qm, is calculated from the formula (see Box and Ljung (1978)):
where m denotes the number of residual autocorrelations computed. (Advice on the choice of m is given in Section 9.2.) Under the hypothesis of model adequacy, Qm has an asymptotic χ2-distribution on m-p-q-P-Q degrees of freedom. Let r^T=r^1,r^2,,r^m then the variance-covariance matrix of r^ is given by:
The construction of the matrix X is discussed in McLeod (1978). (Note that the mean, μ, and the residual variance, σ2, play no part in calculating Varr^ and therefore are not required as input to g13asf.)
Note:  for additive models with fixed parameter values (i.e., fitted by g13ddf) g13dsf should be used instead of g13asf.


Box G E P and Ljung G M (1978) On a measure of lack of fit in time series models Biometrika 65 297–303
McLeod A I (1978) On the distribution of the residual autocorrelations in Box–Jenkins models J. Roy. Statist. Soc. Ser. B 40 296–302


1:     n – IntegerInput
On entry: n, the number of observations in the residual series.
If g13asf is used following a call to g13aef, then n must be the value icount2 returned by g13aef.
If g13asf is used following a call to g13aff, then n must be the value nres returned by g13aff.
Constraint: n3.
2:     vn – Real (Kind=nag_wp) arrayInput
On entry: vt must contain an estimate of εt, for t=1,2,,n.
If g13asf is used following a call to g13aef then the actual argument v must be exricount1+1 as returned by g13aef.
If g13asf is used following a call to g13aff then the actual argument v must be res as returned by g13aff.
Constraint: v must contain at least two distinct elements.
3:     mr7 – Integer arrayInput
On entry: the orders vector (p, d, q, P, D, Q, s) as supplied to g13aef or g13aff.
  • p,q,P,Q,s0;
  • p+q+P+Q>0;
  • if s=0, then P=0 and Q=0.
4:     m – IntegerInput
On entry: the value of m, the number of residual autocorrelations to be computed. See Section 9.2 for advice on the value of m.
Constraint: npar<m<n.
5:     parnpar – Real (Kind=nag_wp) arrayInput
On entry: the parameter estimates in the order ϕ1,ϕ2,,ϕp, θ1,θ2,,θq, Φ1,Φ2,,ΦP, Θ1,Θ2,,ΘQ only.
Constraint: the elements in par must satisfy the stationarity and invertibility conditions.
6:     npar – IntegerInput
On entry: the total number of ϕ, θ, Φ and Θ parameters, i.e., npar=p+q+P+Q.
Constraint: npar=mr1+mr3+mr4+mr6.
7:     ishow – IntegerInput
On entry: must be nonzero if the residual autocorrelations, their standard errors and the portmanteau statistics are to be printed and zero otherwise.
These quantities are available also as output variables in r, rcm, chi, idf and siglev.
8:     rm – Real (Kind=nag_wp) arrayOutput
On exit: an estimate of the residual autocorrelation coefficient at lag l, for l=1,2,,m. If ifail=3 on exit then all elements of r are set to zero.
9:     rcmldrcmm – Real (Kind=nag_wp) arrayOutput
On exit: the estimated standard errors and correlations of the elements in the array r. The correlation between ri and rj is returned as rcmij except that if i=j then rcmij contains the standard error of ri. If on exit, ifail5, then all off-diagonal elements of rcm are set to zero and all diagonal elements are set to 1/n.
10:   ldrcm – IntegerInput
On entry: the first dimension of the array rcm as declared in the (sub)program from which g13asf is called.
Constraint: ldrcmm.
11:   chi – Real (Kind=nag_wp)Output
On exit: the value of the portmanteau statistic, Qm. If ifail=3 on exit then chi is returned as zero.
12:   idf – IntegerOutput
On exit: the number of degrees of freedom of chi.
13:   siglev – Real (Kind=nag_wp)Output
On exit: the significance level of chi based on idf degrees of freedom. If ifail=3 on exit, siglev is returned as one.
14:   iwliw – Integer arrayWorkspace
15:   liw – IntegerInput
On entry: the dimension of the array iw as declared in the (sub)program from which g13asf is called.
Constraint: liwmaxmr1,mr3,mr4,mr6.
16:   worklwork – Real (Kind=nag_wp) arrayWorkspace
17:   lwork – IntegerInput
On entry: the dimension of the array work as declared in the (sub)program from which g13asf is called.
Constraint: lworknpar×m+npar+1+maxmr1,mr3,mr4,mr6× maxmr7,1+m.
18:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ 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​ 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 ifail0 on exit, the recommended value is -1. When the value -1​ or ​1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Note: g13asf may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
On entry,mr1<0,
ormr7=0 and either mr4>0 or mr6>0,
orliw is too small,
orlwork is too small.
On entry, the autoregressive (or moving average) parameters are extremely close to or outside the stationarity (or invertibility) region. To proceed, you must supply different parameter estimates in the array par.
On entry, the residuals are practically identical giving zero (or near zero) variance. In this case chi is set to zero and siglev to one and all the elements of r are set to zero.
This is an unlikely exit brought about by an excessive number of iterations being needed to evaluate the zeros of the AR or MA polynomials. All output arguments are undefined.
On entry, one or more of the AR operators has a factor in common with one or more of the MA operators. To proceed, this common factor must be deleted from the model. In this case, the off-diagonal elements of rcm are returned as zero and the diagonal elements set to 1/n. All other output quantities will be correct.
This is an unlikely exit. At least one of the diagonal elements of rcm was found to be either negative or zero. In this case all off-diagonal elements of rcm are returned as zero and all diagonal elements of rcm set to 1/n.
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.
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.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


The computations are believed to be stable.

Parallelism and Performance

g13asf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g13asf 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.

Further Comments


The time taken by g13asf depends upon the number of residual autocorrelations to be computed, m.

Choice of m

The number of residual autocorrelations to be computed, m should be chosen to ensure that when the ARMA model (1) is written as either an infinite order autoregressive process:
or as an infinite order moving average process:
Wt-μ=j= 1ψjεt-j+εt  
then the two sequences π1,π2, and ψ1,ψ2, are such that πj and ψj are approximately zero for j>m. An overestimate of m is therefore preferable to an under-estimate of m. In many instances the choice m=10 will suffice. In practice, to be on the safe side, you should try setting m=20.

Approximate Standard Errors

When ifail=5 or 6 all the standard errors in rcm are set to 1/n. This is the asymptotic standard error of r^l when all the autoregressive and moving average parameters are assumed to be known rather than estimated.

Alternative Applications

g13asf may be used for diagnostic checking of suitable univariate ARMA models, as described in Section 3, fitted by g13bef or g13ddf. Great care must be taken in obtaining the input values for g13asf from the output values from g13bef or g13ddf.


This example fits an ARIMA1,1,2 model to a series of 30 observations. 10 residual autocorrelations are computed.

Program Text

Program Text (g13asfe.f90)

Program Data

Program Data (g13asfe.d)

Program Results

Program Results (g13asfe.r)

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