Mercurial > octave-antonio

comparison scripts/signal/arma_rnd.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
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} {} arma_rnd (@var{a}, @var{b}, @var{v}, @var{t}, @var{n}) 20 ## @deftypefn {Function File} {} arma_rnd (@var{a}, @var{b}, @var{v}, @var{t}, @var{n})
21 ## Return a simulation of the ARMA model 21 ## Return a simulation of the ARMA model.
22 ##
23 ## The ARMA model is defined by
22 ## 24 ##
23 ## @example 25 ## @example
24 ## @group 26 ## @group
25 ## x(n) = a(1) * x(n-1) + @dots{} + a(k) * x(n-k) 27 ## x(n) = a(1) * x(n-1) + @dots{} + a(k) * x(n-k)
26 ## + e(n) + b(1) * e(n-1) + @dots{} + b(l) * e(n-l) 28 ## + e(n) + b(1) * e(n-1) + @dots{} + b(l) * e(n-l)
27 ## @end group 29 ## @end group
28 ## @end example 30 ## @end example
29 ## 31 ##
30 ## @noindent 32 ## @noindent
31 ## in which @var{k} is the length of vector @var{a}, @var{l} is the 33 ## in which @var{k} is the length of vector @var{a}, @var{l} is the length of
32 ## length of vector @var{b} and @var{e} is Gaussian white noise with 34 ## vector @var{b} and @var{e} is Gaussian white noise with variance @var{v}.
33 ## variance @var{v}. The function returns a vector of length @var{t}. 35 ## The function returns a vector of length @var{t}.
34 ## 36 ##
35 ## The optional parameter @var{n} gives the number of dummy 37 ## The optional parameter @var{n} gives the number of dummy @var{x}(@var{i})
36 ## @var{x}(@var{i}) used for initialization, i.e., a sequence of length 38 ## used for initialization, i.e., a sequence of length @var{t}+@var{n} is
37 ## @var{t}+@var{n} is generated and @var{x}(@var{n}+1:@var{t}+@var{n}) 39 ## generated and @var{x}(@var{n}+1:@var{t}+@var{n}) is returned. If @var{n}
38 ## is returned. If @var{n} is omitted, @var{n} = 100 is used. 40 ## is omitted, @var{n} = 100 is used.
39 ## @end deftypefn 41 ## @end deftypefn
40 42
41 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> 43 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>
42 ## Description: Simulate an ARMA process 44 ## Description: Simulate an ARMA process
43 45