NAG AD Library
x10bb_a1w_f (callback_​insert_a1w)

1 Purpose

x10bb_a1w_f inserts the locations of cb_handle and of companion AD callback into the internal data structure used by the NAG AD Library.

2 Specification

Fortran Interface
Subroutine x10bb_a1w_f ( cb_handle, cb_loc, ifail)
Integer, Intent (Inout) :: ifail
Type (c_ptr), Intent (In) :: cb_handle
Type (c_funptr), Intent (In) :: cb_loc
C++ Header Interface
#include <nagad.h>
extern "C" {
void  x10bb_a1w_f_ (void *&cb_handle, void *&cb_loc, Integer &ifail)
}
The routine may be called by the names x10bb_a1w_f or nagf_adutils_callback_insert_a1w.

3 Description

x10bb_a1w_f inserts the locations of cb_handle and of companion AD callback into the internal data structure used by the NAG AD Library.

4 References

None.

5 Arguments

1: cb_handle Type (c_ptr) Input
On entry: a handle to the callback data object as created by a prior call to x10ba_a1w_f.
2: cb_loc Type (c_funptr) Input
On entry: the location of the user-supplied AD symbolic callback as returned by the intrinsic c_funloc with the callback name the same as the argument.
3: ifail Integer Input/Output
On entry: ifail must be set to 0, -1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of -1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value -1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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 or -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
On entry, cb_handle does not define a valid handle to a NAG AD callback data object. It has not been initialized or 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

x10bb_a1w_f is not threaded in any implementation.

9 Further Comments

None.

10 Example

See examples for computational routines in the NAG AD Library, for example, Section 10 in c05ay_a1w_f.