NAG AD Library
e05jj (bnd_mcs_optget_char)

Settings help

AD Name Style:

AD Specification Language:

1 Purpose

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

2 Specification

Fortran Interface
Subroutine e05jj_AD_f ( ad_handle, optstr, cvalue, comm, lcomm, ifail)
Integer, Intent (In) :: lcomm
Integer, Intent (Inout) :: ifail
ADTYPE, Intent (In) :: comm(lcomm)
Character (*), Intent (In) :: optstr
Character (*), Intent (Out) :: cvalue
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++ Header Interface
#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {
void e05jj ( void *&ad_handle, const char *optstr, char *cvalue, 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

e05jj is the AD Library version of the primal routine e05jjf.
e05jjf is used to get the value of an ‘ON’/‘OFF’-valued character e05jbf optional parameter. e05jjf can be used before or after calling e05jbf, but the initialization routine e05jaf must have been called before calling e05jjf. For further information see Section 3 in the documentation for e05jjf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e05jj 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_handle – Pointer to AD Data Input/Output
On entry: a handle to the AD configuration data object, as created by x10aa.
2: optstr – character Input
3: cvalue – character Output
4: comm(lcomm) – ADTYPE array Communication Array
5: lcomm – Integer Input
6: ifail – Integer Input/Output

6 Error Indicators and Warnings

e05jj preserves all error codes from e05jjf and in addition can return:
An unexpected AD error has been triggered by this routine. Please contact NAG.
See Section 4.8.2 in the NAG AD Library Introduction for further information.
The routine was called using a mode that has not yet been implemented.
On entry: ad_handle is nullptr.
This check is only made if the overloaded C++ interface is used with arguments not of type double.
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
Dynamic memory allocation failed for AD.
See Section 4.8.1 in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

e05jj is not threaded in any implementation.

9 Further Comments


10 Example

See e05jc.