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

2 Specification

Fortran Interface

Subroutine e04ud_AD_f (

ad_handle, ioptns, lwsav, iwsav, rwsav, inform)

Integer, Intent (In)	::	ioptns
Integer, Intent (Inout)	::	iwsav(610)
Integer, Intent (Out)	::	inform
ADTYPE, Intent (Inout)	::	rwsav(475)
Logical, Intent (Inout)	::	lwsav(120)
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 e04ud (

void *&ad_handle, const Integer &ioptns, logical lwsav[], Integer iwsav[], ADTYPE rwsav[], Integer &inform)

}
}

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

e04ud is the AD Library version of the primal routine e04udf.

e04udf may be used to supply optional parameters to e04ucf from an external file.

e04udf can also be used to supply optional parameters to e04uff. For further information see Section 3 in the documentation for e04udf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e04ud 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: ioptns – Integer Input
3: lwsav( $120$ ) – logical array Communication Array: The arrays lwsav, iwsav and rwsav must not be altered between calls to any of the routines routine, routine, routine and routine.
4: iwsav( $610$ ) – Integer array Communication Array: The arrays lwsav, iwsav and rwsav must not be altered between calls to any of the routines routine, routine, routine and routine.
5: rwsav( $475$ ) – ADTYPE array Communication Array: The arrays lwsav, iwsav and rwsav must not be altered between calls to any of the routines routine, routine, routine and routine.
6: inform – Integer Output

6 Error Indicators and Warnings

e04ud preserves all error codes from e04udf 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

e04ud is not threaded in any implementation.

9 Further Comments

None.

10 Example

A NAG AD Library example is not yet available, please refer to the NAG AD Library Introduction for information on calling routines from the AD Library.

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

E04 (Opt) Chapter Contents

E04 (Opt) Chapter Introduction (FL)

e04ud: FL CL CPP AD

NAG AD Librarye04ud (nlp1_option_file)

▸▿ Contents

1 Purpose