NAG Library Routine Document

e01tnf (dim5_scat_shep_eval)

1
Purpose

e01tnf evaluates the five-dimensional interpolating function generated by e01tmf and its first partial derivatives.

2
Specification

Fortran Interface
Subroutine e01tnf ( m, x, f, iq, rq, n, xe, q, qx, ifail)
Integer, Intent (In):: m, iq(2*m+1), n
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (In):: x(5,m), f(m), rq(21*m+11), xe(5,n)
Real (Kind=nag_wp), Intent (Out):: q(n), qx(5,n)
C Header Interface
#include <nagmk26.h>
void  e01tnf_ (const Integer *m, const double x[], const double f[], const Integer iq[], const double rq[], const Integer *n, const double xe[], double q[], double qx[], Integer *ifail)

3
Description

e01tnf takes as input the interpolant Q x , x5 of a set of scattered data points xr,fr , for r=1,2,,m, as computed by e01tmf, and evaluates the interpolant and its first partial derivatives at the set of points xi, for i=1,2,,n.
e01tnf must only be called after a call to e01tmf.
e01tnf is derived from the new implementation of QS3GRD described by Renka (1988). It uses the modification for five-dimensional interpolation described by Berry and Minser (1999).

4
References

Berry M W, Minser K S (1999) Algorithm 798: high-dimensional interpolation using the modified Shepard method ACM Trans. Math. Software 25 353–366
Renka R J (1988) Algorithm 661: QSHEP3D: Quadratic Shepard method for trivariate interpolation of scattered data ACM Trans. Math. Software 14 151–152

5
Arguments

1:     m – IntegerInput
On entry: must be the same value supplied for argument m in the preceding call to e01tmf.
Constraint: m23.
2:     x5m – Real (Kind=nag_wp) arrayInput
On entry: must be the same array supplied as argument x in the preceding call to e01tmf. It must remain unchanged between calls.
3:     fm – Real (Kind=nag_wp) arrayInput
On entry: must be the same array supplied as argument f in the preceding call to e01tmf. It must remain unchanged between calls.
4:     iq2×m+1 – Integer arrayInput
On entry: must be the same array returned as argument iq in the preceding call to e01tmf. It must remain unchanged between calls.
5:     rq21×m+11 – Real (Kind=nag_wp) arrayInput
On entry: must be the same array returned as argument rq in the preceding call to e01tmf. It must remain unchanged between calls.
6:     n – IntegerInput
On entry: n, the number of evaluation points.
Constraint: n1.
7:     xe5n – Real (Kind=nag_wp) arrayInput
On entry: xe1:5i must be set to the evaluation point xi, for i=1,2,,n.
8:     qn – Real (Kind=nag_wp) arrayOutput
On exit: qi contains the value of the interpolant, at xi, for i=1,2,,n. If any of these evaluation points lie outside the region of definition of the interpolant the corresponding entries in q are set to the largest machine representable number (see x02alf), and e01tnf returns with ifail=3.
9:     qx5n – Real (Kind=nag_wp) arrayOutput
On exit: qxji contains the value of the partial derivatives with respect to xj of the interpolant Q x  at xi, for i=1,2,,n, and for each of the five partial derivatives j=1,2,3,4,5. If any of these evaluation points lie outside the region of definition of the interpolant, the corresponding entries in qx are set to the largest machine representable number (see x02alf), and e01tnf returns with ifail=3.
10:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 or 1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1 or 1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6
Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
On entry, m=value.
Constraint: m23.
On entry, n=value.
Constraint: n1.
ifail=2
On entry, values in iq appear to be invalid. Check that iq has not been corrupted between calls to e01tmf and e01tnf.
On entry, values in rq appear to be invalid. Check that rq has not been corrupted between calls to e01tmf and e01tnf.
ifail=3
On entry, at least one evaluation point lies outside the region of definition of the interpolant. At such points the corresponding values in q and qx contain extrapolated approximations. Points should be evaluated one by one to identify extrapolated values.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

Computational errors should be negligible in most practical situations.

8
Parallelism and Performance

e01tnf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
e01tnf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9
Further Comments

The time taken for a call to e01tnf will depend in general on the distribution of the data points. If the data points are approximately uniformly distributed, then the time taken should be only On. At worst Omn time will be required.

9.1
Internal Changes

Internal changes have been made to this routine as follows:
For details of all known issues which have been reported for the NAG Library please refer to the Known Issues list.

10
Example

This program evaluates the function
f x = 1.25 + cos5.4x5 cos6x1 cos6x2 cos6x3 6 + 6 3 x4 - 1 2  
at a set of 30 randomly generated data points and calls e01tmf to construct an interpolating function Q x . It then calls e01tnf to evaluate the interpolant at a set of random points.
To reduce the time taken by this example, the number of data points is limited to 30. Increasing this value to the suggested minimum of 4000 improves the interpolation accuracy at the expense of more time.
See also Section 10 in e01tmf.

10.1
Program Text

Program Text (e01tnfe.f90)

10.2
Program Data

Program Data (e01tnfe.d)

10.3
Program Results

Program Results (e01tnfe.r)