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

2 Specification

Fortran Interface

Subroutine f03ba_AD_f (

ad_handle, n, a, lda, ipiv, d, id, ifail)

Integer, Intent (In)	::	n, lda, ipiv(n)
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	id
ADTYPE, Intent (In)	::	a(lda,*)
ADTYPE, Intent (Out)	::	d
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 f03ba (

void *&ad_handle, const Integer &n, const ADTYPE a[], const Integer &lda, const Integer ipiv[], ADTYPE &d, Integer &id, 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

f03ba is the AD Library version of the primal routine f03baf.

f03baf computes the determinant of a real

n \times n

matrix

A

. f07adf must be called first to supply the matrix

A

in factorized form. For further information see Section 3 in the documentation for f03baf.

4 References

Wilkinson J H and Reinsch C (1971) Handbook for Automatic Computation II, Linear Algebra Springer–Verlag

5 Arguments

In addition to the arguments present in the interface of the primal routine, f03ba 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: n – Integer Input
3: a(lda, $*$ ) – ADTYPE array Input
4: lda – Integer Input
5: ipiv(n) – Integer array Input
6: d – ADTYPE Output
7: id – Integer Output
8: ifail – Integer Input/Output

6 Error Indicators and Warnings

f03ba preserves all error codes from f03baf 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 = - 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

f03ba is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

Description of the primal example.

This example computes the

L U

factorization with partial pivoting, and calculates the determinant, of the real matrix

(\begin{array}{r} 33 & 16 & 72 \\ −24 & −10 & −57 \\ −8 & −4 & −17 \end{array}) .

10.1 Adjoint modes

Language	Source File	Data	Results
Fortran	f03ba_a1w_fe.f90	f03ba_a1w_fe.d	f03ba_a1w_fe.r
C++	f03ba_a1w_hcppe.cpp	f03ba_a1w_hcppe.d	f03ba_a1w_hcppe.r

10.2 Tangent modes

Language	Source File	Data	Results
Fortran	f03ba_t1w_fe.f90	f03ba_t1w_fe.d	f03ba_t1w_fe.r
C++	f03ba_t1w_hcppe.cpp	f03ba_t1w_hcppe.d	f03ba_t1w_hcppe.r

10.3 Passive mode

Language	Source File	Data	Results
Fortran	f03ba_p0w_fe.f90	f03ba_p0w_fe.d	f03ba_p0w_fe.r
C++	f03ba_p0w_hcppe.cpp	f03ba_p0w_hcppe.d	f03ba_p0w_hcppe.r

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

F03 (Det) Chapter Contents

F03 (Det) Chapter Introduction (FL)

f03ba: FL CL CPP AD

NAG AD Libraryf03ba (real_gen)

▸▿ Contents

1 Purpose