NAG AD Library
e05jh (bnd_mcs_option_check)

Settings help

AD Name Style:

AD Specification Language:

1 Purpose

e05jh is the AD Library version of the primal routine e05jhf. Based (in the C++ interface) on overload resolution, e05jh can be used for primal, tangent and adjoint evaluation. It supports tangents and adjoints of first order.

2 Specification

Fortran Interface
Function e05jh_AD_f ( optstr, ichkopt, comm, lcomm, ifail)
Integer, Intent (In) :: lcomm
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: ichkopt
ADTYPE, Intent (In) :: comm(lcomm)
Character (*), Intent (In) :: optstr
Type (c_ptr), Intent (Inout) :: ad_handle
Corresponding to the overloaded C++ function, the Fortran interface provides five routines with names reflecting the type used for active real arguments. The actual subroutine and type names are formed by replacing AD and ADTYPE in the above as follows:
when ADTYPE is Real(kind=nag_wp) then AD is p0w
when ADTYPE is Type(nagad_a1w_w_rtype) then AD is a1w
when ADTYPE is Type(nagad_t1w_w_rtype) then AD is t1w
C++ Interface
#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {
void e05jh ( handle_t &ad_handle, const char *optstr, Integer &ichkopt, const ADTYPE comm[], const Integer &lcomm, Integer &ifail)
The function is overloaded on ADTYPE which represents the type of active arguments. ADTYPE may be any of the following types:
Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.

3 Description

e05jh is the AD Library version of the primal routine e05jhf.
e05jhf is used to check if you have set an optional parameter of e05jbf. The initialization routine e05jaf must have been called before calling e05jhf. For further information see Section 3 in the documentation for e05jhf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e05jh includes some arguments specific to AD.
A brief summary of the AD specific arguments is given below. For the remainder, links are provided to the corresponding argument from the primal routine. A tooltip popup for all arguments can be found by hovering over the argument name in Section 2 and in this section.
Note that the primal routine is a function whereas e05jh_a1w_f, is a subroutine, where the function value is returned in the additional output parameter, ichkopt.
1: ad_handlenag::ad::handle_t Input/Output
On entry: a configuration object that holds information on the differentiation strategy. Details on setting the AD strategy are described in AD handle object in the NAG AD Library Introduction.
2: optstr – character Input
3: ichkopt – Integer Output
On exit: ichkopt = 1 if you have set the option of routine.
4: comm(lcomm) – ADTYPE array Communication Array
5: lcomm – Integer Input
6: ifail – Integer Input/Output

6 Error Indicators and Warnings

e05jh preserves all error codes from e05jhf and in addition can return:
An unexpected AD error has been triggered by this routine. Please contact NAG.
See Error Handling in the NAG AD Library Introduction for further information.
The routine was called using a strategy that has not yet been implemented.
See AD Strategies in the NAG AD Library Introduction for further information.
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
Dynamic memory allocation failed for AD.
See Error Handling in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

e05jh is not threaded in any implementation.

9 Further Comments


10 Example

See e05jc.