NAG AD Library
d01pa (md_simplex)

Settings help

AD Name Style:


AD Specification Language:

1 Purpose

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

2 Specification

Fortran Interface
Subroutine d01pa_AD_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
ADTYPE, Intent (Inout) :: vert(ldvert,sdvert), finvls(maxord), ruser(*)
ADTYPE, Intent (Out) :: esterr
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++ Interface
#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {
template <typename F_T>
void d01pa ( handle_t &ad_handle, const Integer &ndim, ADTYPE vert[], const Integer &ldvert, const Integer &sdvert, F_T &&f, Integer &minord, const Integer &maxord, ADTYPE finvls[], ADTYPE &esterr, 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

d01pa is the AD Library 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

de Doncker E (1979) New Euler–Maclaurin Expansions and their application to quadrature over the s-dimensional simplex Math. Comput. 33 1003–1018
Grundmann A and Moller H M (1978) Invariant integration formulas for the n-simplex by combinatorial methods SIAM J. Numer. Anal. 15 282–290

5 Arguments

In addition to the arguments present in the interface of the primal routine, d01pa 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_handlenag::ad::handle_t Input/Output
On entry: a configuration object that holds information on the differentiation strategy. Details on setting the AD strategy are described in AD handle object in the NAG AD Library Introduction.
2: ndim – Integer Input
3: vert(ldvert, sdvert) – ADTYPE array Input/Output
Please consult Overwriting of Inputs in the NAG AD Library Introduction.
4: ldvert – Integer Input
5: sdvert – Integer Input
6: f – Callable Input
f needs to be callable with the specification listed below. This can be a C++ lambda, a functor or a (static member) function pointer. If using a lambda, parameters can be captured safely by reference. No copies of the callable are made internally.
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(*)
ADTYPE, Intent (In) :: x(ndim)
ADTYPE, Intent (Inout) :: ruser(*)
ADTYPE, Intent (Out) :: retval
Type (c_ptr), Intent (Inout) :: ad_handle
C++ Interface
auto f = [&]( const handle_t &ad_handle, const Integer &ndim, const ADTYPE x[], ADTYPE &retval)
1: ad_handlenag::ad::handle_t Input/Output
On entry: a handle to the AD handle object.
2: ndim – Integer Input
3: xADTYPE array Input
4: retvalADTYPE Output
On exit: the value of the integrand f at the given point.
*: iuser(*) – Integer array User Workspace
*: ruser(*)ADTYPE array User Workspace
7: minord – Integer Input/Output
8: maxord – Integer Input
9: finvls(maxord) – ADTYPE array Input/Output
Please consult Overwriting of Inputs in the NAG AD Library Introduction.
10: esterrADTYPE Output
*: iuser(*) – Integer array User Workspace
User workspace.
*: ruser(*) – ADTYPE array User Workspace
User workspace.
11: ifail – Integer Input/Output

6 Error Indicators and Warnings

d01pa 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 Error Handling in the NAG AD Library Introduction for further information.
ifail=-199
The routine was called using a strategy that has not yet been implemented.
See AD Strategies in the NAG AD Library Introduction for further information.
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 Error Handling in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

d01pa is not threaded in any implementation.

9 Further Comments

None.

10 Example

The following examples are variants of the example for d01paf, modified to demonstrate calling the NAG AD Library.
Description of the primal example.
This example demonstrates the use of the subroutine with the integral
01 01-x 01-x-y exp(x+y+z) cos(x+y+z) dz dy dx = 14 .  

10.1 Adjoint modes

Language Source File Data Results
Fortran d01pa_a1w_fe.f90 None d01pa_a1w_fe.r
C++ d01pa_a1w_hcppe.cpp None d01pa_a1w_hcppe.r

10.2 Tangent modes

Language Source File Data Results
Fortran d01pa_t1w_fe.f90 None d01pa_t1w_fe.r
C++ d01pa_t1w_hcppe.cpp None d01pa_t1w_hcppe.r

10.3 Passive mode

Language Source File Data Results
Fortran d01pa_p0w_fe.f90 None d01pa_p0w_fe.r
C++ d01pa_p0w_hcppe.cpp None d01pa_p0w_hcppe.r