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

2 Specification

Fortran Interface

Subroutine s18de_AD_f (

ad_handle, fnu, z, n, scal, cy, nz, ifail)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	nz
ADTYPE, Intent (In)	::	fnu
ADCTYPE, Intent (In)	::	z
ADCTYPE, Intent (Out)	::	cy(n)
Character (1), Intent (In)	::	scal
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 s18de (

void *&ad_handle, const ADTYPE &fnu, const ADCTYPE &z, const Integer &n, const char *scal, ADCTYPE cy[], Integer &nz, 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

s18de is the AD Library version of the primal routine s18def.

s18def returns a sequence of values for the modified Bessel functions

I_{ν + n} (z)

for complex

z

, non-negative

ν

and

n = 0, 1, \dots, N - 1

, with an option for exponential scaling. For further information see Section 3 in the documentation for s18def.

4 References

NIST Digital Library of Mathematical Functions

Amos D E (1986) Algorithm 644: A portable package for Bessel functions of a complex argument and non-negative order ACM Trans. Math. Software 12 265–273

5 Arguments

In addition to the arguments present in the interface of the primal routine, s18de 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: fnu – ADTYPE Input
3: z – ADCTYPE Input
4: n – Integer Input
5: scal – character Input
6: cy(n) – ADCTYPE array Output
7: nz – Integer Output
8: ifail – Integer Input/Output

6 Error Indicators and Warnings

s18de preserves all error codes from s18def 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

s18de is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

Description of the primal example.

This example prints a caption and then proceeds to read sets of data from the input data stream. The first datum is a value for the order fnu, the second is a complex value for the argument, z, and the third is a character value to set the argument scal. The program calls the routine with