Mercurial > octave-antonio
comparison scripts/polynomial/unmkpp.m @ 20165:f1d0f506ee78 stable
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 |
comparison
equal
deleted
inserted
replaced
| 20164:df437a52bcaf | 20165:f1d0f506ee78 |
|---|---|
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {[@var{x}, @var{p}, @var{n}, @var{k}, @var{d}] =} unmkpp (@var{pp}) | 20 ## @deftypefn {Function File} {[@var{x}, @var{p}, @var{n}, @var{k}, @var{d}] =} unmkpp (@var{pp}) |
| 21 ## | 21 ## |
| 22 ## Extract the components of a piecewise polynomial structure @var{pp}. | 22 ## Extract the components of a piecewise polynomial structure @var{pp}. |
| 23 ## | |
| 23 ## The components are: | 24 ## The components are: |
| 24 ## | 25 ## |
| 25 ## @table @asis | 26 ## @table @asis |
| 26 ## @item @var{x} | 27 ## @item @var{x} |
| 27 ## Sample points. | 28 ## Sample points. |
| 28 ## | 29 ## |
| 29 ## @item @var{p} | 30 ## @item @var{p} |
| 30 ## Polynomial coefficients for points in sample interval. @code{@var{p} | 31 ## Polynomial coefficients for points in sample interval. |
| 31 ## (@var{i}, :)} contains the coefficients for the polynomial over | 32 ## @code{@var{p} (@var{i}, :)} contains the coefficients for the polynomial |
| 32 ## interval @var{i} ordered from highest to lowest. If @code{@var{d} > | 33 ## over interval @var{i} ordered from highest to lowest. If |
| 33 ## 1}, @code{@var{p} (@var{r}, @var{i}, :)} contains the coefficients for | 34 ## @code{@var{d} > 1}, @code{@var{p} (@var{r}, @var{i}, :)} contains the |
| 34 ## the r-th polynomial defined on interval @var{i}. | 35 ## coefficients for the r-th polynomial defined on interval @var{i}. |
| 35 ## | 36 ## |
| 36 ## @item @var{n} | 37 ## @item @var{n} |
| 37 ## Number of polynomial pieces. | 38 ## Number of polynomial pieces. |
| 38 ## | 39 ## |
| 39 ## @item @var{k} | 40 ## @item @var{k} |