1%feature("docstring") OT::MetaModelResult
2"Data structure containing a metamodel.
3
4Available constructor:
5    MetaModelResult(model, metaModel, residuals, relativeErrors)
6
7Parameters
8----------
9model : :class:`~openturns.Function`
10    Physical model approximated by a metamodel.
11metaModel : :class:`~openturns.Function`
12    Definition of the response surface(s) of the model's output(s).
13residuals : sequence of float
14    The residual values defined as follows for each output of the model:
15    :math:`\displaystyle \frac{\sqrt{\sum_{i=1}^N (y_i - \hat{y_i})^2}}{N}`
16    with :math:`y_i` the :math:`N` model's values and :math:`\hat{y_i}` the
17    metamodel's values.
18relativeErrors : sequence of float
19    The relative errors defined as follows for each output of the model:
20    :math:`\displaystyle \frac{\sum_{i=1}^N (y_i - \hat{y_i})^2}{N \Var{\vect{Y}}}`
21    with :math:`\vect{Y}` the vector of the :math:`N` model's values
22    :math:`y_i` and :math:`\hat{y_i}` the metamodel's values.
23
24Notes
25-----
26Structure created by the method run() of :class:`~openturns.KrigingAlgorithm`
27or :class:`~openturns.FunctionalChaosAlgorithm` and obtained thanks to the
28method getResult() of these classes.
29
30See also
31--------
32FunctionalChaosResult"
33
34// ---------------------------------------------------------------------
35
36%feature("docstring") OT::MetaModelResult::getModel
37"Accessor to the model.
38
39Returns
40-------
41model : :class:`~openturns.Function`
42    Physical model approximated by a metamodel."
43
44// ---------------------------------------------------------------------
45
46%feature("docstring") OT::MetaModelResult::setModel
47"Accessor to the model.
48
49Parameters
50----------
51model : :class:`~openturns.Function`
52    Physical model approximated by a metamodel."
53
54// ---------------------------------------------------------------------
55
56%feature("docstring") OT::MetaModelResult::getMetaModel
57"Accessor to the metamodel.
58
59Returns
60-------
61metaModel : :class:`~openturns.Function`
62    Metamodel."
63
64// ---------------------------------------------------------------------
65
66%feature("docstring") OT::MetaModelResult::setMetaModel
67"Accessor to the metamodel.
68
69Parameters
70----------
71metaModel : :class:`~openturns.Function`
72    Metamodel."
73
74// ---------------------------------------------------------------------
75
76%feature("docstring") OT::MetaModelResult::getResiduals
77"Accessor to the residuals.
78
79Returns
80-------
81residuals : :class:`~openturns.Point`
82    The residual values defined as follows for each output of the model:
83    :math:`\displaystyle \frac{\sqrt{\sum_{i=1}^N (y_i - \hat{y_i})^2}}{N}`
84    with :math:`y_i` the :math:`N` model's values and :math:`\hat{y_i}` the
85    metamodel's values."
86
87// ---------------------------------------------------------------------
88
89%feature("docstring") OT::MetaModelResult::setResiduals
90"Accessor to the residuals.
91
92Parameters
93----------
94residuals : sequence of float
95    The residual values defined as follows for each output of the model:
96    :math:`\displaystyle \frac{\sqrt{\sum_{i=1}^N (y_i - \hat{y_i})^2}}{N}`
97    with :math:`y_i` the :math:`N` model's values and :math:`\hat{y_i}` the
98    metamodel's values."
99
100// ---------------------------------------------------------------------
101
102%feature("docstring") OT::MetaModelResult::getRelativeErrors
103"Accessor to the relative errors.
104
105Returns
106-------
107relativeErrors : :class:`~openturns.Point`
108    The relative errors  defined as follows for each output of the model:
109    :math:`\displaystyle \frac{\sum_{i=1}^N (y_i - \hat{y_i})^2}{N \Var{\vect{Y}}}`
110    with :math:`\vect{Y}` the vector of the :math:`N` model's values
111    :math:`y_i` and :math:`\hat{y_i}` the metamodel's values."
112
113// ---------------------------------------------------------------------
114
115%feature("docstring") OT::MetaModelResult::setRelativeErrors
116"Accessor to the relative errors.
117
118Parameters
119----------
120relativeErrors : sequence of float
121    The relative errors defined as follows for each output of the model:
122    :math:`\displaystyle \frac{\sum_{i=1}^N (y_i - \hat{y_i})^2}{N \Var{\vect{Y}}}`
123    with :math:`\vect{Y}` the vector of the :math:`N` model's values
124    :math:`y_i` and :math:`\hat{y_i}` the metamodel's values."