Mercurial > hg > octave-lyh

comparison scripts/general/interpn.m @ 14359:7277fe922e99

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use Octave preference for double quote in docstrings in scripts/ * interp1.m, interp2.m, interp3.m, interpn.m, profexplore.m, profile.m, profshow.m, quadgk.m, lookfor.m, imagesc.m, bzip2.m, gzip.m, parseparams.m, pkg.m, ancestor.m, caxis.m, ezmesh.m, ezmeshc.m, ezsurf.m, ezsurfc.m, hidden.m, hold.m, patch.m, pie.m, pie3.m, quiver.m, quiver3.m, scatter3.m, uicontextmenu.m, uicontrol.m, uipanel.m, uipushtool.m, uitoggletool.m, uitoolbar.m, xlim.m, ylim.m, zlim.m, ismember.m, setxor.m, filter2.m, bicg.m, demo.m, example.m, fail.m, test.m: Use Octave preference for double quote in docstrings in scripts/ directory.
author Rik <octave@nomad.inbox5.com>
date Mon, 13 Feb 2012 07:38:23 -0800
parents c4fa5e0b6193
children f3d52523cde1
comparison
equal deleted inserted replaced
14358:adb352685ded 14359:7277fe922e99
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
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
45 ## @item 'nearest' 45 ## @item "nearest"
46 ## Return the nearest neighbor. 46 ## Return the nearest neighbor.
47 ## 47 ##
48 ## @item 'linear' 48 ## @item "linear"
49 ## Linear interpolation from nearest neighbors. 49 ## Linear interpolation from nearest neighbors.
50 ## 50 ##
51 ## @item 'cubic' 51 ## @item "cubic"
52 ## Cubic interpolation from four nearest neighbors (not implemented yet). 52 ## Cubic interpolation from four nearest neighbors (not implemented yet).
53 ## 53 ##
54 ## @item 'spline' 54 ## @item "spline"
55 ## Cubic spline interpolation---smooth first and second derivatives 55 ## Cubic spline interpolation---smooth first and second derivatives
56 ## throughout the curve. 56 ## throughout the curve.
57 ## @end table 57 ## @end table
58 ## 58 ##
59 ## The default method is 'linear'. 59 ## The default method is "linear".
60 ## 60 ##
61 ## If @var{extrapval} is the scalar value, use it to replace the values 61 ## If @var{extrapval} is the scalar value, use it to replace the values
62 ## beyond the endpoints with that number. If @var{extrapval} is missing, 62 ## beyond the endpoints with that number. If @var{extrapval} is missing,
63 ## assume NA. 63 ## assume NA.
64 ## @seealso{interp1, interp2, spline, ndgrid} 64 ## @seealso{interp1, interp2, spline, ndgrid}