f08kd: FL CL CPP AD

NAG AD Library
f08kd_a1w_f (dgesdd_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

F08 (Lapackeig) Chapter Contents

F08 (Lapackeig) Chapter Introduction (FL)

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

f08kd_a1w_f is the adjoint version of the primal routine f08kdf (dgesdd). Depending on the value of ad_handle, f08kd_a1w_f uses algorithmic differentiation or symbolic adjoints to compute adjoints of the primal.

2 Specification

Fortran Interface

Subroutine f08kd_a1w_f (

ad_handle, jobz, m, n, a, lda, s, u, ldu, vt, ldvt, work, lwork, iwork, ifail)

Integer, Intent (In)	::	m, n, lda, ldu, ldvt, lwork
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	iwork(8*min(m,n))
Type (nagad_a1w_w_rtype), Intent (Inout)	::	a(lda,), u(ldu,), vt(ldvt,*)
Type (nagad_a1w_w_rtype), Intent (Out)	::	s(min(m,n)), work(max(1,lwork))
Character (1), Intent (In)	::	jobz
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

#include <nagad.h>

void f08kd_a1w_f_ (

void *&ad_handle, const char *jobz, const Integer &m, const Integer &n, nagad_a1w_w_rtype a[], const Integer &lda, nagad_a1w_w_rtype s[], nagad_a1w_w_rtype u[], const Integer &ldu, nagad_a1w_w_rtype vt[], const Integer &ldvt, nagad_a1w_w_rtype work[], const Integer &lwork, Integer iwork[], Integer &ifail, const Charlen length_jobz)

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

3 Description

f08kd_a1w_f is the adjoint version of the primal routine f08kdf (dgesdd).

f08kdf (dgesdd) computes the singular value decomposition (SVD) of a real

m \times n

matrix

A

, optionally computing the left and/or right singular vectors, by using a divide-and-conquer method. For further information see Section 3 in the documentation for f08kdf (dgesdd).

3.1 Symbolic Adjoint

f08kd_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.

The symbolic adjoint allows you to compute the adjoints of the output arguments:

(i)for argument s,
(ii)the first $\min (m, n)$ columns of u and
(iii)the first $\min (m, n)$ rows of vt.

The symbolic adjoint assumes that the primal routine has successfully converged. Moreover for considering the adjoints of s the first

\min (m, n)

columns of u and the first

\min (m, n)

rows of vt are required. To consider the adjoints of the first

\min (m, n)

columns of u and/or the first

\min (m, n)

rows of vt the algorithm requires the computation of all entries of the matrices

U

and

V

Hence (to compute the desired adjoint) if the routine is run with

jobz ='N'

the SVD decomposition is performed by calling f08kd_a1w_f with

jobz ='S'

(you must ensure that all arrays are allocated as specified for

jobz ='S'

). The results are stored according to the value jobz you provided.

For all other settings of jobz the SVD decomposition is performed by calling the f08kdf with

jobz ='A'

(you must ensure that all arrays are allocated as specified for

jobz ='A'

). The results are stored according to the value jobz you provided.

3.1.1 Mathematical Background

The symbolic adjoint uses the SVD decomposition computed by the primal routine to obtain the adjoints. To compute the adjoints it is required that

(i) $σ_{i} \neq σ_{j}$ for all $i \neq j$ , $1 \leq i, j \leq \min (m, n)$ ;
(ii)if $m \neq n$ then $σ_{i} \neq 0$ for all $1 \leq i \leq \min (m, n)$ ,

where

σ_{i}

denotes the

i

th singular value of matrix

A

. Please see Giles (2017) for more details.

3.1.2 Usable adjoints

You can set or access the adjoints of the output arguments a if

jobz ='O'

, s, u if

jobz \neq'O'

and

m \geq n

, and vt if

jobz \neq'O'

and

m < n

. The adjoints of all other output arguments are ignored.

f08kd_a1w_f increments the adjoints of input argument a 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

Giles M (2017) Collected Matrix Derivative Results for Forward and Reverse Mode Algorithmic Differentiation

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5 Arguments

In addition to the arguments present in the interface of the primal routine, f08kd_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: jobz – character Input
3: m – Integer Input
4: n – Integer Input
5: a(lda, $*$ ) – Type (nagad_a1w_w_rtype) array Input/Output
6: lda – Integer Input
7: s( $\min (m, n)$ ) – Type (nagad_a1w_w_rtype) array Output
8: u(ldu, $*$ ) – Type (nagad_a1w_w_rtype) array Output
9: ldu – Integer Input
10: vt(ldvt, $*$ ) – Type (nagad_a1w_w_rtype) array Output
11: ldvt – Integer Input
12: work( $\max (1, lwork)$ ) – Type (nagad_a1w_w_rtype) array Workspace
13: lwork – Integer Input
14: iwork( $8 \times \min (m, n)$ ) – Integer array Workspace
15: 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

f08kd_a1w_f uses the standard NAG ifail mechanism. Any errors indicated via info values returned by f08kdf 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.

In symbolic mode the following may be returned:

7 Accuracy

Not applicable.

8 Parallelism and Performance

f08kd_a1w_f is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

10.1 Adjoint mode (a1w)

Language	Source File	Data	Results
Fortran	f08kd_a1w_fe.f90	f08kd_a1w_fe.d	f08kd_a1w_fe.r
C++	f08kd_a1w_hcppe.cpp	f08kd_a1w_hcppe.d	f08kd_a1w_hcppe.r

10.2 Tangent mode (t1w)

Language	Source File	Data	Results
Fortran	f08kd_t1w_fe.f90	f08kd_t1w_fe.d	f08kd_t1w_fe.r
C++	f08kd_t1w_hcppe.cpp	f08kd_t1w_hcppe.d	f08kd_t1w_hcppe.r

10.3 Passive mode (p0w)

Language	Source File	Data	Results
Fortran	f08kd_p0w_fe.f90	f08kd_p0w_fe.d	f08kd_p0w_fe.r
C++	f08kd_p0w_hcppe.cpp	f08kd_p0w_hcppe.d	f08kd_p0w_hcppe.r