# NAG FL Interfaceg13bbf (multi_​filter_​transf)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

g13bbf filters a time series by a transfer function model.

## 2Specification

Fortran Interface
 Subroutine g13bbf ( y, ny, mr, nmr, par, npar, cy, wa, iwa, b, nb,
 Integer, Intent (In) :: ny, mr(nmr), nmr, npar, iwa, nb Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: y(ny), par(npar), cy Real (Kind=nag_wp), Intent (Out) :: wa(iwa), b(nb)
#include <nag.h>
 void g13bbf_ (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 *iwa, double b[], const Integer *nb, Integer *ifail)
The routine may be called by the names g13bbf or nagf_tsa_multi_filter_transf.

## 3Description

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) transfer function model according to the equation
 $bt=δ1bt-1+δ2bt-2+⋯+δpbt-p+ω0yt-b-ω1yt-b-1-⋯-ωqyt-b-q.$ (1)
As in the use of g13baf, large transient errors may arise in the early values of ${b}_{t}$ due to ignorance of ${y}_{t}$ for $t<0$, and two possibilities are allowed.
1. (i)The equation (1) is applied from $t=1+b+q,\dots ,n$ so all terms in ${y}_{t}$ on the right-hand side of (1) are known, the unknown set of values ${b}_{t}$ for $t=b+q,\dots ,b+q+1-p$ being taken as zero.
2. (ii)The unknown values of ${y}_{t}$ for $t\le 0$ are estimated by backforecasting exactly as for g13baf.
Box G E P and Jenkins G M (1976) Time Series Analysis: Forecasting and Control (Revised Edition) Holden–Day

## 5Arguments

