NAG AD Library
e05je (bnd_mcs_optset_char)

Settings help

AD Name Style:


AD Specification Language:

1 Purpose

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

2 Specification

C++ Interface
#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {
void e05je ( handle_t &ad_handle, const char *optstr, const char *cvalue, 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
Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.

3 Description

e05je is the AD Library version of the primal routine e05jef.
e05jef may be used to supply individual ‘ON’/‘OFF’-valued character optional parameters to e05jbf. The initialization routine e05jaf must have been called before calling e05jef. For further information see Section 3 in the documentation for e05jef.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e05je 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: cvalue – character 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

e05je preserves all error codes from e05jef and in addition can return:
ifail=-89
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.
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.
ifail=-444
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
ifail=-899
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

e05je is not threaded in any implementation.

9 Further Comments

None.

10 Example

See e05jc.