/usr/include/openturns/swig/LinearModel_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::LinearModel
"The linear model class is created through the method build of a LinearModelFactory.
See Also
--------
LinearModelFactory
"
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearModel::getConfidenceIntervals
"Accessor to the confidence intervals.
Returns
-------
confInterval : :class:`~openturns.Interval`
The confidence intervals of the linear model coefficients,
corresponding to the level precised when the LinearModel class has been
created through the method *build*."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearModel::getPValues
"Accessor to the p-values.
Returns
-------
pvalues : collection of :class:`~openturns.NumericalScalar`
The collection of the p-values of the linear model coefficients."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearModel::getPredicted
"Accessor to the evaluation function of linear model.
Parameters
----------
sampleX : 2-d sequence of float
The input sample to be evaluated by the linear model.
Returns
-------
Y : :class:`~openturns.NumericalSample`
The response :math:`Y` evaluated through the linear model on the sample
*sampleX*."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearModel::getRegression
"Accessor to the regression coefficients.
Returns
-------
coef : :class:`~openturns.NumericalPoint`
The coefficients of the linear model: :math:`(a_0, a_1, \\\\ldots, a_n)`."
// ---------------------------------------------------------------------
%feature("docstring") OT::LinearModel::getResidual
"Accessor to the residuals.
Parameters
----------
Xsample: 2-d sequence of float
The input sample on which the linear model has been built.
Ysample: 2-d sequence of float
The 1d output sample on which the linear model has been built.
Returns
-------
residual : :class:`~openturns.NumericalSample`
The residuals computed on each point."
|