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

2 Specification

Fortran Interface

Subroutine f07ar_AD_f (

ad_handle, m, n, a, lda, ipiv, ifail)

Integer, Intent (In)	::	m, n, lda
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	ipiv(min(m,n))
ADCTYPE, Intent (Inout)	::	a(lda,*)
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 f07ar (

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

f07ar is the AD Library version of the primal routine f07arf (zgetrf).

f07arf (zgetrf) computes the

L U

factorization of a complex

m \times n

matrix. For further information see Section 3 in the documentation for f07arf (zgetrf).

4 References

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, f07ar 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: m – Integer Input
3: n – Integer Input
4: a(lda, $*$ ) – ADCTYPE array Input/Output
5: lda – Integer Input
6: ipiv( $\min (m, n)$ ) – Integer array Output
7: 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

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

f07ar is not threaded in any implementation.

9 Further Comments

None.

10 Example

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

Description of the primal example.

This example computes the

L U

factorization of the matrix

A

, where

A = (\begin{array}{r} - 1.34 + 2.55 i & 0.28 + 3.17 i & - 6.39 - 2.20 i & 0.72 - 0.92 i \\ - 0.17 - 1.41 i & 3.31 - 0.15 i & - 0.15 + 1.34 i & 1.29 + 1.38 i \\ - 3.29 - 2.39 i & - 1.91 + 4.42 i & - 0.14 - 1.35 i & 1.72 + 1.35 i \\ 2.41 + 0.39 i & - 0.56 + 1.47 i & - 0.83 - 0.69 i & - 1.96 + 0.67 i \end{array}) .

10.1 Adjoint modes

Language	Source File	Data	Results
Fortran	f07ar_a1w_fe.f90	f07ar_a1w_fe.d	f07ar_a1w_fe.r
C++	f07ar_a1w_hcppe.cpp	f07ar_a1w_hcppe.d	f07ar_a1w_hcppe.r

10.2 Tangent modes

Language	Source File	Data	Results
Fortran	f07ar_t1w_fe.f90	f07ar_t1w_fe.d	f07ar_t1w_fe.r
C++	f07ar_t1w_hcppe.cpp	f07ar_t1w_hcppe.d	f07ar_t1w_hcppe.r

10.3 Passive mode

Language	Source File	Data	Results
Fortran	f07ar_p0w_fe.f90	f07ar_p0w_fe.d	f07ar_p0w_fe.r
C++	f07ar_p0w_hcppe.cpp	f07ar_p0w_hcppe.d	f07ar_p0w_hcppe.r

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

F07 (Lapacklin) Chapter Contents

F07 (Lapacklin) Chapter Introduction (FL)

f07ar: FL CL CPP AD

NAG AD Libraryf07ar (zgetrf)

▸▿ Contents

1 Purpose