f08fa is the AD Library version of the primal routine f08faf (dsyev). Based (in the C++ interface) on overload resolution, f08fa can be used for primal, tangent and adjoint evaluation. It supports tangents and adjoints of first order.

2 Specification

Fortran Interface

Subroutine f08fa_AD_f (

ad_handle, jobz, uplo, n, a, lda, w, work, lwork, ifail)

Integer, Intent (In)	::	n, lda, lwork
Integer, Intent (Inout)	::	ifail
ADTYPE, Intent (Inout)	::	a(lda,*)
ADTYPE, Intent (Out)	::	w(n), work(max(1,lwork))
Character (1), Intent (In)	::	jobz, uplo
Type (c_ptr), Intent (Inout)	::	ad_handle

Corresponding to the overloaded C++ function, the Fortran interface provides five routines with names reflecting the type used for active real arguments. The actual subroutine and type names are formed by replacing AD and ADTYPE in the above as follows:

when ADTYPE is	Real(kind=nag_wp)	then AD is p0w
when ADTYPE is	Type(nagad_a1w_w_rtype)	then AD is a1w
when ADTYPE is	Type(nagad_t1w_w_rtype)	then AD is t1w

C++ Header Interface

#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {

void f08fa (

void *&ad_handle, const char *jobz, const char *uplo, const Integer &n, ADTYPE a[], const Integer &lda, ADTYPE w[], ADTYPE work[], const Integer &lwork, Integer &ifail)

}
}

The function is overloaded on ADTYPE which represents the type of active arguments. ADTYPE may be any of the following types:
double,
dco::ga1s<double>::type,
dco::gt1s<double>::type

Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.

3 Description

f08fa is the AD Library version of the primal routine f08faf (dsyev).

f08faf (dsyev) computes all the eigenvalues and, optionally, all the eigenvectors of a real

n \times n

symmetric matrix

A

. For further information see Section 3 in the documentation for f08faf (dsyev).

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

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, f08fa 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 – Pointer to AD Data Input/Output: On entry: a handle to the AD configuration data object, as created by x10aa.
2: jobz – character Input
3: uplo – character Input
4: n – Integer Input
5: a(lda, $*$ ) – ADTYPE array Input/Output
6: lda – Integer Input
7: w(n) – ADTYPE array Output
8: work( $\max (1, lwork)$ ) – ADTYPE array Workspace
9: lwork – Integer Input
10: 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

f08fa uses the standard NAG ifail mechanism. Any errors indicated via info values returned by f08faf 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 = - 199$: The routine was called using a mode that has not yet been implemented.

$ifail = - 443$: On entry: ad_handle is nullptr.
This check is only made if the overloaded C++ interface is used with arguments not of type double.

$ifail = - 444$: A C++ exception was thrown.
The error message will show the details of the C++ exception text.

$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

f08fa is not threaded in any implementation.

9 Further Comments

None.

10 Example

A NAG AD Library example is not yet available, please refer to the NAG AD Library Introduction for information on calling routines from the AD Library.

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

F08 (Lapackeig) Chapter Contents

F08 (Lapackeig) Chapter Introduction (FL)

f08fa: FL CL CPP AD

NAG AD Libraryf08fa (dsyev)

▸▿ Contents

1 Purpose