naginterfaces.library.blgm.handle_​free

naginterfaces.library.blgm.handle_free(handle)[source]

handle_free destroys a G22 handle and deallocates all the memory used.

For full information please refer to the NAG Library document for g22za

https://www.nag.com/numeric/nl/nagdoc_27.1/flhtml/g22/g22zaf.html

Parameters
handleHandle, modified in place

On entry: the G22 handle to be destroyed.

On exit: the handle is destroyed and set to a null Handle.

Raises
NagValueError
(errno )

has been corrupted.

(errno )

is a handle to an unknown data structure.

Warns
NagAlgorithmicWarning
(errno )

has not been initialized.

Notes

Each G22 handle should be deallocated to avoid memory leaks. Therefore, handle_free 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.