NAG CL Interface
f12jzc (feast_​free)

Settings help

CL Name Style:

1 Purpose

f12jzc part of the NAG FEAST suite. It is used to deallocate the memory used within the problem handle and to destroy the handle itself.

2 Specification

#include <nag.h>
void  f12jzc (void **handle, NagError *fail)
The function may be called by the names: f12jzc or nag_sparseig_feast_free.

3 Description

Each initialized problem handle (e.g., by f12jac) should be deallocated to avoid memory leaks. Therefore, f12jzc should be called on all the handles which are no longer needed, typically after obtaining results from the solver. Please note that passing a handle which has not been properly initialized might cause unpredictable behaviour, including a crash of your program. See Section 5 in the F12 Chapter Introduction for more details about the NAG FEAST suite.

4 References

Polizzi E (2009) Density-Matrix-Based Algorithms for Solving Eigenvalue Problems Phys. Rev. B. 79 115112

5 Arguments

1: handle void ** Input/Output
On entry: the handle to the problem. It needs to be initialized (e.g., by f12jac) and to hold a problem formulation compatible with f12jzc. It must not be changed between calls to the NAG FEAST suite.
On exit: the handle is destroyed and set to NULL.
2: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument value had an illegal value.
The supplied handle was not initialized or has become corrupted.
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 7.5 in the Introduction to the NAG Library CL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

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

9 Further Comments

9.1 Additional Licensor

Parts of the code for f12jzc are distributed under the BSD software License. Please refer to Library Licensors for further details.

10 Example

See the example for f12jjc.