Mercurial > octave-nkf
comparison scripts/general/interp1.m @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Aug 2013 20:46:38 -0700 |
| parents | c3c1ebfaa7dc |
| children | 09543e9c8f40 |
comparison
equal
deleted
inserted
replaced
| 17280:1a5407bae739 | 17281:bc924baa2c4e |
|---|---|
| 30 ## array, the interpolation is performed on each column of @var{y}. | 30 ## array, the interpolation is performed on each column of @var{y}. |
| 31 ## | 31 ## |
| 32 ## Method is one of: | 32 ## Method is one of: |
| 33 ## | 33 ## |
| 34 ## @table @asis | 34 ## @table @asis |
| 35 ## @item "nearest" | 35 ## @item @qcode{"nearest"} |
| 36 ## Return the nearest neighbor. | 36 ## Return the nearest neighbor. |
| 37 ## | 37 ## |
| 38 ## @item "linear" | 38 ## @item @qcode{"linear"} |
| 39 ## Linear interpolation from nearest neighbors | 39 ## Linear interpolation from nearest neighbors |
| 40 ## | 40 ## |
| 41 ## @item "pchip" | 41 ## @item @qcode{"pchip"} |
| 42 ## Piecewise cubic Hermite interpolating polynomial | 42 ## Piecewise cubic Hermite interpolating polynomial |
| 43 ## | 43 ## |
| 44 ## @item "cubic" | 44 ## @item @qcode{"cubic"} |
| 45 ## Cubic interpolation (same as @code{pchip}) | 45 ## Cubic interpolation (same as @code{pchip}) |
| 46 ## | 46 ## |
| 47 ## @item "spline" | 47 ## @item @qcode{"spline"} |
| 48 ## Cubic spline interpolation---smooth first and second derivatives | 48 ## Cubic spline interpolation---smooth first and second derivatives |
| 49 ## throughout the curve | 49 ## throughout the curve |
| 50 ## @end table | 50 ## @end table |
| 51 ## | 51 ## |
| 52 ## Appending '*' to the start of the above method forces @code{interp1} | 52 ## Appending '*' to the start of the above method forces @code{interp1} |
| 53 ## to assume that @var{x} is uniformly spaced, and only @code{@var{x}(1)} | 53 ## to assume that @var{x} is uniformly spaced, and only @code{@var{x}(1)} |
| 54 ## and @code{@var{x}(2)} are referenced. This is usually faster, | 54 ## and @code{@var{x}(2)} are referenced. This is usually faster, |
| 55 ## and is never slower. The default method is "linear". | 55 ## and is never slower. The default method is @qcode{"linear"}. |
| 56 ## | 56 ## |
| 57 ## If @var{extrap} is the string "extrap", then extrapolate values beyond | 57 ## If @var{extrap} is the string @qcode{"extrap"}, then extrapolate values |
| 58 ## the endpoints. If @var{extrap} is a number, replace values beyond the | 58 ## beyond the endpoints. If @var{extrap} is a number, replace values beyond |
| 59 ## endpoints with that number. If @var{extrap} is missing, assume NA. | 59 ## the endpoints with that number. If @var{extrap} is missing, assume NA. |
| 60 ## | 60 ## |
| 61 ## If the string argument "pp" is specified, then @var{xi} should not be | 61 ## If the string argument @qcode{"pp"} is specified, then @var{xi} should not be |
| 62 ## supplied and @code{interp1} returns the piecewise polynomial that | 62 ## supplied and @code{interp1} returns the piecewise polynomial that |
| 63 ## can later be used with @code{ppval} to evaluate the interpolation. | 63 ## can later be used with @code{ppval} to evaluate the interpolation. |
| 64 ## There is an equivalence, such that @code{ppval (interp1 (@var{x}, | 64 ## There is an equivalence, such that @code{ppval (interp1 (@var{x}, |
| 65 ## @var{y}, @var{method}, "pp"), @var{xi}) == interp1 (@var{x}, @var{y}, | 65 ## @var{y}, @var{method}, @qcode{"pp"}), @var{xi}) == interp1 (@var{x}, @var{y}, |
| 66 ## @var{xi}, @var{method}, "extrap")}. | 66 ## @var{xi}, @var{method}, @qcode{"extrap"})}. |
| 67 ## | 67 ## |
| 68 ## Duplicate points in @var{x} specify a discontinuous interpolant. There | 68 ## Duplicate points in @var{x} specify a discontinuous interpolant. There |
| 69 ## may be at most 2 consecutive points with the same value. | 69 ## may be at most 2 consecutive points with the same value. |
| 70 ## If @var{x} is increasing, the default discontinuous interpolant is | 70 ## If @var{x} is increasing, the default discontinuous interpolant is |
| 71 ## right-continuous. If @var{x} is decreasing, the default discontinuous | 71 ## right-continuous. If @var{x} is decreasing, the default discontinuous |
| 72 ## interpolant is left-continuous. | 72 ## interpolant is left-continuous. |
| 73 ## The continuity condition of the interpolant may be specified by using | 73 ## The continuity condition of the interpolant may be specified by using |
| 74 ## the options, "-left" or "-right", to select a left-continuous | 74 ## the options, @qcode{"-left"} or @qcode{"-right"}, to select a left-continuous |
| 75 ## or right-continuous interpolant, respectively. | 75 ## or right-continuous interpolant, respectively. |
| 76 ## Discontinuous interpolation is only allowed for "nearest" and "linear" | 76 ## Discontinuous interpolation is only allowed for @qcode{"nearest"} and |
| 77 ## methods; in all other cases, the @var{x}-values must be unique. | 77 ## @qcode{"linear"} methods; in all other cases, the @var{x}-values must be |
| 78 ## unique. | |
| 78 ## | 79 ## |
| 79 ## An example of the use of @code{interp1} is | 80 ## An example of the use of @code{interp1} is |
| 80 ## | 81 ## |
| 81 ## @example | 82 ## @example |
| 82 ## @group | 83 ## @group |