e01be
is the AD Library version of the primal routine
e01bef.
Based (in the C++ interface) on overload resolution,
e01be can be used for primal, tangent and adjoint
evaluation. It supports tangents and adjoints of first and second order.
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:
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, dco::gt1s<dco::gt1s<double>::type>::type, dco::ga1s<dco::gt1s<double>::type>::type,
Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.
3Description
e01be
is the AD Library version of the primal routine
e01bef.
e01bef computes a monotonicity-preserving piecewise cubic Hermite interpolant to a set of data points.
For further information see Section 3 in the documentation for e01bef.
4References
Fritsch F N (1982) PCHIP final specifications Report UCID-30194 Lawrence Livermore National Laboratory
Fritsch F N and Butland J (1984) A method for constructing local monotone piecewise cubic interpolants SIAM J. Sci. Statist. Comput.5 300–304
5Arguments
In addition to the arguments present in the interface of the primal routine,
e01be 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.
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.
e01be preserves all error codes from e01bef and in addition can return:
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.
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.
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
Dynamic memory allocation failed for AD.
See Error Handling in the NAG AD Library Introduction for further information.
7Accuracy
Not applicable.
8Parallelism and Performance
e01be
is not threaded in any implementation.
9Further Comments
None.
10Example
The following examples are variants of the example for
e01bef,
modified to demonstrate calling the NAG AD Library.
Description of the primal example.
This example reads in a set of data points, calls
e01be to compute a piecewise monotonic interpolant,
and then calls e01bf to evaluate the interpolant at equally spaced points.