NAG Library Manual, Mark 27.1
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 Library
f11zb_a1w_f (real_symm_sort_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.
NAG Library Manual, Mark 27.1
Interfaces:  FL   CL   CPP   AD 
NAG AD Library Introduction
F11 (Sparse) Chapter Contents
F11 (Sparse) Chapter Introduction (FL)
f11zb:  FL   CL   CPP   AD 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2020
Settings help

AD Name Style:


AD Specification Language:

1 Purpose

f11zb_a1w_f is the adjoint version of the primal routine f11zbf.

2 Specification

Fortran Interface
Subroutine f11zb_a1w_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)
Type (nagad_a1w_w_rtype), Intent (Inout) :: a(*)
Character (1), Intent (In) :: dup, zer
Type (c_ptr), Intent (Inout) :: ad_handle
C++ Header Interface
#include <nagad.h>
void f11zb_a1w_f_ ( void *&ad_handle, const Integer &n, Integer &nnz, nagad_a1w_w_rtype a[], Integer irow[], Integer icol[], const char *dup, const char *zer, Integer istr[], Integer iwork[], Integer &ifail, const Charlen length_dup, const Charlen length_zer)
The routine may be called by the names f11zb_a1w_f or nagf_sparse_real_symm_sort_a1w. The corresponding t1w and p0w variants of this routine are also available.

3 Description

f11zb_a1w_f is the adjoint 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_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.
2: n – Integer Input
3: nnz – Integer Input/Output
4: a(*) – Type (nagad_a1w_w_rtype) array Input/Output
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_a1w_f 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 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.

7 Accuracy

Not applicable.

8 Parallelism and Performance

f11zb_a1w_f 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.1
Interfaces:  FL   CL   CPP   AD 
NAG AD Library Introduction
F11 (Sparse) Chapter Contents
F11 (Sparse) Chapter Introduction (FL)
f11zb:  FL   CL   CPP   AD 
© The Numerical Algorithms Group Ltd. 2020