f07ca: FL CL CPP AD

NAG AD Library
f07ca_a1w_f (dgtsv_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

F07 (Lapacklin) Chapter Contents

F07 (Lapacklin) Chapter Introduction (FL)

f07ca: FL CL CPP AD

▸▿ Contents

1 Purpose

2 Specification

▸▿ 3 Description

▸▿ 3.1 Symbolic Adjoint

3.1.1 Mathematical Background

3.1.2 Usable Adjoints

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

f07ca_a1w_f is the adjoint version of the primal routine f07caf (dgtsv). Depending on the value of ad_handle, f07ca_a1w_f uses algorithmic differentiation or symbolic adjoints to compute adjoints of the primal.

2 Specification

Fortran Interface

Subroutine f07ca_a1w_f (

ad_handle, n, nrhs, dl, d, du, b, ldb, ifail)

Integer, Intent (In)	::	n, nrhs, ldb
Integer, Intent (Inout)	::	ifail
Type (nagad_a1w_w_rtype), Intent (Inout)	::	dl(), d(), du(), b(ldb,)
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void f07ca_a1w_f_ (

void *&ad_handle, const Integer &n, const Integer &nrhs, nagad_a1w_w_rtype dl[], nagad_a1w_w_rtype d[], nagad_a1w_w_rtype du[], nagad_a1w_w_rtype b[], const Integer &ldb, Integer &ifail)

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

3 Description

f07ca_a1w_f is the adjoint version of the primal routine f07caf (dgtsv).

f07caf (dgtsv) computes the solution to a real system of linear equations

A X = B,

where

A

is an

n \times n

tridiagonal matrix and

X

and

B

are

n \times r

matrices. For further information see Section 3 in the documentation for f07caf (dgtsv).

3.1 Symbolic Adjoint

f07ca_a1w_f can provide symbolic adjoints by setting the symbolic mode as described in Section 3.2.2 in the X10 Chapter introduction. Please see Section 4 in the Introduction to the NAG AD Library for API description on how to use symbolic adjoints.

3.1.1 Mathematical Background

The symbolic adjoint uses the

L U

decomposition computed by the primal routine to obtain the adjoint of the right-hand side

B

by solving

A^{T} \cdot B_{i, (1)} = X_{i, (1)},

(1)

where

B_{i, (1)}

and

X_{i, (1)}

denote the

i

th column of the matrices

B_{(1)}

and

X_{(1)}

respectively. The adjoint of the matrix

A

is then computed according to

A_{(1)} = \sum_{i = 1}^{r} - B_{i, (1)} \cdot X_{i}^{T},

(2)

where

B_{i, (1)}

and

X_{i}

denote the

i

th column of the matrices

B_{(1)}

and

X

respectively.

Please see Du Toit and Naumann (2017).

3.1.2 Usable Adjoints

You can set or access the adjoints of output argument b. The adjoints of all other output arguments are ignored.

f07ca_a1w_f increments the adjoints of input arguments b, d, du and dl according to the first order adjoint model.

4 References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia https://www.netlib.org/lapack/lug

Du Toit J, Naumann U (2017) Adjoint Algorithmic Differentiation Tool Support for Typical Numerical Patterns in Computational Finance

5 Arguments

In addition to the arguments present in the interface of the primal routine, f07ca_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/Output: On entry: a handle to the AD configuration data object, as created by x10aa_a1w_f. Symbolic adjoint mode may be selected by calling x10aa_a1w_f with this handle.
2: n – Integer Input
3: nrhs – Integer Input
4: dl( $*$ ) – Type (nagad_a1w_w_rtype) array Input/Output
5: d( $*$ ) – Type (nagad_a1w_w_rtype) array Input/Output
6: du( $*$ ) – Type (nagad_a1w_w_rtype) array Input/Output
7: b(ldb, $*$ ) – Type (nagad_a1w_w_rtype) array Input/Output
8: ldb – Integer Input
9: ifail – Integer Input/Output: On entry: must be set to $0$ , $- 1 or 1$ .
On exit: any errors are indicated as described in Section 6.

6 Error Indicators and Warnings

f07ca_a1w_f uses the standard NAG ifail mechanism. Any errors indicated via info values returned by f07caf may be indicated with the same value returned by ifail. In addition, this routine may 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

f07ca_a1w_f is not threaded in any implementation.

9 Further Comments

None.

10 Example

The following examples are variants of the example for f07caf (dgtsv), modified to demonstrate calling the NAG AD Library.

10.1 Adjoint mode (a1w)

Language	Source File	Data	Results
Fortran	f07ca_a1w_fe.f90	f07ca_a1w_fe.d	f07ca_a1w_fe.r
C++	f07ca_a1w_hcppe.cpp	f07ca_a1w_hcppe.d	f07ca_a1w_hcppe.r

10.2 Tangent mode (t1w)

Language	Source File	Data	Results
Fortran	f07ca_t1w_fe.f90	f07ca_t1w_fe.d	f07ca_t1w_fe.r
C++	f07ca_t1w_hcppe.cpp	f07ca_t1w_hcppe.d	f07ca_t1w_hcppe.r

10.3 Passive mode (p0w)

Language	Source File	Data	Results
Fortran	f07ca_p0w_fe.f90	f07ca_p0w_fe.d	f07ca_p0w_fe.r
C++	f07ca_p0w_hcppe.cpp	f07ca_p0w_hcppe.d	f07ca_p0w_hcppe.r