Mercurial > octave-nkf

annotate scripts/deprecated/interp1q.m @ 18102:e124ae274013 gui-release

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Backout ca72f1b73216 on gui_release branch.
author Rik <rik@octave.org>
date Thu, 05 Dec 2013 11:30:28 -0800
parents
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18102
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2008-2013 David Bateman
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
18
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{yi} =} interp1q (@var{x}, @var{y}, @var{xi})
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
21 ## One-dimensional linear interpolation without error checking.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
22 ## Interpolates @var{y}, defined at the points @var{x}, at the points
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
23 ## @var{xi}. The sample points @var{x} must be a strictly monotonically
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
24 ## increasing column vector. If @var{y} is a matrix or an N-dimensional
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
25 ## array, the interpolation is performed on each column of @var{y}. If
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
26 ## @var{y} is a vector, it must be a column vector of the same length as
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
27 ## @var{x}.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
28 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
29 ## Values of @var{xi} beyond the endpoints of the interpolation result
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
30 ## in NA being returned.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
31 ##
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
32 ## Note that the error checking is only a significant portion of the
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
33 ## execution time of this @code{interp1} if the size of the input arguments
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
34 ## is relatively small. Therefore, the benefit of using @code{interp1q}
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
35 ## is relatively small.
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
36 ## @seealso{interp1}
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
37 ## @end deftypefn
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
38
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
39 function yi = interp1q (x, y, xi)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
40
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
41 persistent warned = false;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
42 if (! warned)
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
43 warned = true;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
44 warning ("Octave:deprecated-function",
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
45 "interp1q is obsolete and will be removed from a future version of Octave; use interp1 instead");
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
46 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
47
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
48 x = x(:);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
49 nx = rows (x);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
50 szy = size (y);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
51 y = y(:,:);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
52 [ny, nc] = size (y);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
53 szx = size (xi);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
54 xi = xi (:);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
55 dy = diff (y);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
56 dx = diff (x);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
57 idx = lookup (x, xi, "lr");
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
58 s = (xi - x (idx)) ./ dx (idx);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
59 yi = bsxfun (@times, s, dy(idx,:)) + y(idx,:);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
60 range = xi < x(1) | !(xi <= x(nx));
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
61 yi(range,:) = NA;
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
62 if (length (szx) == 2 && any (szx == 1))
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
63 yi = reshape (yi, [max(szx), szy(2:end)]);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
64 else
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
65 yi = reshape (yi, [szx, szy(2:end)]);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
66 endif
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
67 endfunction
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
68
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
69
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
70 %!shared xp, yp, xi, yi
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
71 %! xp = [0:2:10].'; yp = sin (2*pi*xp/5);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
72 %! xi = [-1; 0; 2.2; 4; 6.6; 10; 11];
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
73 %! yi = interp1 (xp,yp,xi);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
74 %!assert (interp1q (xp,yp, [min(xp)-1; max(xp)+1]), [NA; NA]);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
75 %!assert (interp1q (xp,yp,xp), yp, 100*eps);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
76 %!assert (isempty (interp1q (xp,yp,[])));
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
77 %!assert (interp1q (xp,yp,xi), yi);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
78 %!assert (interp1q (xp,[yp,yp],xi), [yi, yi]);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
79 %!assert (interp1q (xp,yp,[xi,xi]), [yi, yi]);
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
80 %!assert (interp1q (xp,[yp,yp],[xi,xi]), cat (3, [yi, yi], [yi, yi]));
e124ae274013 maint: Backout ca72f1b73216 on gui_release branch.
Rik <rik@octave.org>
parents:
diff changeset
81