d01pa: FL CL CPP AD

NAG AD Library
d01pa_a1w_f (md_simplex_a1w)

Note: _a1w_ denotes that first order adjoints are computed in working precision; this has the corresponding argument type nagad_a1w_w_rtype. Further implementations, for example for higher order differentiation or using the tangent linear approach, may become available at later marks of the NAG AD Library. 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

Interfaces: FL CL CPP AD

NAG AD Library Introduction

D01 (Quad) Chapter Contents

D01 (Quad) Chapter Introduction (FL)

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

d01pa_a1w_f is the adjoint version of the primal routine d01paf.

2 Specification

Fortran Interface

Subroutine d01pa_a1w_f (

ad_handle, ndim, vert, ldvert, sdvert, f, minord, maxord, finvls, esterr, iuser, ruser, ifail)

Integer, Intent (In)	::	ndim, ldvert, sdvert, maxord
Integer, Intent (Inout)	::	minord, iuser(*), ifail
External	::	f
Type (nagad_a1w_w_rtype), Intent (Inout)	::	vert(ldvert,sdvert), finvls(maxord), ruser(*)
Type (nagad_a1w_w_rtype), Intent (Out)	::	esterr
Type (c_ptr), Intent (In)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void d01pa_a1w_f_ (

void *&ad_handle, const Integer &ndim, nagad_a1w_w_rtype vert[], const Integer &ldvert, const Integer &sdvert,
void (NAG_CALL f)(void *&ad_handle, const Integer &ndim, nagad_a1w_w_rtype x[], nagad_a1w_w_rtype &retval, Integer iuser[], nagad_a1w_w_rtype ruser[]),
Integer &minord, const Integer &maxord, nagad_a1w_w_rtype finvls[], nagad_a1w_w_rtype &esterr, Integer iuser[], nagad_a1w_w_rtype ruser[], Integer &ifail)

The routine may be called by the names d01pa_a1w_f or nagf_quad_md_simplex_a1w.

3 Description

d01pa_a1w_f is the adjoint version of the primal routine d01paf.

d01paf returns a sequence of approximations to the integral of a function over a multidimensional simplex, together with an error estimate for the last approximation. For further information see Section 3 in the documentation for d01paf.

4 References

None.

5 Arguments

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

On entry: a handle to the AD configuration data object, as created by x10aa_a1w_f.

2: ndim – Integer Input

3: vert(ldvert, sdvert) – Type (nagad_a1w_w_rtype) array Input/Output

4: ldvert – Integer Input

5: sdvert – Integer Input

6: f – Subroutine External Procedure

Note that f is a subroutine in this interface, returning the function value via the additional output parameter retval.

The specification of f is:

Fortran Interface

Subroutine f (

ad_handle, ndim, x, retval, iuser, ruser)

Integer, Intent (In)	::	ndim
Integer, Intent (Inout)	::	iuser(*)
Type (nagad_a1w_w_rtype), Intent (In)	::	x(ndim)
Type (nagad_a1w_w_rtype), Intent (Inout)	::	ruser(*)
Type (nagad_a1w_w_rtype), Intent (Out)	::	retval
Type (c_ptr), Intent (In)	::	ad_handle

C++ Interface

#include <nagad.h>

void f (

void *&ad_handle, const Integer &ndim, nagad_a1w_w_rtype x[], nagad_a1w_w_rtype &retval, Integer iuser[], nagad_a1w_w_rtype ruser[])

1: ad_handle – Type (c_ptr) Input: On entry: a handle to the AD configuration data object.
2: ndim – Integer Input
3: x – Type (nagad_a1w_w_rtype) array Input
4: retval – Type (nagad_a1w_w_rtype) Output: On exit: the value of the integrand $f$ at the given point.
5: iuser( $*$ ) – Integer array User Workspace
6: ruser( $*$ ) – Type (nagad_a1w_w_rtype) array User Workspace

7: minord – Integer Input/Output

8: maxord – Integer Input

9: finvls(maxord) – Type (nagad_a1w_w_rtype) array Input/Output

10: esterr – Type (nagad_a1w_w_rtype) Output

11: iuser( $*$ ) – Integer array User Workspace

User workspace.

12: ruser( $*$ ) – Type (nagad_a1w_w_rtype) array User Workspace

User workspace.

13: ifail – Integer Input/Output

6 Error Indicators and Warnings

d01pa_a1w_f preserves all error codes from d01paf and in addition can return:

$ifail = - 89$: An unexpected AD error has been triggered by this routine. Please contact NAG.
See Section 4.5.2 in the NAG AD Library Introduction for further information.