NAG Library ManualKeyword Search:

NAG Library Function Document

nag_tsa_free (g13xzc)

▸▿ 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

1 Purpose

nag_tsa_free (g13xzc) frees the memory allocated by NAG functions to the options structure, type Nag_G13_Opt. This structure is used by some functions in Chapter g13.

2 Specification

#include <nag.h>

#include <nagg13.h>

void	nag_tsa_free (Nag_G13_Opt *options)

3 Description

The structure of type Nag_G13_Opt is used by some functions in Chapter g13. This structure is allocated memory by these functions during use.

nag_tsa_free (g13xzc) is supplied to allow you to easily free the allocated memory and set the associated pointers to NULL.

Use of nag_tsa_free (g13xzc) is not essential but is recommended if the calling program does not terminate shortly after calling the g13 time series functions and memory conservation is important.

4 References

None.

5 Arguments

1: $options$ – Nag_G13_Opt *Input/Output: On entry: the options structure, of type Nag_G13_Opt, used in a call to a NAG Time Series Analysis function.

On exit: the pointers with NAG allocated memory will have been freed and set to NULL.