NAG Library Routine Document

g13aaf (uni_diff)


g13aaf carries out non-seasonal and seasonal differencing on a time series. Information which allows the original series to be reconstituted from the differenced series is also produced. This information is required in time series forecasting.


Fortran Interface
Subroutine g13aaf ( x, nx, nd, nds, ns, xd, nxd, ifail)
Integer, Intent (In):: nx, nd, nds, ns
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: nxd
Real (Kind=nag_wp), Intent (In):: x(nx)
Real (Kind=nag_wp), Intent (Out):: xd(nx)
C Header Interface
#include <nagmk26.h>
void  g13aaf_ (const double x[], const Integer *nx, const Integer *nd, const Integer *nds, const Integer *ns, double xd[], Integer *nxd, Integer *ifail)


Let dsDxi be the ith value of a time series xi, for i=1,2,,n after non-seasonal differencing of order d and seasonal differencing of order D (with period or seasonality s). In general,
dsDxi = d-1sDxi+1-d-1sDxi d>0
dsDxi = dsD-1xi+s-dsD-1xi D>0
Non-seasonal differencing up to the required order d is obtained using
1xi = xi+1-xi for i=1,2,,n-1
2xi = 1xi+1-1xi for i=1,2,,n-2
dxi = d-1xi+1-d-1xi for i=1,2,,n-d
Seasonal differencing up to the required order D is then obtained using
ds1xi = dxi+s-dxi for i=1,2,,n-d-s
ds2xi = ds1xi+s-ds1xi for i=1,2,,n-d-2s
dsDxi = dsD-1xi+s-dsD-1xi for i=1,2,,n-d-D×s
Mathematically, the sequence in which the differencing operations are performed does not affect the final resulting series of m=n-d-D×s values.




1:     xnx – Real (Kind=nag_wp) arrayInput
On entry: the undifferenced time series, xi, for i=1,2,,n.
2:     nx – IntegerInput
On entry: n, the number of values in the undifferenced time series.
Constraint: nx>nd+nds×ns.
3:     nd – IntegerInput
On entry: d, the order of non-seasonal differencing.
Constraint: nd0.
4:     nds – IntegerInput
On entry: D, the order of seasonal differencing.
Constraint: nds0.
5:     ns – IntegerInput
On entry: s, the seasonality.
  • if nds>0, ns>0;
  • if nds=0, ns0.
6:     xdnx – Real (Kind=nag_wp) arrayOutput
On exit: the differenced values in elements 1 to nxd, and reconstitution data in the remainder of the array.
7:     nxd – IntegerOutput
On exit: the number of differenced values in the array xd.
8:     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, if you are not familiar with this argument, the recommended value is 0. 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).
Errors or warnings detected by the routine:
On entry, nd=value.
Constraint: nd0.
On entry, nds=value.
Constraint: if ns=0, nds0.
On entry, nds=value.
Constraint: nds0.
On entry, ns=value.
Constraint: ns0.
On entry, nx=value, nd=value, nds=value and ns=value.
Constraint: nx>nd+nds×ns.
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

g13aaf is not threaded in any implementation.

Further Comments

The time taken by g13aaf is approximately proportional to nd+nds×nx.


This example reads in a set of data consisting of 20 observations from a time series. Non-seasonal differencing of order 2 and seasonal differencing of order 1 (with seasonality of 4) are applied to the input data, giving an output array holding 14 differenced values and 6 values which can be used to reconstitute the output array.

Program Text

Program Text (g13aafe.f90)

Program Data

Program Data (g13aafe.d)

Program Results

Program Results (g13aafe.r)