f11xe: FL CL CPP AD

NAG AD Library
f11xe_a1w_f (real_symm_matvec_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

F11 (Sparse) Chapter Contents

F11 (Sparse) Chapter Introduction (FL)

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

f11xe_a1w_f is the adjoint version of the primal routine f11xef.

2 Specification

Fortran Interface

Subroutine f11xe_a1w_f (

ad_handle, n, nnz, a, irow, icol, check, x, y, ifail)

Integer, Intent (In)	::	n, nnz, irow(nnz), icol(nnz)
Integer, Intent (Inout)	::	ifail
Type (nagad_a1w_w_rtype), Intent (In)	::	a(nnz), x(n)
Type (nagad_a1w_w_rtype), Intent (Out)	::	y(n)
Character (1), Intent (In)	::	check
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void f11xe_a1w_f_ (

void *&ad_handle, const Integer &n, const Integer &nnz, const nagad_a1w_w_rtype a[], const Integer irow[], const Integer icol[], const char *check, const nagad_a1w_w_rtype x[], nagad_a1w_w_rtype y[], Integer &ifail, const Charlen length_check)

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

3 Description

f11xe_a1w_f is the adjoint version of the primal routine f11xef.

f11xef computes a matrix-vector product involving a real sparse symmetric matrix stored in symmetric coordinate storage format. For further information see Section 3 in the documentation for f11xef.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, f11xe_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.
2: n – Integer Input
3: nnz – Integer Input
4: a(nnz) – Type (nagad_a1w_w_rtype) array Input
5: irow(nnz) – Integer array Input
6: icol(nnz) – Integer array Input
7: check – character Input
8: x(n) – Type (nagad_a1w_w_rtype) array Input
9: y(n) – Type (nagad_a1w_w_rtype) array Output
10: ifail – Integer Input/Output

6 Error Indicators and Warnings

f11xe_a1w_f preserves all error codes from f11xef 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

f11xe_a1w_f is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

10.1 Adjoint mode (a1w)

Language	Source File	Data	Results
Fortran	f11xe_a1w_fe.f90	f11xe_a1w_fe.d	f11xe_a1w_fe.r
C++	f11xe_a1w_hcppe.cpp	f11xe_a1w_hcppe.d	f11xe_a1w_hcppe.r

10.2 Tangent mode (t1w)

Language	Source File	Data	Results
Fortran	f11xe_t1w_fe.f90	f11xe_t1w_fe.d	f11xe_t1w_fe.r
C++	f11xe_t1w_hcppe.cpp	f11xe_t1w_hcppe.d	f11xe_t1w_hcppe.r

10.3 Passive mode (p0w)

Language	Source File	Data	Results
Fortran	f11xe_p0w_fe.f90	f11xe_p0w_fe.d	f11xe_p0w_fe.r
C++	f11xe_p0w_hcppe.cpp	f11xe_p0w_hcppe.d	f11xe_p0w_hcppe.r