NAG Library Manual, Mark 30.1
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
G13 (Tsa) Chapter Contents
G13 (Tsa) Chapter Introduction
g13xz:  FL   CL   CPP   AD   PY   MB 

NAG CL Interface
g13xzc (free)

NAG Library Manual, Mark 30.1
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
G13 (Tsa) Chapter Contents
G13 (Tsa) Chapter Introduction
g13xz:  FL   CL   CPP   AD   PY   MB 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2024
Settings help

CL Name Style:


1 Purpose

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>
void  g13xzc (Nag_G13_Opt *options)
The function may be called by the names: g13xzc or nag_tsa_free.

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.
g13xzc is supplied to allow you to easily free the allocated memory and set the associated pointers to NULL.
Use of 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.

6 Error Indicators and Warnings

None.

7 Accuracy

Not applicable.

8 Parallelism and Performance

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

9 Further Comments

None.

10 Example

See g13bec and g13bjc for examples of how g13xzc is used.
NAG Library Manual, Mark 30.1
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
G13 (Tsa) Chapter Contents
G13 (Tsa) Chapter Introduction
g13xz:  FL   CL   CPP   AD   PY   MB 
© The Numerical Algorithms Group Ltd. 2024