NAG Library Routine Document

E01BGF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1 Purpose

E01BGF evaluates a piecewise cubic Hermite interpolant and its first derivative at a set of points.

2 Specification

SUBROUTINE E01BGF (

N, X, F, D, M, PX, PF, PD, IFAIL)

INTEGER	N, M, IFAIL
REAL (KIND=nag_wp)	X(N), F(N), D(N), PX(M), PF(M), PD(M)

3 Description

E01BGF evaluates a piecewise cubic Hermite interpolant, as computed by E01BEF, at the points

PX (i)

, for

i = 1, 2, \dots, m

. The first derivatives at the points are also computed. If any point lies outside the interval from

X (1)

X (N)

, values of the interpolant and its derivative are extrapolated from the nearest extreme cubic, and a warning is returned.

If values of the interpolant only, and not of its derivative, are required, E01BFF should be used.

The routine is derived from routine PCHFD in Fritsch (1982).

4 References

Fritsch F N (1982) PCHIP final specifications Report UCID-30194 Lawrence Livermore National Laboratory

5 Parameters

1: $N$ – INTEGERInput
2: $X (N)$ – REAL (KIND=nag_wp) arrayInput
3: $F (N)$ – REAL (KIND=nag_wp) arrayInput
4: $D (N)$ – REAL (KIND=nag_wp) arrayInput: On entry: N, X, F and D must be unchanged from the previous call of E01BEF.
5: $M$ – INTEGERInput: On entry: $m$ , the number of points at which the interpolant is to be evaluated.

Constraint: $M \geq 1$ .
6: $PX (M)$ – REAL (KIND=nag_wp) arrayInput: On entry: the $m$ values of $x$ at which the interpolant is to be evaluated.
7: $PF (M)$ – REAL (KIND=nag_wp) arrayOutput: On exit: $PF (i)$ contains the value of the interpolant evaluated at the point $PX (i)$ , for $i = 1, 2, \dots, m$ .
8: $PD (M)$ – REAL (KIND=nag_wp) arrayOutput: On exit: $PD (i)$ contains the first derivative of the interpolant evaluated at the point $PX (i)$ , for $i = 1, 2, \dots, m$ .
9: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction 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 parameter, 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

- 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,

N < 2

$IFAIL = 2$: The values of $X (r)$ , for $r = 1, 2, \dots, N$ , are not in strictly increasing order.

$IFAIL = 3$

On entry,

M < 1

$IFAIL = 4$: At least one of the points $PX (i)$ , for $i = 1, 2, \dots, M$ , lies outside the interval [ $X (1), X (N)$ ], and extrapolation was performed at all such points. Values computed at these points may be very unreliable.

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

The computational errors in the arrays PF and PD should be negligible in most practical situations.

8 Parallelism and Performance

Not applicable.

9 Further Comments

The time taken by E01BGF is approximately proportional to the number of evaluation points,

m

. The evaluation will be most efficient if the elements of PX are in nondecreasing order (or, more generally, if they are grouped in increasing order of the intervals

[X (r - 1), X (r)]

). A single call of E01BGF with

m > 1

is more efficient than several calls with

m = 1

10 Example

This example reads in values of N, X, F and D, and calls E01BGF to compute the values of the interpolant and its derivative at equally spaced points.

NAG Library Routine DocumentE01BGF