NAG Library Routine Document
g13bdf
(multi_transf_prelim)
1
Purpose
g13bdf calculates preliminary estimates of the parameters of a transfer function model.
2
Specification
Fortran Interface
Subroutine g13bdf ( |
r0,
r,
nl,
nna,
s,
nwds,
wa,
iwa,
wds,
isf,
ifail) |
Integer, Intent (In) | :: |
nl,
nna(3),
nwds,
iwa | Integer, Intent (Inout) | :: |
ifail | Integer, Intent (Out) | :: |
isf(2) | Real (Kind=nag_wp), Intent (In) | :: |
r0,
r(nl),
s | Real (Kind=nag_wp), Intent (Out) | :: |
wa(iwa),
wds(nwds) |
|
C Header Interface
#include nagmk26.h
void |
g13bdf_ (
const double *r0,
const double r[],
const Integer *nl,
const Integer nna[],
const double *s,
const Integer *nwds,
double wa[],
const Integer *iwa,
double wds[],
Integer isf[],
Integer *ifail) |
|
3
Description
g13bdf calculates estimates of parameters
,
in the transfer function model
given cross-correlations between the series
and lagged values of
:
and the ratio of standard deviations
, as supplied by
g13bcf.
It is assumed that the series
used to calculate the cross-correlations is a sample from a time series with true autocorrelations of zero. Otherwise the cross-correlations between the series
and
, as defined in the description of
g13baf, should be used in place of those between
and
.
The estimates are obtained by solving for
the equations
then calculating
where the ‘
’ is used for
and ‘
’ for
,
.
Any value of arising in these equations for is taken as zero. The parameters are checked as to whether they satisfy the stability criterion.
4
References
Box G E P and Jenkins G M (1976) Time Series Analysis: Forecasting and Control (Revised Edition) Holden–Day
5
Arguments
- 1: – Real (Kind=nag_wp)Input
-
On entry: the cross-correlation between the two series at lag , .
Constraint:
.
- 2: – Real (Kind=nag_wp) arrayInput
-
On entry: the cross-correlations between the two series at lags to ,
, for .
Constraint:
, for .
- 3: – IntegerInput
-
On entry:
, the number of lagged cross-correlations in the array
r.
Constraint:
.
- 4: – Integer arrayInput
-
On entry: the transfer function model orders in the standard form (i.e., delay time, number of moving-average MA-like followed by number of autoregressive AR-like parameters).
Constraint:
, for .
- 5: – Real (Kind=nag_wp)Input
-
On entry: the ratio of the standard deviation of the series to that of the series, .
Constraint:
.
- 6: – IntegerInput
-
On entry: the exact number of parameters in the transfer function model.
Constraint:
.
- 7: – Real (Kind=nag_wp) arrayWorkspace
- 8: – IntegerInput
-
On entry: the dimension of the array
wa as declared in the (sub)program from which
g13bdf is called.
Constraint:
.
- 9: – Real (Kind=nag_wp) arrayOutput
-
On exit: the preliminary estimates of the parameters of the transfer function model in the order of MA-like parameters followed by the AR-like parameters. If the estimation of either type of parameter fails then these arguments are set to .
- 10: – Integer arrayOutput
-
On exit: indicators of the success of the estimation of MA-like and AR-like parameters respectively. A value indicates that there are no parameters of that type to be estimated. A value of or indicates that there are parameters of that type in the model and the estimation of that type has been successful or unsuccessful respectively. Note that there is always at least one MA-like parameter in the model.
- 11: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
On entry, | , for , |
or | , |
or | or , |
or | or , for some , |
or | , |
or | , |
or | . |
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.
7
Accuracy
Equations used in the computations may become unstable, in which case results are reset to zero with array
isf values set accordingly.
8
Parallelism and Performance
g13bdf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g13bdf 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 ,a local workspace array of fixed length is allocated internally by g13bdf. The total size of this array amounts to integer elements and real elements.
The time taken by g13bdf is roughly proportional to .
10
Example
This example reads the cross-correlations between two series at lags to . It then reads a transfer function model and calculates and prints the preliminary estimates of the parameters of the model.
10.1
Program Text
Program Text (g13bdfe.f90)
10.2
Program Data
Program Data (g13bdfe.d)
10.3
Program Results
Program Results (g13bdfe.r)