NAG AD Library
x10bb_a1w_f (callback_​insert_a1w)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{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: $\mathbf{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: $\mathbf{ifail}$ – Integer Input/Output

On entry: ifail must be set to $0$, $-1\text{ 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\text{ 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 $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of ifail on exit.

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

6 Error Indicators and Warnings

$\mathbf{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.

$\mathbf{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.

$\mathbf{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.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example