Mercurial > octave-antonio
comparison scripts/polynomial/polygcd.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 | 4197fc428c7d |
children |
comparison
equal
deleted
inserted
replaced
20164:df437a52bcaf | 20165:f1d0f506ee78 |
---|---|
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {@var{q} =} polygcd (@var{b}, @var{a}) | 20 ## @deftypefn {Function File} {@var{q} =} polygcd (@var{b}, @var{a}) |
21 ## @deftypefnx {Function File} {@var{q} =} polygcd (@var{b}, @var{a}, @var{tol}) | 21 ## @deftypefnx {Function File} {@var{q} =} polygcd (@var{b}, @var{a}, @var{tol}) |
22 ## | 22 ## |
23 ## Find the greatest common divisor of two polynomials. This is equivalent | 23 ## Find the greatest common divisor of two polynomials. |
24 ## to the polynomial found by multiplying together all the common roots. | 24 ## |
25 ## Together with deconv, you can reduce a ratio of two polynomials. | 25 ## This is equivalent to the polynomial found by multiplying together all the |
26 ## common roots. Together with deconv, you can reduce a ratio of two | |
27 ## polynomials. | |
28 ## | |
26 ## The tolerance @var{tol} defaults to @code{sqrt (eps)}. | 29 ## The tolerance @var{tol} defaults to @code{sqrt (eps)}. |
27 ## | 30 ## |
28 ## @strong{Caution:} This is a numerically unstable algorithm and should not | 31 ## @strong{Caution:} This is a numerically unstable algorithm and should not |
29 ## be used on large polynomials. | 32 ## be used on large polynomials. |
30 ## | 33 ## |