Mercurial > hg > octave-lojdl
comparison scripts/polynomial/mkpp.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 18 Jul 2010 20:35:16 -0700 |
parents | fbd7843974fa |
children | 1740012184f9 |
comparison
equal
deleted
inserted
replaced
10792:91342260063e | 10793:be55736a0783 |
---|---|
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}) | 20 ## @deftypefn {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}) |
21 ## @deftypefnx {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}, @var{d}) | 21 ## @deftypefnx {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}, @var{d}) |
22 ## | 22 ## |
23 ## Construct a piece-wise polynomial structure from sample points | 23 ## Construct a piece-wise polynomial structure from sample points |
24 ## @var{x} and coefficients @var{p}. The i-th row of @var{p}, | 24 ## @var{x} and coefficients @var{p}. The i-th row of @var{p}, |
25 ## @code{@var{p} (@var{i},:)}, contains the coefficients for the polynomial | 25 ## @code{@var{p} (@var{i},:)}, contains the coefficients for the polynomial |
26 ## over the @var{i}-th interval, ordered from highest to | 26 ## over the @var{i}-th interval, ordered from highest to |
27 ## lowest. There must be one row for each interval in @var{x}, so | 27 ## lowest. There must be one row for each interval in @var{x}, so |
28 ## @code{rows (@var{p}) == length (@var{x}) - 1}. | 28 ## @code{rows (@var{p}) == length (@var{x}) - 1}. |
29 ## | 29 ## |
30 ## @var{p} may also be a multi-dimensional array, specifying a vector-valued | 30 ## @var{p} may also be a multi-dimensional array, specifying a vector-valued |
31 ## or array-valued polynomial. The shape is determined by @var{d}. If @var{d} is | 31 ## or array-valued polynomial. The shape is determined by @var{d}. If @var{d} |
32 ## is | |
32 ## not given, the default is @code{size (p)(1:end-2)}. If @var{d} is given, the | 33 ## not given, the default is @code{size (p)(1:end-2)}. If @var{d} is given, the |
33 ## leading dimensions of @var{p} are reshaped to conform to @var{d}. | 34 ## leading dimensions of @var{p} are reshaped to conform to @var{d}. |
34 ## | 35 ## |
35 ## @seealso{unmkpp, ppval, spline} | 36 ## @seealso{unmkpp, ppval, spline} |
36 ## @end deftypefn | 37 ## @end deftypefn |