/usr/include/openturns/swig/FunctionalChaosResult_doc.i is in libopenturns-dev 1.9-5.
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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | %feature("docstring") OT::FunctionalChaosResult
"Functional chaos result.
Notes
-----
Structure created by the method run() of
:class:`~openturns.FunctionalChaosAlgorithm`, and obtained thanks to the method
getResult()."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getCoefficients
"Get the coefficients.
Returns
-------
coefficients : 2-d sequence of float
Coefficients :math:`(\\\\vect{\\\\alpha_k})_{k \\\\in K}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getComposedMetaModel
"Get the composed metamodel.
Returns
-------
composedMetamodel : :class:`~openturns.Function`
:math:`\\\\tilde{f} = \\\\sum_{k \\\\in K} \\\\vect{\\\\alpha}_k \\\\Psi_k`"
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getMetaModel
"Get the metamodel.
Returns
-------
metamodel : :class:`~openturns.Function`
:math:`\\\\tilde{g} = \\\\sum_{k \\\\in K} \\\\vect{\\\\alpha}_k \\\\Psi_k \\\\circ T`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getComposedModel
"Get the composed model.
Returns
-------
composedModel : :class:`~openturns.Function`
:math:`f = g\\\\circ T^{-1}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getDistribution
"Get the input distribution.
Returns
-------
distribution : :class:`~openturns.Distribution`
Distribution of the input random vector :math:`\\\\vect{X}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getIndices
"Get the indices of the final basis.
Returns
-------
indices : :class:`~openturns.Indices`
Indices of the elements of the multivariate basis used in the decomposition."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getInverseTransformation
"Get the inverse isoprobabilistic transformation.
Returns
-------
invTransf : :class:`~openturns.Function`
:math:`T^{-1}` such that :math:`T(\\\\vect{X}) = \\\\vect{Z}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getOrthogonalBasis
"Get the orthogonal basis.
Returns
-------
basis : :class:`~openturns.OrthogonalBasis`
Factory of the orthogonal basis."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getReducedBasis
"Get the reduced basis.
Returns
-------
basis : list of :class:`~openturns.Function`
Collection of the *K* functions :math:`(\\\\Psi_k)_{k\\\\in K}` used in the
decomposition."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalChaosResult::getTransformation
"Get the isoprobabilistic transformation.
Returns
-------
transformation : :class:`~openturns.Function`
Transformation :math:`T` such that :math:`T(\\\\vect{X}) = \\\\vect{Z}`."
|