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

2 Specification

Fortran Interface

Subroutine f11zb_AD_f (

ad_handle, n, nnz, a, irow, icol, dup, zer, istr, iwork, ifail)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	nnz, irow(), icol(), ifail
Integer, Intent (Out)	::	istr(n+1), iwork(n)
ADTYPE, Intent (Inout)	::	a(*)
Character (1), Intent (In)	::	dup, zer
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++ Interface

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

void f11zb (

handle_t &ad_handle, const Integer &n, Integer &nnz, ADTYPE a[], Integer irow[], Integer icol[], const char *dup, const char *zer, Integer istr[], Integer iwork[], 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

f11zb is the AD Library version of the primal routine f11zbf.

f11zbf sorts the nonzero elements of a real sparse symmetric matrix, represented in symmetric coordinate storage format. For further information see Section 3 in the documentation for f11zbf.

4 References

5 Arguments

In addition to the arguments present in the interface of the primal routine, f11zb 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 – nag::ad::handle_t Input/Output: On entry: a configuration object that holds information on the differentiation strategy. Details on setting the AD strategy are described in AD handle object in the NAG AD Library Introduction.
2: n – Integer Input
3: nnz – Integer Input/Output
4: a( $*$ ) – ADTYPE array Input/Output: Please consult Overwriting of Inputs in the NAG AD Library Introduction.
5: irow( $*$ ) – Integer array Input/Output
6: icol( $*$ ) – Integer array Input/Output
7: dup – character Input
8: zer – character Input
9: istr( $n + 1$ ) – Integer array Output
10: iwork(n) – Integer array Workspace
11: ifail – Integer Input/Output

6 Error Indicators and Warnings

f11zb preserves all error codes from f11zbf and in addition can return:

$ifail = - 89$: An unexpected AD error has been triggered by this routine. Please contact NAG.
See Error Handling in the NAG AD Library Introduction for further information.

$ifail = - 199$: The routine was called using a strategy that has not yet been implemented.
See AD Strategies in the NAG AD Library Introduction for further information.

$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 Error Handling in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

f11zb 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 30.3

Interfaces: FL CL CPP AD

NAG AD Library Introduction

F11 (Sparse) Chapter Contents

F11 (Sparse) Chapter Introduction (FL)

f11zb: FL CL CPP AD

NAG AD Libraryf11zb (real_symm_sort)

▸▿ Contents

1 Purpose