1: $\mathbf{y}\left({\mathbf{ny}}\right)$Real (Kind=nag_wp) array Input
On entry: the ${Q}_{y}^{\prime }$ backforecasts starting with backforecast at time $1-{Q}_{y}^{\prime }$ to backforecast at time $0$ followed by the time series starting at time $1$, where ${Q}_{y}^{\prime }={\mathbf{mr}}\left(6\right)+{\mathbf{mr}}\left(9\right)×{\mathbf{mr}}\left(10\right)$. 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: $\mathbf{ny}$Integer Input
On entry: the total number of backforecasts and time series data points in array y.
Constraint: ${\mathbf{ny}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1+{Q}_{y}^{\prime },{\mathbf{npar}}\right)$.
3: $\mathbf{mr}\left({\mathbf{nmr}}\right)$Integer array Input
On entry: the orders vector for the filtering transfer function model followed by the orders vector for the ARIMA model for the time series if the latter is known. The transfer function model orders appear in the standard form $\left(b,q,p\right)$ as given in the G13 Chapter Introduction. Note that if the ARIMA model for the time series is supplied then the routine will assume that the first ${Q}_{y}^{\prime }$ values of the array y are backforecasts.
Constraints:
the filtering model is restricted in the following way:
• ${\mathbf{mr}}\left(1\right)\text{, ​}{\mathbf{mr}}\left(2\right)\text{, ​}{\mathbf{mr}}\left(3\right)\ge 0$.
the ARIMA model for the time series is restricted in the following ways:
• ${\mathbf{mr}}\left(\mathit{k}\right)\ge 0$, for $\mathit{k}=4,5,\dots ,10$;
• if ${\mathbf{mr}}\left(10\right)=0$, ${\mathbf{mr}}\left(7\right)+{\mathbf{mr}}\left(8\right)+{\mathbf{mr}}\left(9\right)=0$;
• if ${\mathbf{mr}}\left(10\right)\ne 0$, ${\mathbf{mr}}\left(7\right)+{\mathbf{mr}}\left(8\right)+{\mathbf{mr}}\left(9\right)\ne 0$;
• ${\mathbf{mr}}\left(10\right)\ne 1$.
4: $\mathbf{nmr}$Integer Input
On entry: the number of values supplied in the array mr. It takes the value $3$ if no ARIMA model for the time series is supplied but otherwise it takes the value $10$. Thus nmr acts as an indicator as to whether backforecasting can be carried out.
Constraint: ${\mathbf{nmr}}=3$ or $10$.
5: $\mathbf{par}\left({\mathbf{npar}}\right)$Real (Kind=nag_wp) array Input
On entry: the parameters of the filtering transfer function model followed by the parameters of the ARIMA model for the time series. In the transfer function model the parameters are in the standard order of MA-like followed by AR-like operator parameters. In the ARIMA model the parameters are in the standard order of non-seasonal AR and MA followed by seasonal AR and MA.
6: $\mathbf{npar}$Integer Input
On entry: the total number of parameters held in array par.
Constraints:
• if ${\mathbf{nmr}}=3$, ${\mathbf{npar}}={\mathbf{mr}}\left(2\right)+{\mathbf{mr}}\left(3\right)+1$;
• if ${\mathbf{nmr}}=10$, ${\mathbf{npar}}={\mathbf{mr}}\left(2\right)+{\mathbf{mr}}\left(3\right)+1+{\mathbf{mr}}\left(4\right)+{\mathbf{mr}}\left(6\right)+{\mathbf{mr}}\left(7\right)+{\mathbf{mr}}\left(9\right)$.
7: $\mathbf{cy}$Real (Kind=nag_wp) Input
On entry: if the ARIMA model is known (i.e., ${\mathbf{nmr}}=10$), cy must specify the constant term of the ARIMA model for the time series. If this model is not known (i.e., ${\mathbf{nmr}}=3$) then cy is not used.
8: $\mathbf{wa}\left({\mathbf{iwa}}\right)$Real (Kind=nag_wp) array Output
9: $\mathbf{iwa}$Integer Input
These arguments are no longer accessed by g13bbf. Workspace is provided internally by dynamic allocation instead.
10: $\mathbf{b}\left({\mathbf{nb}}\right)$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}^{\prime }$ backforecasts were supplied in y, then b contains ${Q}_{y}^{\prime }$ ‘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 ${\mathbf{y}}\left(t\right)$, then the filtered value at time $t$ is held in ${\mathbf{b}}\left(t\right)$.
11: $\mathbf{nb}$Integer Input
On entry: the dimension of the array b as declared in the (sub)program from which g13bbf 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 is known.
Constraints:
• if ${\mathbf{nmr}}=3$, ${\mathbf{nb}}\ge {\mathbf{ny}}$;
• if ${\mathbf{nmr}}=10$, ${\mathbf{nb}}\ge {\mathbf{ny}}+\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{mr}}\left(1\right)+{\mathbf{mr}}\left(2\right),{\mathbf{mr}}\left(3\right)\right)$.
12: $\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, $i=⟨\mathit{\text{value}}⟩$, ${\mathbf{mr}}\left(i\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{mr}}\left(i\right)\ge 0$.
On entry, ${\mathbf{mr}}\left(10\right)=1$.
Constraint: ${\mathbf{mr}}\left(10\right)\ne 1$.
On entry, ${\mathbf{mr}}\left(7\right)=⟨\mathit{\text{value}}⟩$, ${\mathbf{mr}}\left(8\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{mr}}\left(9\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{mr}}\left(7\right)+{\mathbf{mr}}\left(8\right)+{\mathbf{mr}}\left(9\right)=0$.
On entry, ${\mathbf{mr}}\left(7\right)=⟨\mathit{\text{value}}⟩$, ${\mathbf{mr}}\left(8\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{mr}}\left(9\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{mr}}\left(7\right)+{\mathbf{mr}}\left(8\right)+{\mathbf{mr}}\left(9\right)\ne 0$.
On entry, ${\mathbf{nb}}=⟨\mathit{\text{value}}⟩$ and the minimum size $\text{required}=⟨\mathit{\text{value}}⟩$.
Constraint: if ${\mathbf{nmr}}=10$ then ${\mathbf{nb}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(b,p,q\right)$, otherwise ${\mathbf{nb}}\ge {\mathbf{ny}}$.
On entry, ${\mathbf{nmr}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{nmr}}=3$ or $10$.
On entry, ${\mathbf{npar}}=⟨\mathit{\text{value}}⟩$.
Constraint: npar must be inconsistent with mr.
${\mathbf{ifail}}=2$
A supplied model has invalid parameters.
${\mathbf{ifail}}=3$
The supplied time series is too short.
${\mathbf{ifail}}=4$
The matrix used to solve for starting values for MA is singular.
${\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

Accuracy and stability are high except when the AR-like parameters are close to the invertibility boundary. All calculations are performed in basic precision except for one inner product type calculation which on machines of low precision is performed in additional precision.

## 8Parallelism and Performance

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

If an ARIMA model is supplied, a local workspace array of fixed length is allocated internally by g13bbf. 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 g13bbf is roughly proportional to the product of the length of the series and number of parameters in the filtering model with appreciable increase if an ARIMA model is supplied for the time series.

## 10Example

This example reads a time series of length $296$. It reads one univariate ARIMA $\left(1,1,0,0,1,1,12\right)$ model for the series and the $\left(0,13,12\right)$ filtering transfer function model. $12$ initial backforecasts are required and these are calculated by a call to g13ajf . The backforecasts are inserted at the start of the series and g13bbf is called to perform the filtering.

### 10.1Program Text

Program Text (g13bbfe.f90)

### 10.2Program Data

Program Data (g13bbfe.d)

### 10.3Program Results

Program Results (g13bbfe.r)