Mercurial > hg > octave-nkf
comparison scripts/signal/ifftshift.m @ 20375: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 | abbe33bf0c74 |
comparison
equal
deleted
inserted
replaced
20374:df437a52bcaf | 20375:f1d0f506ee78 |
---|---|
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {} ifftshift (@var{x}) | 20 ## @deftypefn {Function File} {} ifftshift (@var{x}) |
21 ## @deftypefnx {Function File} {} ifftshift (@var{x}, @var{dim}) | 21 ## @deftypefnx {Function File} {} ifftshift (@var{x}, @var{dim}) |
22 ## Undo the action of the @code{fftshift} function. For even length | 22 ## Undo the action of the @code{fftshift} function. |
23 ## @var{x}, @code{fftshift} is its own inverse, but odd lengths differ | 23 ## |
24 ## slightly. | 24 ## For even length @var{x}, @code{fftshift} is its own inverse, but odd lengths |
25 ## differ slightly. | |
26 ## @seealso{fftshift} | |
25 ## @end deftypefn | 27 ## @end deftypefn |
26 | 28 |
27 ## Author: Vincent Cautaerts <vincent@comf5.comm.eng.osaka-u.ac.jp> | 29 ## Author: Vincent Cautaerts <vincent@comf5.comm.eng.osaka-u.ac.jp> |
28 ## Created: July 1997 | 30 ## Created: July 1997 |
29 ## Adapted-By: jwe | 31 ## Adapted-By: jwe |