/usr/include/openturns/swig/MetaModelResult_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 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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | %feature("docstring") OT::MetaModelResult
"Data structure containing a metamodel.
Available constructor:
MetaModelResult(model, metaModel, residuals, relativeErrors)
Parameters
----------
model : :class:`~openturns.NumericalMathFunction`
Physical model approximated by a metamodel.
metaModel : :class:`~openturns.NumericalMathFunction`
Definition of the response surface(s) of the model's output(s).
residuals : sequence of float
The residual values defined as follows for each output of the model:
:math:`\\\\displaystyle \\\\frac{\\\\sqrt{\\\\sum_{i=1}^N (y_i - \\\\hat{y_i})^2}}{N}`
with :math:`y_i` the :math:`N` model's values and :math:`\\\\hat{y_i}` the
metamodel's values.
relativeErrors : sequence of float
The relative errors defined as follows for each output of the model:
:math:`\\\\displaystyle \\\\frac{\\\\sum_{i=1}^N (y_i - \\\\hat{y_i})^2}{N \\\\Var{\\\\vect{Y}}}`
with :math:`\\\\vect{Y}` the vector of the :math:`N` model's values
:math:`y_i` and :math:`\\\\hat{y_i}` the metamodel's values.
Notes
-----
Structure created by the method run() of :class:`~openturns.KrigingAlgorithm`
or :class:`~openturns.FunctionalChaosAlgorithm` and obtained thanks to the
method getResult() of these classes.
See also
--------
FunctionalChaosResult"
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::getModel
"Accessor to the model.
Returns
-------
model : :class:`~openturns.NumericalMathFunction`
Physical model approximated by a metamodel."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::setModel
"Accessor to the model.
Parameters
----------
model : :class:`~openturns.NumericalMathFunction`
Physical model approximated by a metamodel."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::getMetaModel
"Accessor to the metamodel.
Returns
-------
metaModel : :class:`~openturns.NumericalMathFunction`
Metamodel."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::setMetaModel
"Accessor to the metamodel.
Parameters
----------
metaModel : :class:`~openturns.NumericalMathFunction`
Metamodel."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::getResiduals
"Accessor to the residuals.
Returns
-------
residuals : :class:`~openturns.NumericalPoint`
The residual values defined as follows for each output of the model:
:math:`\\\\displaystyle \\\\frac{\\\\sqrt{\\\\sum_{i=1}^N (y_i - \\\\hat{y_i})^2}}{N}`
with :math:`y_i` the :math:`N` model's values and :math:`\\\\hat{y_i}` the
metamodel's values."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::setResiduals
"Accessor to the residuals.
Parameters
----------
residuals : sequence of float
The residual values defined as follows for each output of the model:
:math:`\\\\displaystyle \\\\frac{\\\\sqrt{\\\\sum_{i=1}^N (y_i - \\\\hat{y_i})^2}}{N}`
with :math:`y_i` the :math:`N` model's values and :math:`\\\\hat{y_i}` the
metamodel's values."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::getRelativeErrors
"Accessor to the relative errors.
Returns
-------
relativeErrors : :class:`~openturns.NumericalPoint`
The relative errors defined as follows for each output of the model:
:math:`\\\\displaystyle \\\\frac{\\\\sum_{i=1}^N (y_i - \\\\hat{y_i})^2}{N \\\\Var{\\\\vect{Y}}}`
with :math:`\\\\vect{Y}` the vector of the :math:`N` model's values
:math:`y_i` and :math:`\\\\hat{y_i}` the metamodel's values."
// ---------------------------------------------------------------------
%feature("docstring") OT::MetaModelResult::setRelativeErrors
"Accessor to the relative errors.
Parameters
----------
relativeErrors : sequence of float
The relative errors defined as follows for each output of the model:
:math:`\\\\displaystyle \\\\frac{\\\\sum_{i=1}^N (y_i - \\\\hat{y_i})^2}{N \\\\Var{\\\\vect{Y}}}`
with :math:`\\\\vect{Y}` the vector of the :math:`N` model's values
:math:`y_i` and :math:`\\\\hat{y_i}` the metamodel's values."
|