annotate scripts/general/interp1q.m @ 17535:c12c688a35ed default tip lyh

Fix warnings
author LYH <lyh.kernel@gmail.com>
date Fri, 27 Sep 2013 17:43:27 +0800
parents bb3a1ec7cc4b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
1 ## Copyright (C) 2008-2012 David Bateman
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{yi} =} interp1q (@var{x}, @var{y}, @var{xi})
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## One-dimensional linear interpolation without error checking.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## Interpolates @var{y}, defined at the points @var{x}, at the points
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7815
diff changeset
23 ## @var{xi}. The sample points @var{x} must be a strictly monotonically
17087
bb3a1ec7cc4b doc: Clarify matrix and ND-array args to interpolation functions
Mike Miller <mtmiller@ieee.org>
parents: 14872
diff changeset
24 ## increasing column vector. If @var{y} is a matrix or an N-dimensional
bb3a1ec7cc4b doc: Clarify matrix and ND-array args to interpolation functions
Mike Miller <mtmiller@ieee.org>
parents: 14872
diff changeset
25 ## array, the interpolation is performed on each column of @var{y}. If
bb3a1ec7cc4b doc: Clarify matrix and ND-array args to interpolation functions
Mike Miller <mtmiller@ieee.org>
parents: 14872
diff changeset
26 ## @var{y} is a vector, it must be a column vector of the same length as
bb3a1ec7cc4b doc: Clarify matrix and ND-array args to interpolation functions
Mike Miller <mtmiller@ieee.org>
parents: 14872
diff changeset
27 ## @var{x}.
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ##
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ## Values of @var{xi} beyond the endpoints of the interpolation result
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## in NA being returned.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ##
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 ## Note that the error checking is only a significant portion of the
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 ## execution time of this @code{interp1} if the size of the input arguments
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7815
diff changeset
34 ## is relatively small. Therefore, the benefit of using @code{interp1q}
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 ## is relatively small.
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 ## @seealso{interp1}
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 ## @end deftypefn
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
38
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 function yi = interp1q (x, y, xi)
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 x = x(:);
14872
c2dbdeaa25df maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents: 14868
diff changeset
41 nx = rows (x);
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 szy = size (y);
9940
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
43 y = y(:,:);
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
44 [ny, nc] = size (y);
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 szx = size (xi);
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 xi = xi (:);
9940
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
47 dy = diff (y);
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
48 dx = diff (x);
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
49 idx = lookup (x, xi, "lr");
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 s = (xi - x (idx)) ./ dx (idx);
9940
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
51 yi = bsxfun (@times, s, dy(idx,:)) + y(idx,:);
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
52 range = xi < x(1) | !(xi <= x(nx));
1707df259536 optimize interp1q
Jaroslav Hajek <highegg@gmail.com>
parents: 9245
diff changeset
53 yi(range,:) = NA;
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 if (length (szx) == 2 && any (szx == 1))
7815
a41df65f3f00 Add some single precision test code and fix resulting bugs
David Bateman <dbateman@free.fr>
parents: 7785
diff changeset
55 yi = reshape (yi, [max(szx), szy(2:end)]);
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 else
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
57 yi = reshape (yi, [szx, szy(2:end)]);
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 endif
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 endfunction
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
60
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
61
7815
a41df65f3f00 Add some single precision test code and fix resulting bugs
David Bateman <dbateman@free.fr>
parents: 7785
diff changeset
62 %!shared xp, yp, xi, yi
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
63 %! xp = [0:2:10].'; yp = sin (2*pi*xp/5);
7785
9a656cd34f34 Add the interp1q function
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 %! xi = [-1; 0; 2.2; 4; 6.6; 10; 11];
7815
a41df65f3f00 Add some single precision test code and fix resulting bugs
David Bateman <dbateman@free.fr>
parents: 7785
diff changeset
65 %! yi = interp1 (xp,yp,xi);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
66 %!assert (interp1q (xp,yp, [min(xp)-1; max(xp)+1]), [NA; NA]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
67 %!assert (interp1q (xp,yp,xp), yp, 100*eps);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
68 %!assert (isempty (interp1q (xp,yp,[])));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
69 %!assert (interp1q (xp,yp,xi), yi);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
70 %!assert (interp1q (xp,[yp,yp],xi), [yi, yi]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
71 %!assert (interp1q (xp,yp,[xi,xi]), [yi, yi]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
72 %!assert (interp1q (xp,[yp,yp],[xi,xi]), cat (3, [yi, yi], [yi, yi]));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
73