NAG C Library Function Document

nag_tsa_options_init (g13bxc)

1
Purpose

nag_tsa_options_init (g13bxc) initializes the structure options. This structure is used by some functions in Chapter g13. This function must be called before any direct assignments are made to members of the options structure.

2
Specification

#include <nag.h>
#include <nagg13.h>
void  nag_tsa_options_init (Nag_G13_Opt *options)

3
Description

A number of optional parameters are applicable to several functions in Chapter g13. These arguments are set by means of a structure of type Nag_G13_Opt. This initialization function sets the members of the structure to null values indicating that the default values should be used for these arguments. If argument values other than the default values are required, they must be assigned to the appropriate members of the options structure in the calling program.
This assignment of optional parameters values to the options structure must be preceded by a call to nag_tsa_options_init (g13bxc).

4
References

None.

5
Arguments

1:     options Nag_G13_Opt *Output
On exit: the initialized option structure.

6
Error Indicators and Warnings

None.

7
Accuracy

Not applicable.

8
Parallelism and Performance

nag_tsa_options_init (g13bxc) is not threaded in any implementation.

9
Further Comments

None.

10
Example

See nag_tsa_multi_inp_model_estim (g13bec) and nag_tsa_multi_inp_model_forecast (g13bjc) for examples of how nag_tsa_options_init (g13bxc) is used.