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

2 Specification

Fortran Interface

Subroutine d01fc_AD_f (

ad_handle, ndim, a, b, minpts, maxpts, f, eps, acc, lenwrk, wrkstr, finval, iuser, ruser, ifail)

Integer, Intent (In)	::	ndim, maxpts, lenwrk
Integer, Intent (Inout)	::	minpts, iuser(*), ifail
External	::	f
ADTYPE, Intent (In)	::	a(ndim), b(ndim), eps
ADTYPE, Intent (Inout)	::	ruser(*)
ADTYPE, Intent (Out)	::	acc, wrkstr(lenwrk), finval
Type (c_ptr), Intent (Inout)	::	ad_handle

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

C++ Header Interface

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

void d01fc (

void *&ad_handle, const Integer &ndim, const ADTYPE a[], const ADTYPE b[], Integer &minpts, const Integer &maxpts,
void (NAG_CALL f)(void *&ad_handle, const Integer &ndim, const ADTYPE z[], ADTYPE &retval, Integer iuser[], ADTYPE ruser[]),
const ADTYPE &eps, ADTYPE &acc, const Integer &lenwrk, ADTYPE wrkstr[], ADTYPE &finval, const Integer &liuser, Integer iuser[], const Integer &lruser, ADTYPE ruser[], Integer &ifail)

}
}

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

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

3 Description

d01fc is the AD Library version of the primal routine d01fcf.

d01fcf attempts to evaluate a multidimensional integral (up to

15

dimensions), with constant and finite limits, to a specified relative accuracy, using an adaptive subdivision strategy. For further information see Section 3 in the documentation for d01fcf.

4 References

Genz A C and Malik A A (1980) An adaptive algorithm for numerical integration over an N-dimensional rectangular region J. Comput. Appl. Math. 6 295–302

van Dooren P and de Ridder L (1976) An adaptive algorithm for numerical integration over an N-dimensional cube J. Comput. Appl. Math. 2 207–217

5 Arguments

In addition to the arguments present in the interface of the primal routine, d01fc 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 – Pointer to AD Data Input/Output

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

2: ndim – Integer Input

3: a(ndim) – ADTYPE array Input

4: b(ndim) – ADTYPE array Input

5: minpts – Integer Input/Output

6: maxpts – Integer Input

7: 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, z, retval, iuser, ruser)

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

C++ Header Interface

void f (

void *&ad_handle, const Integer &ndim, const ADTYPE z[], ADTYPE &retval, Integer iuser[], ADTYPE ruser[])

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

8: eps – ADTYPE Input

9: acc – ADTYPE Output

10: lenwrk – Integer Input

11: wrkstr(lenwrk) – ADTYPE array Workspace

12: finval – ADTYPE Output

13: liuser Input

User workspace dimension (C++ only), see x10af to specify the dimension from Fortran.

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

User workspace.

15: lruser Input

User workspace dimension (C++ only), see x10ae to specify the dimension from Fortran.

16: ruser( $*$ ) – ADTYPE array User Workspace

User workspace.

17: ifail – Integer Input/Output

6 Error Indicators and Warnings

d01fc preserves all error codes from d01fcf 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 = - 199$: The routine was called using a mode that has not yet been implemented.

$ifail = - 443$: On entry: ad_handle is nullptr.
This check is only made if the overloaded C++ interface is used with arguments not of type double.

$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 Section 4.8.1 in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

d01fc is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

Description of the primal example.

This example estimates the integral

\int_{0}^{1} \int_{0}^{1} \int_{0}^{1} \int_{0}^{1} \frac{4 z_{1} z_{3}^{2} \exp (2 z_{1} z_{3})}{{(1 + z_{2} + z_{4})}^{2}} d z_{4} d z_{3} d z_{2} d z_{1} = 0.575364 .

The accuracy requested is one part in

10000

10.1 Adjoint modes

Language	Source File	Data	Results
Fortran	d01fc_a1w_fe.f90	None	d01fc_a1w_fe.r
C++	d01fc_a1w_hcppe.cpp	None	d01fc_a1w_hcppe.r

10.2 Tangent modes

Language	Source File	Data	Results
Fortran	d01fc_t1w_fe.f90	None	d01fc_t1w_fe.r
C++	d01fc_t1w_hcppe.cpp	None	d01fc_t1w_hcppe.r

10.3 Passive mode

Language	Source File	Data	Results
Fortran	d01fc_p0w_fe.f90	None	d01fc_p0w_fe.r
C++	d01fc_p0w_hcppe.cpp	None	d01fc_p0w_hcppe.r

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

D01 (Quad) Chapter Contents

D01 (Quad) Chapter Introduction (FL)

d01fc: FL CL CPP AD

NAG AD Libraryd01fc (md_adapt)

▸▿ Contents

1 Purpose