NAG AD Library
e05jg (bnd_mcs_optset_real)

Settings help

AD Name Style:

AD Specification Language:

1 Purpose

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

2 Specification

Fortran Interface
Subroutine e05jg_AD_f ( optstr, rvalue, comm, lcomm, ifail)
Integer, Intent (In) :: lcomm
Integer, Intent (Inout) :: ifail
ADTYPE, Intent (In) :: rvalue
ADTYPE, Intent (Inout) :: 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 e05jg ( handle_t &ad_handle, const char *optstr, const ADTYPE &rvalue, 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

e05jg is the AD Library version of the primal routine e05jgf.
e05jgf may be used to supply individual real optional parameters to e05jbf. The initialization routine e05jaf must have been called before calling e05jgf. For further information see Section 3 in the documentation for e05jgf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e05jg 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.
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: rvalueADTYPE Input
4: comm(lcomm) – ADTYPE array Communication Array
Please consult Overwriting of Inputs in the NAG AD Library Introduction.
5: lcomm – Integer Input
6: ifail – Integer Input/Output

6 Error Indicators and Warnings

e05jg preserves all error codes from e05jgf 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

e05jg is not threaded in any implementation.

9 Further Comments


10 Example

See e05jc.