Mercurial > octave-antonio
diff scripts/signal/arma_rnd.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 | 9fc020886ae9 |
children |
line wrap: on
line diff
--- a/scripts/signal/arma_rnd.m Mon May 04 14:22:02 2015 -0700 +++ b/scripts/signal/arma_rnd.m Mon May 04 21:50:57 2015 -0700 @@ -18,7 +18,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} arma_rnd (@var{a}, @var{b}, @var{v}, @var{t}, @var{n}) -## Return a simulation of the ARMA model +## Return a simulation of the ARMA model. +## +## The ARMA model is defined by ## ## @example ## @group @@ -28,14 +30,14 @@ ## @end example ## ## @noindent -## in which @var{k} is the length of vector @var{a}, @var{l} is the -## length of vector @var{b} and @var{e} is Gaussian white noise with -## variance @var{v}. The function returns a vector of length @var{t}. +## in which @var{k} is the length of vector @var{a}, @var{l} is the length of +## vector @var{b} and @var{e} is Gaussian white noise with variance @var{v}. +## The function returns a vector of length @var{t}. ## -## The optional parameter @var{n} gives the number of dummy -## @var{x}(@var{i}) used for initialization, i.e., a sequence of length -## @var{t}+@var{n} is generated and @var{x}(@var{n}+1:@var{t}+@var{n}) -## is returned. If @var{n} is omitted, @var{n} = 100 is used. +## The optional parameter @var{n} gives the number of dummy @var{x}(@var{i}) +## used for initialization, i.e., a sequence of length @var{t}+@var{n} is +## generated and @var{x}(@var{n}+1:@var{t}+@var{n}) is returned. If @var{n} +## is omitted, @var{n} = 100 is used. ## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>