Mercurial > octave-antonio

comparison scripts/polynomial/mpoles.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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20164:df437a52bcaf 20165:f1d0f506ee78
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}) 20 ## @deftypefn {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p})
21 ## @deftypefnx {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol}) 21 ## @deftypefnx {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol})
22 ## @deftypefnx {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol}, @var{reorder}) 22 ## @deftypefnx {Function File} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol}, @var{reorder})
23 ## Identify unique poles in @var{p} and their associated multiplicity. The 23 ## Identify unique poles in @var{p} and their associated multiplicity.
24 ## output is ordered from largest pole to smallest pole.
25 ## 24 ##
26 ## If the relative difference of two poles is less than @var{tol} then 25 ## The output is ordered from largest pole to smallest pole.
27 ## they are considered to be multiples. The default value for @var{tol} 26 ##
28 ## is 0.001. 27 ## If the relative difference of two poles is less than @var{tol} then they are
28 ## considered to be multiples. The default value for @var{tol} is 0.001.
29 ## 29 ##
30 ## If the optional parameter @var{reorder} is zero, poles are not sorted. 30 ## If the optional parameter @var{reorder} is zero, poles are not sorted.
31 ## 31 ##
32 ## The output @var{multp} is a vector specifying the multiplicity of the 32 ## The output @var{multp} is a vector specifying the multiplicity of the poles.
33 ## poles. @code{@var{multp}(n)} refers to the multiplicity of the Nth pole 33 ## @code{@var{multp}(n)} refers to the multiplicity of the Nth pole
34 ## @code{@var{p}(@var{idxp}(n))}. 34 ## @code{@var{p}(@var{idxp}(n))}.
35 ## 35 ##
36 ## For example: 36 ## For example:
37 ## 37 ##
38 ## @example 38 ## @example