Mercurial > octave-nkf
comparison scripts/general/interp3.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 | eb63fbe60fab |
children | e9dc2ed2ec0f |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
22 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}, @var{m}) | 22 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}, @var{m}) |
23 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}) | 23 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}) |
24 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@dots{}, @var{method}) | 24 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@dots{}, @var{method}) |
25 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@dots{}, @var{method}, @var{extrapval}) | 25 ## @deftypefnx {Function File} {@var{vi} =} interp3 (@dots{}, @var{method}, @var{extrapval}) |
26 ## | 26 ## |
27 ## Perform 3-dimensional interpolation. Each element of the 3-dimensional | 27 ## Perform 3-dimensional interpolation. Each element of the 3-dimensional |
28 ## array @var{v} represents a value at a location given by the parameters | 28 ## array @var{v} represents a value at a location given by the parameters |
29 ## @var{x}, @var{y}, and @var{z}. The parameters @var{x}, @var{x}, and | 29 ## @var{x}, @var{y}, and @var{z}. The parameters @var{x}, @var{x}, and |
30 ## @var{z} are either 3-dimensional arrays of the same size as the array | 30 ## @var{z} are either 3-dimensional arrays of the same size as the array |
31 ## @var{v} in the 'meshgrid' format or vectors. The parameters @var{xi}, etc | 31 ## @var{v} in the 'meshgrid' format or vectors. The parameters @var{xi}, etc |
32 ## respect a similar format to @var{x}, etc, and they represent the points | 32 ## respect a similar format to @var{x}, etc, and they represent the points |
33 ## at which the array @var{vi} is interpolated. | 33 ## at which the array @var{vi} is interpolated. |
34 ## | 34 ## |
35 ## If @var{x}, @var{y}, @var{z} are omitted, they are assumed to be | 35 ## If @var{x}, @var{y}, @var{z} are omitted, they are assumed to be |
36 ## @code{x = 1 : size (@var{v}, 2)}, @code{y = 1 : size (@var{v}, 1)} and | 36 ## @code{x = 1 : size (@var{v}, 2)}, @code{y = 1 : size (@var{v}, 1)} and |
37 ## @code{z = 1 : size (@var{v}, 3)}. If @var{m} is specified, then | 37 ## @code{z = 1 : size (@var{v}, 3)}. 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 |