### changeset 17089:bb3a1ec7cc4b

doc: Clarify matrix and ND-array args to interpolation functions * interp1.m, interp1q.m, interpft.m: Clarify handling of matrix and ND-array arguments.
author Mike Miller Fri, 26 Jul 2013 00:09:41 -0400 3db796f89695 c8586e6fc60d scripts/general/interp1.m scripts/general/interp1q.m scripts/general/interpft.m 3 files changed, 9 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
```--- a/scripts/general/interp1.m
+++ b/scripts/general/interp1.m
@@ -26,8 +26,8 @@
##
## One-dimensional interpolation.  Interpolates to determine the value of
## @var{yi} at the points, @var{xi}.  If not specified, @var{x} is taken
-## to be the indices of @var{y}.  If @var{y} is an array, treat the columns
-## of @var{y} separately.
+## to be the indices of @var{y}.  If @var{y} is a matrix or an N-dimensional
+## array, the interpolation is performed on each column of @var{y}.
##
## Method is one of:
##```
```--- a/scripts/general/interp1q.m
+++ b/scripts/general/interp1q.m
@@ -21,9 +21,10 @@
## One-dimensional linear interpolation without error checking.
## Interpolates @var{y}, defined at the points @var{x}, at the points
## @var{xi}.  The sample points @var{x} must be a strictly monotonically
-## increasing column vector.  If @var{y} is an array, treat the columns
-## of @var{y} separately.  If @var{y} is a vector, it must be a column
-## vector of the same length as @var{x}.
+## increasing column vector.  If @var{y} is a matrix or an N-dimensional
+## array, the interpolation is performed on each column of @var{y}.  If
+## @var{y} is a vector, it must be a column vector of the same length as
+## @var{x}.
##
## Values of @var{xi} beyond the endpoints of the interpolation result
## in NA being returned.```
```--- a/scripts/general/interpft.m
+++ b/scripts/general/interpft.m
@@ -22,9 +22,9 @@
##
## Fourier interpolation.  If @var{x} is a vector, then @var{x} is
## resampled with @var{n} points.  The data in @var{x} is assumed to be
-## equispaced.  If @var{x} is an array, then operate along each column of
-## the array separately.  If @var{dim} is specified, then interpolate
-## along the dimension @var{dim}.
+## equispaced.  If @var{x} is a matrix or an N-dimensional array, the
+## interpolation is performed on each column of @var{x}.  If @var{dim} is
+## specified, then interpolate along the dimension @var{dim}.
##
## @code{interpft} assumes that the interpolated function is periodic,
## and so assumptions are made about the endpoints of the interpolation.```