Integer, Intent (In)	::	ny, mr(nmr), nmr, npar, nwa, nb
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	y(ny), par(npar), cy
Real (Kind=nag_wp), Intent (Out)	::	wa(nwa), b(nb)

C Header Interface

#include <nag.h>

void	g13baf_ (const double y[], const Integer ny, const Integer mr[], const Integer nmr, const double par[], const Integer npar, const double cy, double wa[], const Integer nwa, double b[], const Integer nb, Integer *ifail)

The routine may be called by the names g13baf or nagf_tsa_multi_filter_arima.

3 Description

From a given series

y_{1}, y_{2}, \dots, y_{n}

, a new series

b_{1}, b_{2}, \dots, b_{n}

is calculated using a supplied (filtering) ARIMA model. This model will be one which has previously been fitted to a series

x_{t}

with residuals

a_{t}

. The equations defining

b_{t}

in terms of

y_{t}

are very similar to those by which

a_{t}

is obtained from

x_{t}

. The only dissimilarity is that no constant correction is applied after differencing. This is because the series

y_{t}

is generally distinct from the series

x_{t}

with which the model is associated, though

y_{t}

may be related to

x_{t}

. Whilst it is appropriate to apply the ARIMA model to

y_{t}

so as to preserve the same relationship between

b_{t}

and

a_{t}

as exists between

y_{t}

and

x_{t}

, the constant term in the ARIMA model is inappropriate for

y_{t}

. The consequence is that

b_{t}

will not necessarily have zero mean.

The equations are precisely:

w_{t} = \nabla^{d} \nabla_{s}^{D} y_{t},

(1)

the appropriate differencing of

y_{t}

; both the seasonal and non-seasonal inverted autoregressive operations are then applied,

u_{t} = w_{t} - Φ_{1} w_{t - s} - \dots - Φ_{P} w_{t - s \times P}

(2)

v_{t} = u_{t} - ϕ_{1} u_{t - 1} - \dots - ϕ_{p} u_{t - p}

(3)

followed by the inverted moving average operations

z_{t} = v_{t} + Θ_{1} z_{t - s} + \dots + Θ_{Q} z_{t - s \times Q}

(4)

b_{t} = z_{t} + θ_{1} b_{t - 1} + \dots + θ_{q} b_{t - q} .

(5)

Because the filtered series value

b_{t}

depends on present and past values

y_{t}, y_{t - 1}, \dots

, there is a problem arising from ignorance of

y_{0}, y_{−1}, \dots

which particularly affects calculation of the early values

b_{1}, b_{2}, \dots

, causing ‘transient errors’. The routine allows two possibilities.

(i)The equations (1), (2) and (3) are applied from successively later time points so that all terms on their right-hand sides are known, with $v_{t}$ being defined for $t = (1 + d + s \times D + s \times P), \dots, n$ . Equations (4) and (5) are then applied over the same range, taking any values on the right-hand side associated with previous time points to be zero.
This procedure may still however result in unacceptably large transient errors in early values of $b_{t}$ .
(ii)The unknown values $y_{0}, y_{−1}, \dots$ are estimated by backforecasting. This requires that an ARIMA model distinct from that which has been supplied for filtering, should have been previously fitted to $y_{t}$ .

For efficiency, you are asked to supply both this ARIMA model for

y_{t}

and a limited number of backforecasts which are prefixed to the known values of

y_{t}

. Within the routine further backforecasts of

y_{t}

, and the series

w_{t}

u_{t}

v_{t}

in (1), (2) and (3) are then easily calculated, and a set of linear equations solved for backforecasts of

z_{t}, b_{t}

for use in (4) and (5) in the case that

q + Q > 0

Even if the best model for

y_{t}

is not available, a very approximate guess such as

y_{t} = c + e_{t}

\nabla y_{t} = e_{t}

can help to reduce the transients substantially.

The backforecasts which need to be prefixed to

y_{t}

are of length

