NAG Library Function Document

nag_2d_spline_eval_rect (e02dfc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:    $\mathbf{mx}$ – IntegerInput

2:    $\mathbf{my}$ – IntegerInput

On entry: mx and my must specify $m_x$ and $m_y$ respectively, the number of points along the $x$ and $y$ axes that define the rectangular grid.

Constraint: $\mathbf{mx}\ge 1$ and $\mathbf{my}\ge 1$.

3:    $\mathbf{x}\left[\mathbf{mx}\right]$ – const doubleInput

4:    $\mathbf{y}\left[\mathbf{my}\right]$ – const doubleInput

On entry: x and y must contain $x_{\mathit{q}}$, for $\mathit{q}=1,2,\dots ,m_x$, and $y_{\mathit{r}}$, for $\mathit{r}=1,2,\dots ,m_y$, respectively. These are the $x$ and $y$ coordinates that define the rectangular grid of points at which values of the spline are required.

Constraint: x and y must satisfy $\mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[3\right]\le \mathbf{x}\left[\mathit{q}-1\right]<\mathbf{x}\left[\mathit{q}\right]\le \mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[\mathbf{spline}\mathbf{\to }\mathbf{nx}-4\right]$, for $\mathit{q}=1,2,\dots ,m_x-1$, and $\mathbf{spline}\mathbf{\to }\mathbf{mu}\left[3\right]\le \mathbf{y}\left[\mathit{r}-1\right]<\mathbf{y}\left[\mathit{r}\right]\le \mathbf{spline}\mathbf{\to }\mathbf{mu}\left[\mathbf{spline}\mathbf{\to }\mathbf{ny}-4\right]$, for $\mathit{r}=1,2,\dots ,m_y-1$.
The spline representation is not valid outside these intervals.

5:    $\mathbf{ff}\left[\mathbf{mx}\times \mathbf{my}\right]$ – doubleOutput

On exit: $\mathbf{ff}\left[\mathbf{my}\times \left(\mathit{q}-1\right)+\mathit{r}-1\right]$ contains the value of the spline at the point $\left(x_{\mathit{q}},y_{\mathit{r}}\right)$, for $\mathit{q}=1,2,\dots ,m_x$ and $\mathit{r}=1,2,\dots ,m_y$.

6:    $\mathbf{spline}$ – Nag_2dSpline *

Pointer to structure of type Nag_2dSpline with the following members:

nx – IntegerInput

On entry: $\mathbf{nx}$ must specify the total number of knots associated with the variable $x$. It is such that $\mathbf{nx}-8$ is the number of interior knots.

Constraint: $\mathbf{nx}\ge 8$.

lamda – double *Input

On entry: a pointer to which memory of size $\mathbf{nx}$ must be allocated. $\mathbf{lamda}$ must contain the complete sets of knots $\left\{\lambda \right\}$ associated with the $x$ variable.

Constraint: the knots must be in nondecreasing order, with $\mathbf{lamda}\left[\mathbf{nx}-4\right]>\mathbf{lamda}\left[3\right]$.

ny – IntegerInput

On entry: $\mathbf{ny}$ must specify the total number of knots associated with the variable $y$.
It is such that $\mathbf{ny}-8$ is the number of interior knots.

Constraint: $\mathbf{ny}\ge 8$.

mu – double *Input

On entry: a pointer to which memory of size $\mathbf{ny}$ must be allocated. $\mathbf{mu}$ must contain the complete sets of knots $\left\{\mu \right\}$ associated with the $y$ variable.

Constraint: the knots must be in nondecreasing order, with $\mathbf{mu}\left[\mathbf{ny}-4\right]>\mathbf{mu}\left[3\right]$.

c – double *Input

On entry: a pointer to which memory of size $\left(\mathbf{nx}-4\right)\times \left(\mathbf{ny}-4\right)$ must be allocated. $\mathbf{c}\left[\left(\mathbf{ny}-4\right)\times \left(i-1\right)+j-1\right]$ must contain the coefficient $c_{\mathit{i}\mathit{j}}$ described in Section 3, for $\mathit{i}=1,2,\dots ,\mathbf{nx}-4$ and $\mathit{j}=1,2,\dots ,\mathbf{ny}-4$.

In normal usage, the call to nag_2d_spline_eval_rect (e02dfc) follows a call to nag_2d_spline_interpolant (e01dac), nag_2d_spline_fit_grid (e02dcc) or nag_2d_spline_fit_scat (e02ddc), in which case, members of the structure spline will have been set up correctly for input to nag_2d_spline_eval_rect (e02dfc).

7:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.

NE_END_KNOTS_CONS

On entry, the end knots must satisfy $〈\mathit{\text{value}}〉$: $〈\mathit{\text{value}}〉=〈\mathit{\text{value}}〉$, $〈\mathit{\text{value}}〉=〈\mathit{\text{value}}〉$.

NE_INT_ARG_LT

On entry, $\mathbf{mx}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{mx}\ge 1$.

On entry, $\mathbf{my}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{my}\ge 1$.

On entry, $\mathbf{spline}\mathbf{\to }\mathbf{nx}$ must not be less than 8: $\mathbf{spline}\mathbf{\to }\mathbf{nx}=〈\mathit{\text{value}}〉$.

On entry, $\mathbf{spline}\mathbf{\to }\mathbf{ny}$ must not be less than 8: $\mathbf{spline}\mathbf{\to }\mathbf{ny}=〈\mathit{\text{value}}〉$.

NE_KNOTS_COORD_CONS

On entry, the end knots and coordinates must satisfy $\mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[3\right]\le \mathbf{x}\left[0\right]$ and $\mathbf{x}\left[\mathbf{mx}-1\right]\le \mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[\mathbf{spline}\mathbf{\to }\mathbf{nx}-4\right]$. $\mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[3\right]=〈\mathit{\text{value}}〉$, $\mathbf{x}\left[0\right]=〈\mathit{\text{value}}〉$, $\mathbf{x}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$, $\mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.

On entry, the end knots and coordinates must satisfy $\mathbf{spline}\mathbf{\to }\mathbf{mu}\left[3\right]\le \mathbf{y}\left[0\right]$ and $\mathbf{y}\left[\mathbf{my}-1\right]\le \mathbf{spline}\mathbf{\to }\mathbf{mu}\left[\mathbf{spline}\mathbf{\to }\mathbf{ny}-4\right]$. $\mathbf{spline}\mathbf{\to }\mathbf{mu}\left[3\right]=〈\mathit{\text{value}}〉$, $\mathbf{y}\left[0\right]=〈\mathit{\text{value}}〉$, $\mathbf{y}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$, $\mathbf{spline}\mathbf{\to }\mathbf{mu}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.

NE_NOT_INCREASING

The sequence $\mathbf{spline}\mathbf{\to }\mathbf{lamda}$ is not increasing: $\mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$, $\mathbf{spline}\mathbf{\to }\mathbf{lamda}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.
The sequence $\mathbf{spline}\mathbf{\to }\mathbf{mu}$ is not increasing: $\mathbf{spline}\mathbf{\to }\mathbf{mu}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$, $\mathbf{spline}\mathbf{\to }\mathbf{mu}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.

NE_NOT_STRICTLY_INCREASING

The sequence x is not strictly increasing: $\mathbf{x}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$, $\mathbf{x}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.
The sequence y is not strictly increasing: $\mathbf{y}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$, $\mathbf{y}\left[〈\mathit{\text{value}}〉\right]=〈\mathit{\text{value}}〉$.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (e02dfce.c)

10.2  Program Data

Program Data (e02dfce.d)

10.3  Program Results

Program Results (e02dfce.r)