e04tb: FL CL CPP AD

NAG AD Library
e04tb_a1w_f (handle_enable_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.

Keyword Search:

NAG Library Manual, Mark 27.1

Interfaces: FL CL CPP AD

NAG AD Library Introduction

E04 (Opt) Chapter Contents

E04 (Opt) Chapter Introduction (FL)

e04tb: FL CL CPP AD

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

1 Purpose

e04tb_a1w_f is the adjoint version of the primal routine e04tbf.

2 Specification

Fortran Interface

Subroutine e04tb_a1w_f (

ad_handle, handle, comp, lidx, idx, ifail)

Integer, Intent (In)	::	lidx, idx(lidx)
Integer, Intent (Inout)	::	ifail
Character (*), Intent (In)	::	comp
Type (c_ptr), Intent (Inout)	::	ad_handle
Type (c_ptr), Intent (In)	::	handle

C++ Header Interface

#include <nagad.h>

void e04tb_a1w_f_ (

void *&ad_handle, void *handle, const char *comp, const Integer &lidx, const Integer idx[], Integer &ifail, const Charlen length_comp)

The routine may be called by the names e04tb_a1w_f or nagf_opt_handle_enable_a1w. The corresponding t1w and p0w variants of this routine are also available.

3 Description

e04tb_a1w_f is the adjoint version of the primal routine e04tbf.

e04tbf is a part of the NAG optimization modelling suite and allows you to enable various components of the existing model which were previously disabled by e04tcf. For further information see Section 3 in the documentation for e04tbf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e04tb_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: handle – Type(c_ptr) Input
3: comp – character Input
4: lidx – Integer Input
5: idx(lidx) – Integer array Input
6: ifail – Integer Input/Output

6 Error Indicators and Warnings

e04tb_a1w_f preserves all error codes from e04tbf 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.