NAG CL Interface
g13byc (transf_​orders)

Settings help

CL Name Style:


1 Purpose

g13byc allocates memory to the four pointers in the structure of type Nag_TransfOrder. The structure is used to hold the transfer function model orders of the input series for some functions in Chapter G13. This function must be called before any attempt is made to access this structure.

2 Specification

#include <nag.h>
void  g13byc (Integer nseries, Nag_TransfOrder *transfv, NagError *fail)
The function may be called by the names: g13byc or nag_tsa_transf_orders.

3 Description

The transfer function model orders of the input series are supplied to the time series function in memory allocated to four pointers. These pointers are the constituent members of the structure of type Nag_TransfOrder used by some functions in Chapter G13.
The purpose of g13byc is to allocate memory to these four pointers.

4 References

None.

5 Arguments

1: nseries Integer Input
On entry: the total number of input and output series. There may be any number of input series (including none), but always one output series. (See g13bec or g13bjc for details).
Constraint: nseries1 .
2: transfv Nag_TransfOrder *
Pointer to structure of type Nag_TransfOrder with the following members:
bInteger *Output
qInteger *Output
pInteger *
rInteger *Output
On exit: each of the pointers will have been allocated sufficient memory. (See g13bec or g13bjc for details).
3: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
NE_INT_ARG_LT
On entry, nseries=value.
Constraint: nseries1.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
g13byc is not threaded in any implementation.

9 Further Comments

None.

10 Example

See g13bec and g13bjc for examples of how g13byc is used.