To be consistent with the naming scheme for other functions in the AD Library, five functions are available with names formed by replacing AD in the above by one of p0w, a1w, t1w, a1t1w or t2w.
For routines where it is necessary to perform callback operations via one or more companion callbacks, data must be passed between the procedure argument and any such companion callback via a callback data object as created by x10ba_AD_f. x10ce_AD_f can be used to extract an integer value from the callback data object. In this way integer values can be communicated between a procedure argument and its companion callbacks.
Note that writing to and reading from a callback data object must be performed in strict order without omission. Reading a data item from the object is equivalent to removing that item from a data stack; reading is, therefore, not passive, but updates the callback data object.
1: – Pointer to AD DataInput/Output
On entry: will contain a handle to the callback data object.
On exit: will contain a handle to the updated callback data object, with data item removed from data stack.
2: – IntegerOutput
On exit: an integer value, , to be extracted from the callback data object.
3: – IntegerInput/Output
On entry: ifail must be set to , or to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of means that an error message is printed while a value of means that it is not.
If halting is not appropriate, the value or is recommended. If message printing is undesirable, then the value is recommended. Otherwise, the value is recommended. When the value or is used it is essential to test the value of ifail on exit.
On exit: unless the routine detects an error or a warning has been flagged (see Section 6).
6Error Indicators and Warnings
If on entry or , explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
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.
An unexpected error has been triggered by this routine. Please
See Section 7 in the Introduction to the NAG Library FL 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 FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.