Mercurial > octave
comparison scripts/signal/hamming.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 | 230c1e2a678d |
children | 83792dd9bcc1 |
comparison
equal
deleted
inserted
replaced
20164:df437a52bcaf | 20165:f1d0f506ee78 |
---|---|
25 ## If the optional argument @qcode{"periodic"} is given, the periodic form | 25 ## If the optional argument @qcode{"periodic"} is given, the periodic form |
26 ## of the window is returned. This is equivalent to the window of length | 26 ## of the window is returned. This is equivalent to the window of length |
27 ## @var{m}+1 with the last coefficient removed. The optional argument | 27 ## @var{m}+1 with the last coefficient removed. The optional argument |
28 ## @qcode{"symmetric"} is equivalent to not specifying a second argument. | 28 ## @qcode{"symmetric"} is equivalent to not specifying a second argument. |
29 ## | 29 ## |
30 ## For a definition of the Hamming window, see e.g., | 30 ## For a definition of the Hamming window see, e.g., |
31 ## @nospell{A.V. Oppenheim & R. W. Schafer}, | 31 ## @nospell{A.V. Oppenheim & R. W. Schafer}, |
32 ## @cite{Discrete-Time Signal Processing}. | 32 ## @cite{Discrete-Time Signal Processing}. |
33 ## @end deftypefn | 33 ## @end deftypefn |
34 | 34 |
35 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> | 35 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> |