Settings help

1Purpose

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.

2Specification

Fortran Interface
 Subroutine e05jj_AD_f ( 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:
C++ Interface
#include <dco.hpp>
namespace nag {
 void e05jj ( handle_t &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:
double,
dco::ga1s<double>::type,
dco::gt1s<double>::type

3Description

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.

5Arguments

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.
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: cvalue – character Output
4: comm(lcomm) – ADTYPE array Communication Array
5: lcomm – Integer Input
6: ifail – Integer Input/Output

6Error Indicators and Warnings

e05jj preserves all error codes from e05jjf and in addition can return:
${\mathbf{ifail}}=-89$
See Error Handling in the NAG AD Library Introduction for further information.
${\mathbf{ifail}}=-199$
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.
${\mathbf{ifail}}=-444$
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
${\mathbf{ifail}}=-899$
Dynamic memory allocation failed for AD.
See Error Handling in the NAG AD Library Introduction for further information.

Not applicable.

8Parallelism and Performance

e05jj is not threaded in any implementation.