/usr/include/openturns/swig/ARMAState_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | %feature("docstring") OT::ARMAState
"Last state recorded of an ARMA process.
Parameters
----------
values : :class:`~openturns.NumericalSample`
Last :math:`p` values of the :math:`ARMA(p,q)` process of dimension :math:`d`.
noises : :class:`~openturns.NumericalSample`
Last :math:`q` values of the white noise defining the :math:`ARMA(p,q)` process of dimension :math:`d`.
Examples
--------
Define a state of an :math:`ARMA(4,2)` process of dimension 1:
>>> import openturns as ot
>>> myLastValues = ot.NumericalSample([[0.6], [0.7], [0.3], [0.2]])
>>> myLastNoiseValues = ot.NumericalSample([[1.2], [1.8]])
>>> myARMAState = ot.ARMAState(myLastValues, myLastNoiseValues)
"
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMAState::getDimension
"Accessor to the dimension of coefficients in the list.
Returns
-------
dimension : int
The dimension :math:`d` of the ARMA process."
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMAState::getX
"Accessor to the last values of the ARMA process.
Returns
-------
values : :class:`~openturns.NumericalSample` of size :math:`p` and dimension :math:`d`
Last :math:`p` values of the :math:`ARMA(p,q)` process of dimension :math:`d`.
"
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMAState::setX
"Accessor to the last values of the ARMA process.
Parameters
----------
values : :class:`~openturns.NumericalSample` of size :math:`p` and dimension :math:`d`
Last :math:`p` values of the :math:`ARMA(p,q)` process of dimension :math:`d`.
"
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMAState::getEpsilon
"Accessor to the last values of the noise defining the ARMA process.
Returns
-------
noises : :class:`~openturns.NumericalSample` of size :math:`q` and dimension :math:`d`
Last :math:`q` values of the white noise of the :math:`ARMA(p,q)` process of dimension :math:`d`.
"
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMAState::setEpsilon
"Accessor to the last values of the noise defining the ARMA process.
Parameters
----------
noises : :class:`~openturns.NumericalSample` of size :math:`q` and dimension :math:`d`
Last :math:`q` values of the white noise of the :math:`ARMA(p,q)` process of dimension :math:`d`.
"
|