Mercurial > hg > octave-lyh

comparison scripts/general/interpn.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 eb63fbe60fab
children e9dc2ed2ec0f
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
27 ## Perform @var{n}-dimensional interpolation, where @var{n} is at least two. 27 ## Perform @var{n}-dimensional interpolation, where @var{n} is at least two.
28 ## Each element of the @var{n}-dimensional array @var{v} represents a value 28 ## Each element of the @var{n}-dimensional array @var{v} represents a value
29 ## at a location given by the parameters @var{x1}, @var{x2}, @dots{}, @var{xn}. 29 ## at a location given by the parameters @var{x1}, @var{x2}, @dots{}, @var{xn}.
30 ## The parameters @var{x1}, @var{x2}, @dots{}, @var{xn} are either 30 ## The parameters @var{x1}, @var{x2}, @dots{}, @var{xn} are either
31 ## @var{n}-dimensional arrays of the same size as the array @var{v} in 31 ## @var{n}-dimensional arrays of the same size as the array @var{v} in
32 ## the 'ndgrid' format or vectors. The parameters @var{y1}, etc respect a 32 ## the 'ndgrid' format or vectors. The parameters @var{y1}, etc respect a
33 ## similar format to @var{x1}, etc, and they represent the points at which 33 ## similar format to @var{x1}, etc, and they represent the points at which
34 ## the array @var{vi} is interpolated. 34 ## the array @var{vi} is interpolated.
35 ## 35 ##
36 ## If @var{x1}, @dots{}, @var{xn} are omitted, they are assumed to be 36 ## If @var{x1}, @dots{}, @var{xn} are omitted, they are assumed to be
37 ## @code{x1 = 1 : size (@var{v}, 1)}, etc. If @var{m} is specified, then 37 ## @code{x1 = 1 : size (@var{v}, 1)}, etc. If @var{m} is specified, then
38 ## the interpolation adds a point half way between each of the interpolation 38 ## the interpolation adds a point half way between each of the interpolation
39 ## points. This process is performed @var{m} times. If only @var{v} is 39 ## points. This process is performed @var{m} times. If only @var{v} is
40 ## specified, then @var{m} is assumed to be @code{1}. 40 ## specified, then @var{m} is assumed to be @code{1}.
41 ## 41 ##
42 ## Method is one of: 42 ## Method is one of:
43 ## 43 ##
44 ## @table @asis 44 ## @table @asis
54 ## @end table 54 ## @end table
55 ## 55 ##
56 ## The default method is 'linear'. 56 ## The default method is 'linear'.
57 ## 57 ##
58 ## If @var{extrapval} is the scalar value, use it to replace the values 58 ## If @var{extrapval} is the scalar value, use it to replace the values
59 ## beyond the endpoints with that number. If @var{extrapval} is missing, 59 ## beyond the endpoints with that number. If @var{extrapval} is missing,
60 ## assume NA. 60 ## assume NA.
61 ## @seealso{interp1, interp2, spline, ndgrid} 61 ## @seealso{interp1, interp2, spline, ndgrid}
62 ## @end deftypefn 62 ## @end deftypefn
63 63
64 function vi = interpn (varargin) 64 function vi = interpn (varargin)