e05jh: FL CL CPP AD

NAG AD Library
e05jh_a1w_f (bnd_mcs_option_check_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

E05 (Glopt) Chapter Contents

E05 (Glopt) Chapter Introduction (FL)

e05jh: 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

e05jh_a1w_f is the adjoint version of the primal routine e05jhf.

2 Specification

Fortran Interface

Function e05jh_a1w_f (

ad_handle, optstr, ichkopt, comm, lcomm, ifail)

Integer, Intent (In)	::	lcomm
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	ichkopt
Type (nagad_a1w_w_rtype), Intent (In)	::	comm(lcomm)
Character (*), Intent (In)	::	optstr
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void e05jh_a1w_f_ (

void *&ad_handle, const char *optstr, Integer &ichkopt, const nagad_a1w_w_rtype comm[], const Integer &lcomm, Integer &ifail, const Charlen length_optstr)

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

3 Description

e05jh_a1w_f is the adjoint version of the primal routine e05jhf.

e05jhf is used to check if you have set an optional parameter of e05jbf. The initialization routine e05jaf must have been called before calling e05jhf. For further information see Section 3 in the documentation for e05jhf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, e05jh_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.

Note that the primal routine is a function whereas e05jh_a1w_f, is a subroutine, where the function value is returned in the additional output parameter, ichkopt.

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: optstr – character Input
3: ichkopt – Integer Output: On exit: $ichkopt = 1$ if you have set the option of routine.
4: comm(lcomm) – Type (nagad_a1w_w_rtype) array Communication Array
5: lcomm – Integer Input
6: ifail – Integer Input/Output

6 Error Indicators and Warnings

e05jh_a1w_f preserves all error codes from e05jhf 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.