s01ba: FL CL CPP AD

NAG AD Library
s01ba_a1w_f (log_shifted_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

S (Specfun) Chapter Contents

S (Specfun) Chapter Introduction (FL)

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

10.1 Adjoint mode (a1w)

10.2 Tangent mode (t1w)

10.3 Passive mode (p0w)

1 Purpose

s01ba_a1w_f is the adjoint version of the primal routine s01baf.

2 Specification

Fortran Interface

Subroutine s01ba_a1w_f (

ad_handle, x, lnx1, ifail)

Integer, Intent (Inout)	::	ifail
Type (nagad_a1w_w_rtype), Intent (In)	::	x
Type (nagad_a1w_w_rtype), Intent (Out)	::	lnx1
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void s01ba_a1w_f_ (

void *&ad_handle, const nagad_a1w_w_rtype &x, nagad_a1w_w_rtype &lnx1, Integer &ifail)

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

3 Description

s01ba_a1w_f is the adjoint version of the primal routine s01baf.

s01baf returns a value of the shifted logarithmic function,

\ln (1 + x)

, via the function name. For further information see Section 3 in the documentation for s01baf.

4 References

Lyusternik L A, Chervonenkis O A and Yanpolskii A R (1965) Handbook for Computing Elementary Functions p. 57 Pergamon Press

5 Arguments

In addition to the arguments present in the interface of the primal routine, s01ba_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 s01ba_a1w_f, is a subroutine, where the function value is returned in the additional output parameter, lnx1.

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: x – Type (nagad_a1w_w_rtype) Input
3: lnx1 – Type (nagad_a1w_w_rtype) Output: On exit: the value of the shifted logarithmic function, $\ln (1 + x)$ .
4: ifail – Integer Input/Output

6 Error Indicators and Warnings

s01ba_a1w_f preserves all error codes from s01baf 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 = - 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

s01ba_a1w_f is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

10.1 Adjoint mode (a1w)

Language	Source File	Data	Results
Fortran	s01ba_a1w_fe.f90	s01ba_a1w_fe.d	s01ba_a1w_fe.r
C++	s01ba_a1w_hcppe.cpp	s01ba_a1w_hcppe.d	s01ba_a1w_hcppe.r

10.2 Tangent mode (t1w)

Language	Source File	Data	Results
Fortran	s01ba_t1w_fe.f90	s01ba_t1w_fe.d	s01ba_t1w_fe.r
C++	s01ba_t1w_hcppe.cpp	s01ba_t1w_hcppe.d	s01ba_t1w_hcppe.r

10.3 Passive mode (p0w)

Language	Source File	Data	Results
Fortran	s01ba_p0w_fe.f90	s01ba_p0w_fe.d	s01ba_p0w_fe.r
C++	s01ba_p0w_hcppe.cpp	s01ba_p0w_hcppe.d	s01ba_p0w_hcppe.r