# NAG Library Function Document

## nag_blgm_handle_free (g22zac)

Note: please be advised that this function is classed as ‘experimental’ and its interface may be developed further in the future. Please see Section 3.1.1 in How to Use the NAG Library and its Documentation for further information.

## 1Purpose

nag_blgm_handle_free (g22zac) destroys a G22 handle and deallocates all the memory used.

## 2Specification

 #include #include
 void nag_blgm_handle_free (void **handle, NagError *fail)

## 3Description

Each G22 handle should be deallocated to avoid memory leaks. Therefore, nag_blgm_handle_free (g22zac) should be called on all such handles which are no longer needed. Please note that passing an uninitialized handle might cause unpredictable behaviour, including a crash of your program.

None.

## 5Arguments

1:    $\mathbf{handle}$void **Input/Output
On entry: the G22 handle to be destroyed.
On exit: the handle is destroyed and set to NULL.
2:    $\mathbf{fail}$NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

## 6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
NE_HANDLE
handle has been corrupted.
handle has not been initialized.
handle is a handle to an unknown data structure.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

Not applicable.

## 8Parallelism and Performance

nag_blgm_handle_free (g22zac) is not threaded in any implementation.

None.

## 10Example

See the example for nag_blgm_lm_formula (g22yac).
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017