f01ef: FL CL CPP AD

NAG AD Library
f01ef_a1w_f (real_symm_matrix_fun_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

F01 (Matop) Chapter Contents

F01 (Matop) Chapter Introduction (FL)

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

f01ef_a1w_f is the adjoint version of the primal routine f01eff.

2 Specification

Fortran Interface

Subroutine f01ef_a1w_f (

ad_handle, uplo, n, a, lda, f, iflag, iuser, ruser, ifail)

Integer, Intent (In)	::	n, lda
Integer, Intent (Inout)	::	iuser(*), ifail
Integer, Intent (Out)	::	iflag
Type (nagad_a1w_w_rtype), Intent (Inout)	::	a(lda,), ruser()
Character (1), Intent (In)	::	uplo
Type (c_ptr), Intent (Inout)	::	ad_handle
External	::	f

C++ Header Interface

#include <nagad.h>

void f01ef_a1w_f_ (

void *&ad_handle, const char *uplo, const Integer &n, nagad_a1w_w_rtype a[], const Integer &lda,
void (NAG_CALL f)(void *&ad_handle, Integer &iflag, const Integer &n, const nagad_a1w_w_rtype x[], nagad_a1w_w_rtype fx[], Integer iuser[], nagad_a1w_w_rtype ruser[]),
Integer &iflag, Integer iuser[], nagad_a1w_w_rtype ruser[], Integer &ifail, const Charlen length_uplo)

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

3 Description

f01ef_a1w_f is the adjoint version of the primal routine f01eff.

f01eff computes the matrix function,

f (A)

, of a real symmetric

n \times n

matrix

A

f (A)

must also be a real symmetric matrix. For further information see Section 3 in the documentation for f01eff.

4 References

Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA

5 Arguments

In addition to the arguments present in the interface of the primal routine, f01ef_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: uplo – character Input

3: n – Integer Input

4: a(lda, $*$ ) – Type (nagad_a1w_w_rtype) array Input/Output

5: lda – Integer Input

6: f – Subroutine External Procedure

The specification of f is:

Fortran Interface

Subroutine f (

ad_handle, iflag, n, x, fx, iuser, ruser)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	iflag, iuser(*)
Type (nagad_a1w_w_rtype), Intent (In)	::	x(n)
Type (nagad_a1w_w_rtype), Intent (Inout)	::	ruser(*)
Type (nagad_a1w_w_rtype), Intent (Out)	::	fx(n)
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void f (

void *&ad_handle, Integer &iflag, const Integer &n, const nagad_a1w_w_rtype x[], nagad_a1w_w_rtype fx[], Integer iuser[], nagad_a1w_w_rtype ruser[])

1: ad_handle – Type (c_ptr) Input/Output: On entry: a handle to the AD configuration data object.
2: iflag – Integer Input/Output
3: n – Integer Input
4: x – Type (nagad_a1w_w_rtype) array Input
5: fx – Type (nagad_a1w_w_rtype) array Output
6: iuser – Integer array User Workspace
7: ruser – Type (nagad_a1w_w_rtype) array User Workspace

7: iflag – Integer Output

8: iuser( $*$ ) – Integer array User Workspace

9: ruser( $*$ ) – Type (nagad_a1w_w_rtype) array User Workspace

10: ifail – Integer Input/Output

6 Error Indicators and Warnings

f01ef_a1w_f preserves all error codes from f01eff 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

f01ef_a1w_f is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

10.1 Adjoint mode (a1w)

Language	Source File	Data	Results
Fortran	f01ef_a1w_fe.f90	f01ef_a1w_fe.d	f01ef_a1w_fe.r
C++	f01ef_a1w_hcppe.cpp	f01ef_a1w_hcppe.d	f01ef_a1w_hcppe.r

10.2 Tangent mode (t1w)

Language	Source File	Data	Results
Fortran	f01ef_t1w_fe.f90	f01ef_t1w_fe.d	f01ef_t1w_fe.r
C++	f01ef_t1w_hcppe.cpp	f01ef_t1w_hcppe.d	f01ef_t1w_hcppe.r

10.3 Passive mode (p0w)

Language	Source File	Data	Results
Fortran	f01ef_p0w_fe.f90	f01ef_p0w_fe.d	f01ef_p0w_fe.r
C++	f01ef_p0w_hcppe.cpp	f01ef_p0w_hcppe.d	f01ef_p0w_hcppe.r