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

2 Specification

Fortran Interface

Subroutine e05zk_AD_f (

ad_handle, optstr, iopts, liopts, opts, lopts, ifail)

Integer, Intent (In)	::	liopts, lopts
Integer, Intent (Inout)	::	iopts(liopts), ifail
ADTYPE, Intent (Inout)	::	opts(lopts)
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++ Header Interface

#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {

void e05zk (

void *&ad_handle, const char *optstr, Integer iopts[], const Integer &liopts, ADTYPE opts[], const Integer &lopts, 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

e05zk is the AD Library version of the primal routine e05zkf.

e05zkf either initializes or resets the optional parameter arrays or sets a single optional parameter for supported problem solving routines in Chapter E05. The following routines are supported:

For further information see Section 3 in the documentation for e05zkf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e05zk 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: iopts(liopts) – Integer array Communication Array
4: liopts – Integer Input
5: opts(lopts) – ADTYPE array Communication Array
6: lopts – Integer Input
7: ifail – Integer Input/Output

6 Error Indicators and Warnings

e05zk preserves all error codes from e05zkf and in addition can return:

$ifail = - 89$: 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.

$ifail = - 199$: The routine was called using a mode that has not yet been implemented.

$ifail = - 443$: On entry: ad_handle is nullptr.
This check is only made if the overloaded C++ interface is used with arguments not of type double.

$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 Section 4.8.1 in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

e05zk is not threaded in any implementation.

9 Further Comments

None.

10 Example

See the example programs associated with the problem solving routine you wish to use for a demonstration of how to use e05zk to initialize option arrays and set options.

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

E05 (Glopt) Chapter Contents

E05 (Glopt) Chapter Introduction (FL)

e05zk: FL CL CPP AD

NAG AD Librarye05zk (optset)

▸▿ Contents

1 Purpose