NAG Library Manual, Mark 27.1
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 Library
e04ud_a1w_f (nlp1_option_file_a1w)

Note: a1w denotes that first order adjoints are computed in working precision; this has the corresponding argument type nagad_a1w_w_rtype. Also available is the t1w (first order tangent linear) mode, the interface of which is implied by replacing a1w by t1w throughout this document. Additionally, the p0w (passive interface, as alternative to the FL interface) mode is available and can be inferred by replacing of active types by the corresponding passive types. The method of codifying AD implementations in the routine name and corresponding argument types is described in the NAG AD Library Introduction.
NAG Library Manual, Mark 27.1
Interfaces:  FL   CL   CPP   AD 
NAG AD Library Introduction
E04 (Opt) Chapter Contents
E04 (Opt) Chapter Introduction (FL)
e04ud:  FL   CL   CPP   AD 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2020
Settings help

AD Name Style:


AD Specification Language:

1 Purpose

e04ud_a1w_f is the adjoint version of the primal routine e04udf.

2 Specification

Fortran Interface
Subroutine e04ud_a1w_f ( ad_handle, ioptns, lwsav, iwsav, rwsav, inform)
Integer, Intent (In) :: ioptns
Integer, Intent (Inout) :: iwsav(610)
Integer, Intent (Out) :: inform
Type (nagad_a1w_w_rtype), Intent (Inout) :: rwsav(475)
Logical, Intent (Inout) :: lwsav(120)
Type (c_ptr), Intent (Inout) :: ad_handle
C++ Header Interface
#include <nagad.h>
void e04ud_a1w_f_ ( void *&ad_handle, const Integer &ioptns, logical lwsav[], Integer iwsav[], nagad_a1w_w_rtype rwsav[], Integer &inform)
The routine may be called by the names e04ud_a1w_f or nagf_opt_nlp1_option_file_a1w. The corresponding t1w and p0w variants of this routine are also available.

3 Description

e04ud_a1w_f is the adjoint 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_a1w_f 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 – Type (c_ptr) Input/Output
On entry: a handle to the AD configuration data object, as created by x10aa_a1w_f.
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) – Type (nagad_a1w_w_rtype) 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_a1w_f 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=-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_a1w_f 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.1
Interfaces:  FL   CL   CPP   AD 
NAG AD Library Introduction
E04 (Opt) Chapter Contents
E04 (Opt) Chapter Introduction (FL)
e04ud:  FL   CL   CPP   AD 
© The Numerical Algorithms Group Ltd. 2020