Mercurial > hg > octave-lyh
comparison scripts/general/interp1q.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | a41df65f3f00 |
children | 16f53d29049f |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {@var{yi} =} interp1q (@var{x}, @var{y}, @var{xi}) | 20 ## @deftypefn {Function File} {@var{yi} =} interp1q (@var{x}, @var{y}, @var{xi}) |
21 ## One-dimensional linear interpolation without error checking. | 21 ## One-dimensional linear interpolation without error checking. |
22 ## Interpolates @var{y}, defined at the points @var{x}, at the points | 22 ## Interpolates @var{y}, defined at the points @var{x}, at the points |
23 ## @var{xi}. The sample points @var{x} must be a strictly monotonically | 23 ## @var{xi}. The sample points @var{x} must be a strictly monotonically |
24 ## increasing column vector. If @var{y} is an array, treat the columns | 24 ## increasing column vector. If @var{y} is an array, treat the columns |
25 ## of @var{y} separately. If @var{y} is a vector, it must be a column | 25 ## of @var{y} separately. If @var{y} is a vector, it must be a column |
26 ## vector of the same length as @var{x}. | 26 ## vector of the same length as @var{x}. |
27 ## | 27 ## |
28 ## Values of @var{xi} beyond the endpoints of the interpolation result | 28 ## Values of @var{xi} beyond the endpoints of the interpolation result |
29 ## in NA being returned. | 29 ## in NA being returned. |
30 ## | 30 ## |
31 ## Note that the error checking is only a significant portion of the | 31 ## Note that the error checking is only a significant portion of the |
32 ## execution time of this @code{interp1} if the size of the input arguments | 32 ## execution time of this @code{interp1} if the size of the input arguments |
33 ## is relatively small. Therefore, the benefit of using @code{interp1q} | 33 ## is relatively small. Therefore, the benefit of using @code{interp1q} |
34 ## is relatively small. | 34 ## is relatively small. |
35 ## @seealso{interp1} | 35 ## @seealso{interp1} |
36 ## @end deftypefn | 36 ## @end deftypefn |
37 | 37 |
38 function yi = interp1q (x, y, xi) | 38 function yi = interp1q (x, y, xi) |