comparison scripts/signal/yulewalker.m @ 20200: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
20199:df437a52bcaf 20200:f1d0f506ee78
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{a}, @var{v}] =} yulewalker (@var{c}) 20 ## @deftypefn {Function File} {[@var{a}, @var{v}] =} yulewalker (@var{c})
21 ## Fit an AR (p)-model with Yule-Walker estimates given a vector @var{c} 21 ## Fit an AR (p)-model with Yule-Walker estimates given a vector @var{c} of
22 ## of autocovariances @code{[gamma_0, @dots{}, gamma_p]}. 22 ## autocovariances @code{[gamma_0, @dots{}, gamma_p]}.
23 ## 23 ##
24 ## Returns the AR coefficients, @var{a}, and the variance of white 24 ## Returns the AR coefficients, @var{a}, and the variance of white noise,
25 ## noise, @var{v}. 25 ## @var{v}.
26 ## @end deftypefn 26 ## @end deftypefn
27 27
28 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> 28 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>
29 ## Description: Fit AR model by Yule-Walker method 29 ## Description: Fit AR model by Yule-Walker method
30 30