e04rzf is a part of the NAG optimization modelling suite. It is used to deallocate the memory used within the problem handle and to destroy the handle itself.

2 Specification

Fortran Interface

Subroutine e04rzf (

handle, ifail)

Integer, Intent (Inout)	::	ifail
Type (c_ptr), Intent (Inout)	::	handle

C Header Interface

#include <nag.h>

void	e04rzf_ (void *handle, Integer ifail)

The routine may be called by the names e04rzf or nagf_opt_handle_free.

3 Description

Each problem handle initialized by e04raf should be deallocated to avoid memory leaks. Therefore e04rzf 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 initialized by e04raf might cause unpredictable behaviour, including a crash of your program. See Section 3.1 in the E04 Chapter Introduction for more details about the NAG optimization modelling suite.

4 References

None.

5 Arguments

1: $handle$ – Type (c_ptr) Input/Output: On entry: the handle to the problem. It needs to be initialized by e04raf and must not be changed before the call to e04rzf.

On exit: the handle is destroyed and set to c_null_ptr.
2: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$ . When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by e04raf or it has been corrupted.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

e04rzf is not threaded in any implementation.

9 Further Comments

None.

10 Example

See Section 10 in e04raf for links to all the examples in the suite.

NAG Library Manual, Mark 27

Interfaces: FL CL AD

NAG FL Interface Introduction

E04 (Opt) Chapter Contents

E04 (Opt) Chapter Introduction

e04rz: FL CL AD

NAG FL Interfacee04rzf (handle_​free)

▸▿ Contents

1 Purpose