/usr/include/openturns/swig/ARMACoefficients_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 73 74 75 76 77 78 79 80 | %feature("docstring") OT::ARMACoefficients
"Coefficients of an ARMA process (MA or AR part).
Available constructors:
ARMACoefficients(*size, dimension*)
ARMACoefficients(*coeffList*)
ARMACoefficients(*matrixColl*)
Parameters
----------
size : int,
The number of elements in the list.
dimension : int,
The dimension of each element in the list.
coeffList : a list of floats,
In dimension 1, the list of the coefficients defining the recurrence of the ARMA process (MA or AR part).
matrixColl : a list of :class:`~openturns.SquareMatrix`
In dimension :math:`d`, the collection of square matrices in :math:`\\\\Rset^d \\\\times \\\\Rset^d` defining the recurrence of the ARMA process (MA or AR part).
Notes
-----
- In the first constructor:
The elements are the null elements (scalar in dimension 1 and the null matrix in upper dimension).
- In the other constructor:
The elements are specified in the constructor.
Examples
--------
Create the coefficients defining the recurrence of an ARMA process:
>>> import openturns as ot
>>> myARCoef = ot.ARMACoefficients([0.4, 0.3, 0.2, 0.1])
>>> myMACoef = ot.ARMACoefficients([0.4, 0.3])"
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMACoefficients::getDimension
"Accessor to the dimension of coefficients in the list.
Returns
-------
dimension : int
The dimension of elements in the list."
// ---------------------------------------------------------------------
%feature("docstring") OT::ARMACoefficients::add
"Add a new element in the list.
Available usages:
add(*coeff*)
add(*squareMat*)
Parameters
----------
coeff : float
A new scalar coefficient added to the list composed with scalars.
squareMat : :class:`~openturns.SquareMatrix`
A new element in the list composed with square matrices.
Returns
-------
- In the first usage:
A new list of elements composed with scalars.
- In the second usage:
A new list of elements composed with square matrices.
"
|