x10bd_AD_f (callback_mode_get_AD) : NAG AD Library, Mark 30

2 Specification

Fortran Interface

Subroutine x10bd_AD_f (

Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	mode
Type (c_ptr), Intent (In)	::	ad_handle

To be consistent with the naming scheme for other routines in the AD Library, two routines are available with names formed by replacing AD in the above by a1w or a1t1w.

C++ Header Interface

#include <nagad.h>
namespace nag {
namespace ad {

void	x10bd (void *&ad_handle, Integer &mode, Integer &ifail)

}
}

This function is applicable when symbolic adjoints are being used.

3 Description

x10bd_AD_f gets, when the symbolic computational mode is being used, the callback computational mode from the configuration data object as created by x10aa_AD_f and passed to a user-supplied procedure argument (callback) of a NAG AD Library routine. This mode is then used to determine the form of computation that is required to be performed by the symbolic callback for which the mode has been set and obtained. The full set of computational modes for symbolic callbacks currently supplied are: nagad_primal, nagad_dstate, nagad_dparam and nagad_dall. Within a user-supplied callback, different forms of computation are expected at different times. These are: the primal calculation of the callback (nagad_primal); the derivatives of the primal calculation with respect to real-valued input arguments (nagad_dstate); the derivatives of the primal calculation with respect to any user-supplied real-valued input data, e.g., in the argument ruser (nagad_dparam); and, in combining nagad_dstate and nagad_dparam, derivatives of the primal calculation with respect to all active input arguments (nagad_dall).

Note that in the case where the algorithmic computation mode is being used and the primal callback operation involves only standard operations and intrinsic functions then the callback computational mode is not relevant and no companion callback need be supplied. When the symbolic_expert computational mode is being used the callback computational mode must be interrogated to determine the form of operation required, even when this is to be performed using operator overloading rather than via companion callbacks. I dco/c++ is not being used, this also applies to symbolic computational mode. See Section 10 in c05ay_a1w_f.

3.1 Life Cycle of the Handle

Each handle should pass four stages in its life: initialization; mode setting; problem solution using the NAG AD Library; and, destruction.

The initialization by x10aa_AD_f and destruction by x10ab_AD_f mark the beginning and the end of the life of the handle. During this time the handle must only be modified by NAG AD Library routines. Working with a handle which has not been properly initialized is potentially very dangerous as it may cause unpredictable behaviour.

After the handle has been initialized, two routines are provided to set or get the callback computational mode to determine the form of computation to be performed by a supplied procedure argument. If, for example, a callback needs to know the computational mode in order to provide differentials appropriately, x10bd_AD_f will return the current computational mode as stored in the ad_handle.

5 Arguments

ad_handle

– Pointer to AD Data Input

On entry: a handle to the AD configuration data object, as created by x10aa_AD_f.

mode

– Integer Output

On exit: the callback computational mode as stored in the AD configuration data object with handle ad_handle.

$mode = nagad_primal$: The current callback is expected to perform the primal calculation.
$mode = nagad_dstate$: The current callback is expected to return the derivatives of the primal calculation with respect to real-valued input arguments.
$mode = nagad_dparam$: The current callback is expected to return the derivatives of the primal calculation with respect to user-supplied real-valued inputs (e.g., in ruser).
$mode = nagad_dall$: The current callback is expected to return derivatives of the primal calculation with respect to both active input arguments and active supplied parameters (i.e., combining nagad_dstate and nagad_dparam).

ifail

– Integer Input/Output

On entry: ifail must be set to

0

−1

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

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

−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: ad_handle is not a valid handle for the AD computational data object. Either ad_handle has not been initialized or it has become corrupted.

ifail = 2

Unexpected value of mode set on exit,

mode = ⟨ value ⟩

.
Constraint:

mode = nagad_primal

nagad_dstate

nagad_dparam

nagad_dall

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.

NAG AD Library
x10bd_AD_f (callback_mode_get_AD)

▸▿ Contents

1 Purpose

2 Specification

3 Description

3.1 Life Cycle of the Handle

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

NAG AD Libraryx10bd_AD_f (callback_​mode_​get_AD)

▸▿ Contents

1 Purpose

2 Specification

3 Description

3.1 Life Cycle of the Handle

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

NAG AD Library
x10bd_AD_f (callback_mode_get_AD)