Mercurial > hg > octave-nkf
diff scripts/polynomial/ppval.m @ 14104:614505385171 stable
doc: Overhaul docstrings for polynomial functions.
* mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m, polyfit.m,
polygcd.m, polyint.m, polyout.m, polyreduce.m, polyval.m, polyvalm.m, ppder.m,
ppval.m, residue.m, roots.m, spline.m, unmkpp.m: Improve docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 23 Dec 2011 20:09:27 -0800 |
| parents | be74491c20e8 |
| children | 72c96de7a403 |
line wrap: on
line diff
--- a/scripts/polynomial/ppval.m +++ b/scripts/polynomial/ppval.m @@ -18,18 +18,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{yi} =} ppval (@var{pp}, @var{xi}) -## Evaluate piece-wise polynomial structure @var{pp} at the points @var{xi}. +## Evaluate the piecewise polynomial structure @var{pp} at the points @var{xi}. ## If @var{pp} describes a scalar polynomial function, the result is an ## array of the same shape as @var{xi}. ## Otherwise, the size of the result is @code{[pp.dim, length(@var{xi})]} if ## @var{xi} is a vector, or @code{[pp.dim, size(@var{xi})]} if it is a ## multi-dimensional array. -## -##, the dimensions are permuted as -## in interp1, to -## @code{[pp.d, length(@var{xi})]} and @code{[pp.d, size(@var{xi})]} -## respectively. -## @seealso{mkpp, unmkpp, spline, pchip, interp1} +## @seealso{mkpp, unmkpp, spline, pchip} ## @end deftypefn function yi = ppval (pp, xi)