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

2 Specification

Fortran Interface

Subroutine e04ur_AD_f (

ad_handle, str, lwsav, iwsav, rwsav, inform)

Integer, Intent (Inout)	::	iwsav(610)
Integer, Intent (Out)	::	inform
ADTYPE, Intent (Inout)	::	rwsav(475)
Logical, Intent (Inout)	::	lwsav(120)
Character (*), Intent (In)	::	str

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
when ADTYPE is	Type(nagad_a1t1w_w_rtype)	then AD is a1t1w
when ADTYPE is	Type(nagad_t2w_w_rtype)	then AD is t2w

C++ Interface

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

void e04ur (

const char *str, 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,
dco::gt1s<dco::gt1s<double>::type>::type,
dco::ga1s<dco::gt1s<double>::type>::type,

Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.

3 Description

e04ur is the AD Library version of the primal routine e04urf.

e04urf may be used to supply individual optional parameters to e04usf.

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

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e04ur 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: str – character Input
2: 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 or routine.
3: 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 or routine.
4: 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 or routine.
5: inform – Integer Output: On exit: contains zero if a valid option string has been supplied and a $value > 0$ ; otherwise, (see Section 6).

6 Error Indicators and Warnings

e04ur preserves all error codes from e04urf 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

e04ur is not threaded in any implementation.

9 Further Comments

None.

10 Example

The following examples are variants of the example for e04urf, modified to demonstrate calling the NAG AD Library.

10.1 Adjoint modes

Language	Source File	Data	Results
C++	e04ur_a1_algo_dcoe.cpp	None	e04ur_a1_algo_dcoe.r
C++	e04ur_a1t1_algo_dcoe.cpp	None	e04ur_a1t1_algo_dcoe.r

10.2 Tangent modes

Language	Source File	Data	Results
C++	e04ur_t1_algo_dcoe.cpp	None	e04ur_t1_algo_dcoe.r
C++	e04ur_t2_algo_dcoe.cpp	None	e04ur_t2_algo_dcoe.r

10.3 Passive mode

Language	Source File	Data	Results
C++	e04ur_passive_dcoe.cpp	None	e04ur_passive_dcoe.r

NAG Library Manual, Mark 28.7

Interfaces: FL CL CPP AD

NAG AD Library Introduction

E04 (Opt) Chapter Contents

E04 (Opt) Chapter Introduction (FL)

e04ur: FL CL CPP AD

NAG AD Librarye04ur (lsq_gencon_deriv_option_string)

▸▿ Contents

1 Purpose