1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
|
/* interpolation/interp2d.c
*
* Copyright 2012 David Zaslavsky
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include <config.h>
#include <stdlib.h>
#include <gsl/gsl_errno.h>
#include <gsl/gsl_math.h>
#include <gsl/gsl_interp.h>
#include <gsl/gsl_interp2d.h>
/**
* Triggers a GSL error if the argument is not equal to GSL_SUCCESS.
* If the argument is GSL_SUCCESS, this does nothing.
*/
#define DISCARD_STATUS(s) if ((s) != GSL_SUCCESS) { GSL_ERROR_VAL("interpolation error", (s), GSL_NAN); }
#define IDX2D(i, j, w) ((j) * ((w)->xsize) + (i))
gsl_interp2d *
gsl_interp2d_alloc(const gsl_interp2d_type * T, const size_t xsize,
const size_t ysize)
{
gsl_interp2d * interp;
if (xsize < T->min_size || ysize < T->min_size)
{
GSL_ERROR_NULL ("insufficient number of points for interpolation type",
GSL_EINVAL);
}
interp = (gsl_interp2d *) calloc(1, sizeof(gsl_interp2d));
if (interp == NULL)
{
GSL_ERROR_NULL ("failed to allocate space for gsl_interp2d struct",
GSL_ENOMEM);
}
interp->type = T;
interp->xsize = xsize;
interp->ysize = ysize;
if (interp->type->alloc == NULL)
{
interp->state = NULL;
return interp;
}
interp->state = interp->type->alloc(xsize, ysize);
if (interp->state == NULL)
{
free(interp);
GSL_ERROR_NULL ("failed to allocate space for gsl_interp2d state",
GSL_ENOMEM);
}
return interp;
} /* gsl_interp2d_alloc() */
void
gsl_interp2d_free (gsl_interp2d * interp)
{
RETURN_IF_NULL(interp);
if (interp->type->free)
interp->type->free(interp->state);
free(interp);
} /* gsl_interp2d_free() */
int
gsl_interp2d_init (gsl_interp2d * interp, const double xarr[], const double yarr[],
const double zarr[], const size_t xsize, const size_t ysize)
{
size_t i;
if (xsize != interp->xsize || ysize != interp->ysize)
{
GSL_ERROR("data must match size of interpolation object", GSL_EINVAL);
}
for (i = 1; i < xsize; i++)
{
if (xarr[i-1] >= xarr[i])
{
GSL_ERROR("x values must be strictly increasing", GSL_EINVAL);
}
}
for (i = 1; i < ysize; i++)
{
if (yarr[i-1] >= yarr[i])
{
GSL_ERROR("y values must be strictly increasing", GSL_EINVAL);
}
}
interp->xmin = xarr[0];
interp->xmax = xarr[xsize - 1];
interp->ymin = yarr[0];
interp->ymax = yarr[ysize - 1];
{
int status = interp->type->init(interp->state, xarr, yarr, zarr,
xsize, ysize);
return status;
}
} /* gsl_interp2d_init() */
/*
* A wrapper function that checks boundary conditions, calls an evaluator
* which implements the actual calculation of the function value or
* derivative etc., and checks the return status.
*/
static int
interp2d_eval(int (*evaluator)(const void *, const double xa[], const double ya[],
const double za[], size_t xsize, size_t ysize,
double x, double y, gsl_interp_accel *,
gsl_interp_accel *, double * z),
const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya,
double * result)
{
if (x < interp->xmin || x > interp->xmax)
{
GSL_ERROR ("interpolation x value out of range", GSL_EDOM);
}
else if (y < interp->ymin || y > interp->ymax)
{
GSL_ERROR ("interpolation y value out of range", GSL_EDOM);
}
return evaluator(interp->state, xarr, yarr, zarr,
interp->xsize, interp->ysize,
x, y, xa, ya, result);
}
/*
* Another wrapper function that serves as a drop-in replacement for
* interp2d_eval but does not check the bounds. This can be used
* for extrapolation.
*/
static int
interp2d_eval_extrap(int (*evaluator)(const void *, const double xa[],
const double ya[], const double za[],
size_t xsize, size_t ysize,
double x, double y,
gsl_interp_accel *,
gsl_interp_accel *, double * z),
const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya,
double * result)
{
return evaluator(interp->state, xarr, yarr, zarr,
interp->xsize, interp->ysize, x, y, xa, ya, result);
}
double
gsl_interp2d_eval (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya)
{
double z;
int status = gsl_interp2d_eval_e(interp, xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
} /* gsl_interp2d_eval() */
double
gsl_interp2d_eval_extrap (const gsl_interp2d * interp,
const double xarr[],
const double yarr[],
const double zarr[],
const double x,
const double y,
gsl_interp_accel * xa,
gsl_interp_accel * ya)
{
double z;
int status =
interp2d_eval_extrap(interp->type->eval, interp,
xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
}
int
gsl_interp2d_eval_e (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya, double * z)
{
return interp2d_eval(interp->type->eval, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
} /* gsl_interp2d_eval_e() */
#ifndef GSL_DISABLE_DEPRECATED
int
gsl_interp2d_eval_e_extrap (const gsl_interp2d * interp,
const double xarr[], const double yarr[],
const double zarr[], const double x,
const double y, gsl_interp_accel * xa,
gsl_interp_accel * ya, double * z)
{
return interp2d_eval_extrap(interp->type->eval, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
#endif /* !GSL_DISABLE_DEPRECATED */
int
gsl_interp2d_eval_extrap_e (const gsl_interp2d * interp,
const double xarr[], const double yarr[],
const double zarr[], const double x,
const double y, gsl_interp_accel * xa,
gsl_interp_accel * ya, double * z)
{
return interp2d_eval_extrap(interp->type->eval, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
double
gsl_interp2d_eval_deriv_x (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya)
{
double z;
int status = gsl_interp2d_eval_deriv_x_e(interp, xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
}
int
gsl_interp2d_eval_deriv_x_e (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya, double * z)
{
return interp2d_eval(interp->type->eval_deriv_x, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
double
gsl_interp2d_eval_deriv_y (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya)
{
double z;
int status = gsl_interp2d_eval_deriv_y_e(interp, xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
}
int
gsl_interp2d_eval_deriv_y_e (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya, double * z)
{
return interp2d_eval(interp->type->eval_deriv_y, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
double
gsl_interp2d_eval_deriv_xx (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya)
{
double z;
int status = gsl_interp2d_eval_deriv_xx_e(interp, xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
}
int
gsl_interp2d_eval_deriv_xx_e (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya, double * z)
{
return interp2d_eval(interp->type->eval_deriv_xx, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
double
gsl_interp2d_eval_deriv_yy (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya)
{
double z;
int status = gsl_interp2d_eval_deriv_yy_e(interp, xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
}
int
gsl_interp2d_eval_deriv_yy_e (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya, double * z)
{
return interp2d_eval(interp->type->eval_deriv_yy, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
double
gsl_interp2d_eval_deriv_xy (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya)
{
double z;
int status = gsl_interp2d_eval_deriv_xy_e(interp, xarr, yarr, zarr, x, y, xa, ya, &z);
DISCARD_STATUS(status)
return z;
}
int
gsl_interp2d_eval_deriv_xy_e (const gsl_interp2d * interp, const double xarr[],
const double yarr[], const double zarr[],
const double x, const double y,
gsl_interp_accel * xa, gsl_interp_accel * ya, double * z)
{
return interp2d_eval(interp->type->eval_deriv_xy, interp,
xarr, yarr, zarr, x, y, xa, ya, z);
}
size_t
gsl_interp2d_type_min_size(const gsl_interp2d_type * T)
{
return T->min_size;
}
size_t
gsl_interp2d_min_size(const gsl_interp2d * interp)
{
return interp->type->min_size;
}
const char *
gsl_interp2d_name(const gsl_interp2d * interp)
{
return interp->type->name;
}
size_t
gsl_interp2d_idx(const gsl_interp2d * interp,
const size_t i, const size_t j)
{
if (i >= interp->xsize)
{
GSL_ERROR_VAL ("x index out of range", GSL_ERANGE, 0);
}
else if (j >= interp->ysize)
{
GSL_ERROR_VAL ("y index out of range", GSL_ERANGE, 0);
}
else
{
return IDX2D(i, j, interp);
}
} /* gsl_interp2d_idx() */
int
gsl_interp2d_set(const gsl_interp2d * interp, double zarr[],
const size_t i, const size_t j, const double z)
{
if (i >= interp->xsize)
{
GSL_ERROR ("x index out of range", GSL_ERANGE);
}
else if (j >= interp->ysize)
{
GSL_ERROR ("y index out of range", GSL_ERANGE);
}
else
{
zarr[IDX2D(i, j, interp)] = z;
return GSL_SUCCESS;
}
} /* gsl_interp2d_set() */
double
gsl_interp2d_get(const gsl_interp2d * interp, const double zarr[],
const size_t i, const size_t j)
{
if (i >= interp->xsize)
{
GSL_ERROR_VAL ("x index out of range", GSL_ERANGE, 0);
}
else if (j >= interp->ysize)
{
GSL_ERROR_VAL ("y index out of range", GSL_ERANGE, 0);
}
else
{
return zarr[IDX2D(i, j, interp)];
}
} /* gsl_interp2d_get() */
#undef IDX2D
|