Q_{y}^{'} = q_{y} + s_{y} \times Q_{y}

, where

q_{y}

and

Q_{y}

are the non-seasonal and seasonal moving average orders and

s_{y}

the seasonal period for the ARIMA model of

y_{t}

. Thus you need not carry out the backforecasting exercise if

Q_{y}^{'} = 0

. Otherwise, the series

y_{1}, y_{2}, \dots, y_{n}

should be reversed to obtain

y_{n}, y_{n - 1}, \dots, y_{1}

and g13ajf should be used to forecast

Q_{y}^{'}

values,

{\hat{y}}_{0}, \dots, {\hat{y}}_{1 - Q_{y}^{'}}

. The ARIMA model used is that fitted to

y_{t}

(as a forward series) except that, if

d_{y} + D_{y}

is odd, the constant should be changed in sign (to allow, for example, for the fact that a forward upward trend is a reversed downward trend). The ARIMA model for

y_{t}

supplied to the filtering routine must however have the appropriate constant for the forward series.

The series

{\hat{y}}_{1 - Q_{y}^{'}}, \dots, {\hat{y}}_{0}, y_{1}, \dots, y_{n}

is then supplied to the routine, and a corresponding set of values returned for

b_{t}

4 References

Box G E P and Jenkins G M (1976) Time Series Analysis: Forecasting and Control (Revised Edition) Holden–Day

5 Arguments

1: $y (ny)$ – Real (Kind=nag_wp) array Input

On entry: the

Q_{y}^{'}

backforecasts, starting with backforecast at time

1 - Q_{y}^{'}

to backforecast at time

0

, followed by the time series starting at time

1

, where

Q_{y}^{'} = mr (10) + mr (13) \times mr (14)

. If there are no backforecasts, either because the ARIMA model for the time series is not known, or because it is known but has no moving average terms, then the time series starts at the beginning of y.

2: $ny$ – Integer Input

On entry: the total number of backforecasts and time series data points in array y.

Constraint:

ny \geq \max (1 + Q_{y}^{'}, npar)

3: $mr (nmr)$ – Integer array Input

On entry: the orders vector for the filtering model, followed by the orders vector for the ARIMA model for the time series if the latter is known. The orders appear in the standard sequence

(p, d, q, P, D, Q, s)

as given in the G13 Chapter Introduction. If the ARIMA model for the time series is supplied, the routine will assume that the first

Q_{y}^{'}

values of the array y are backforecasts.

Constraints:

the filtering model is restricted in the following ways:

$mr (1) + mr (3) + mr (4) + mr (6) > 0$ , i.e., filtering by a model which contains only differencing terms is not permitted;
$mr (k) \geq 0$ , for $k = 1, 2, \dots, 7$ ;
if $mr (7) = 0$ , $mr (4) + mr (5) + mr (6) = 0$ ;
if $mr (7) \neq 0$ , $mr (4) + mr (5) + mr (6) \neq 0$ ;
$mr (7) \neq 1$ .

the ARIMA model for the time series is restricted in the following ways:

$mr (k) \geq 0$ , for $k = 8, 9, \dots, 14$ ;
if $mr (14) = 0$ , $mr (11) + mr (12) + mr (13) = 0$ ;
if $mr (14) \neq 0$ , $mr (11) + mr (12) + mr (13) \neq 0$ ;
$mr (14) \neq 1$ .

4: $nmr$ – Integer Input

On entry: the number of values specified in the array mr. It takes the value

7

if no ARIMA model for the time series is supplied but otherwise it takes the value

14

. Thus nmr acts as an indicator as to whether backforecasting can be carried out.

Constraint:

nmr = 7

14

5: $par (npar)$ – Real (Kind=nag_wp) array Input

On entry: the parameters of the filtering model, followed by the parameters of the ARIMA model for the time series, if supplied. Within each model the parameters are in the standard order of non-seasonal AR and MA followed by seasonal AR and MA.

6: $npar$ – Integer Input

On entry: the total number of parameters held in array par.

Constraints:

if $nmr = 7$ , $npar = mr (1) + mr (3) + mr (4) + mr (6)$ ;
if $nmr = 14$ , $npar = mr (1) + mr (3) + mr (4) + mr (6) + mr (8) + mr (10) + mr (11) + mr (13)$ .

Note: the first constraint (i.e.,

mr (1) + mr (3) + mr (4) + mr (6) > 0

) on the orders of the filtering model, in argument mr, ensures that

npar > 0

7: $cy$ – Real (Kind=nag_wp) Input

On entry: if the ARIMA model is known (i.e.,

nmr = 14

), cy must specify the constant term of the ARIMA model for the time series. If this model is not known (i.e.,

nmr = 7

), cy is not used.

8: $wa (nwa)$ – Real (Kind=nag_wp) array Output

9: $nwa$ – Integer Input

These arguments are no longer accessed by g13baf. Workspace is provided internally by dynamic allocation instead.

10: $b (nb)$ – Real (Kind=nag_wp) array Output

On exit: the filtered output series. If the ARIMA model for the time series was known, and hence

Q_{y}^{'}

backforecasts were supplied in y, then b contains

Q_{y}^{'}

‘filtered’ backforecasts followed by the filtered series. Otherwise, the filtered series begins at the start of b just as the original series began at the start of y. In either case, if the value of the series at time

t

is held in

y (t)

, then the filtered value at time

t

is held in

b (t)

11: $nb$ – Integer Input

On entry: the dimension of the array b as declared in the (sub)program from which g13baf is called. In addition to holding the returned filtered series, b is also used as an intermediate work array if the ARIMA model for the time series was known.

Constraints:

if $nmr = 14$ , $nb \geq ny + \max (K_{3}, K_{1} + K_{2})$ ;
if $nmr = 7$ , $nb \geq ny$ .

Where

$K_{1} = mr (1) + mr (4) \times mr (7)$ ;
$K_{2} = mr (2) + mr (5) \times mr (7)$ ;
$K_{3} = mr (3) + mr (6) \times mr (7)$ .

12: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

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

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. 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).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $nmr = ⟨ value ⟩$ .
Constraint: $nmr = 7$ or $14$ .

$ifail = 2$: On entry, the orders vector mr is invalid.

$ifail = 3$: On entry, $npar = ⟨ value ⟩$ .
Constraint: npar must be inconsistent with mr.

$ifail = 4$: On entry, $ny = ⟨ value ⟩$ and the minimum size $required = ⟨ value ⟩$ .
Constraint: $ny \geq \max (1 + Q_{y}^{'}, npar)$ .

$ifail = 6$: On entry, $nb = ⟨ value ⟩$ and the minimum size $required = ⟨ value ⟩$ .
Constraint: if $nmr = 14$ then $nb \geq ny + \max (K_{3}, K_{1} + K_{2})$ , otherwise $nb \geq ny$ .

$ifail = 7$: The orders vector for the filtering model is invalid.

$ifail = 8$: The orders vector for the ARIMA model is invalid.

$ifail = 9$: The initial values of the filtered series are indeterminate for the given models.

$ifail = - 99$: 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.

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

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Accuracy and stability are high except when the MA parameters are close to the invertibility boundary.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

g13baf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

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

9 Further Comments

If an ARIMA model is supplied, a local workspace array of fixed length is allocated internally by g13baf. The total size of this array amounts to

K

integer elements, where

K

is the expression defined in the description of the argument wa.

The time taken by g13baf is approximately proportional to

ny \times (mr (1) + mr (3) + mr (4) + mr (6)),

with an appreciable fixed increase if an ARIMA model is supplied for the time series.

10 Example

This example reads a time series of length

296

. It reads the univariate ARIMA

(4, 0, 2, 0, 0, 0, 0)

model and the ARIMA filtering

(3, 0, 0, 0, 0, 0, 0)

model for the series. Two initial backforecasts are required and these are calculated by a call to g13ajf . The backforecasts are inserted at the start of the series and g13baf is called to perform the calculations.

g13ba: FL CL CPP AD PY MB

NAG FL Interfaceg13baf (multi_​filter_​arima)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
g13baf (multi_filter_arima)