Mercurial > octave-antonio

diff scripts/polynomial/pchip.m @ 20165:f1d0f506ee78 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed optimization, polynomial, signal script directories. * 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/pqpnonneg.m, scripts/optimization/qp.m, scripts/optimization/sqp.m, scripts/polynomial/compan.m, scripts/polynomial/mkpp.m, scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m, scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m, scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m, scripts/polynomial/polyint.m, scripts/polynomial/polyout.m, scripts/polynomial/polyval.m, scripts/polynomial/ppder.m, scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m, scripts/polynomial/ppval.m, scripts/polynomial/residue.m, scripts/polynomial/roots.m, scripts/polynomial/spline.m, scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m, scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m, scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m, scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m, scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m, scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m, scripts/signal/sinewave.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/unwrap.m, scripts/signal/yulewalker.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 21:50:57 -0700
parents 9fc020886ae9
children
line wrap: on
line diff
--- a/scripts/polynomial/pchip.m	Mon May 04 14:22:02 2015 -0700
+++ b/scripts/polynomial/pchip.m	Mon May 04 21:50:57 2015 -0700
@@ -24,32 +24,34 @@
 ##
 ## If called with two arguments, return the piecewise polynomial @var{pp}
 ## that may be used with @code{ppval} to evaluate the polynomial at specific
-## points.  When called with a third input argument, @code{pchip} evaluates
-## the pchip polynomial at the points @var{xi}.  The third calling form is
-## equivalent to @code{ppval (pchip (@var{x}, @var{y}), @var{xi})}.
+## points.
+##
+## When called with a third input argument, @code{pchip} evaluates the pchip
+## polynomial at the points @var{xi}.  The third calling form is equivalent to
+## @code{ppval (pchip (@var{x}, @var{y}), @var{xi})}.
 ##
-## The variable @var{x} must be a strictly monotonic vector (either
-## increasing or decreasing) of length @var{n}.  @var{y} can be either a
-## vector or array.  If @var{y} is a vector then it must be the same length
-## @var{n} as @var{x}.  If @var{y} is an array then the size of @var{y} must
-## have the form
+## The variable @var{x} must be a strictly monotonic vector (either increasing
+## or decreasing) of length @var{n}.
+##
+## @var{y} can be either a vector or array.  If @var{y} is a vector then it
+## must be the same length @var{n} as @var{x}.  If @var{y} is an array then
+## the size of @var{y} must have the form
 ## @tex
 ## $$[s_1, s_2, \cdots, s_k, n]$$
 ## @end tex
 ## @ifnottex
 ## @code{[@var{s1}, @var{s2}, @dots{}, @var{sk}, @var{n}]}
 ## @end ifnottex
-## The array is reshaped internally to a matrix where the leading
-## dimension is given by
+## The array is reshaped internally to a matrix where the leading dimension is
+## given by
 ## @tex
 ## $$s_1 s_2 \cdots s_k$$
 ## @end tex
 ## @ifnottex
 ## @code{@var{s1} * @var{s2} * @dots{} * @var{sk}}
 ## @end ifnottex
-## and each row of this matrix is then treated separately.  Note that this
-## is exactly opposite to @code{interp1} but is done for @sc{matlab}
-## compatibility.
+## and each row of this matrix is then treated separately.  Note that this is
+## exactly opposite to @code{interp1} but is done for @sc{matlab} compatibility.
 ##
 ## @seealso{spline, ppval, mkpp, unmkpp}
 ## @end deftypefn