Mercurial > octave-antonio

comparison scripts/signal/diffpara.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 9fc020886ae9
children
comparison
equal deleted inserted replaced
20164:df437a52bcaf 20165:f1d0f506ee78
21 ## Return the estimator @var{d} for the differencing parameter of an 21 ## Return the estimator @var{d} for the differencing parameter of an
22 ## integrated time series. 22 ## integrated time series.
23 ## 23 ##
24 ## The frequencies from @math{[2*pi*a/t, 2*pi*b/T]} are used for the 24 ## The frequencies from @math{[2*pi*a/t, 2*pi*b/T]} are used for the
25 ## estimation. If @var{b} is omitted, the interval 25 ## estimation. If @var{b} is omitted, the interval
26 ## @math{[2*pi/T, 2*pi*a/T]} is used. If both @var{b} and @var{a} are 26 ## @math{[2*pi/T, 2*pi*a/T]} is used. If both @var{b} and @var{a} are omitted
27 ## omitted then @math{a = 0.5 * sqrt (T)} and @math{b = 1.5 * sqrt (T)} 27 ## then @math{a = 0.5 * sqrt (T)} and @math{b = 1.5 * sqrt (T)} is used, where
28 ## is used, where @math{T} is the sample size. If @var{x} is a matrix, 28 ## @math{T} is the sample size. If @var{x} is a matrix, the differencing
29 ## the differencing parameter of each column is estimated. 29 ## parameter of each column is estimated.
30 ## 30 ##
31 ## The estimators for all frequencies in the intervals 31 ## The estimators for all frequencies in the intervals described above is
32 ## described above is returned in @var{dd}. The value of @var{d} is 32 ## returned in @var{dd}.
33 ## simply the mean of @var{dd}. 33 ##
34 ## The value of @var{d} is simply the mean of @var{dd}.
34 ## 35 ##
35 ## Reference: @nospell{P.J. Brockwell & R.A. Davis}. @cite{Time Series: 36 ## Reference: @nospell{P.J. Brockwell & R.A. Davis}. @cite{Time Series:
36 ## Theory and Methods}. Springer 1987. 37 ## Theory and Methods}. Springer 1987.
37 ## @end deftypefn 38 ## @end deftypefn
38 39