/usr/include/openturns/swig/LeastSquaresMethodImplementation_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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 | %define OT_LeastSquaresMethod_doc
"Base class for least square solvers.
Available constructors:
LeastSquaresMethod(*proxy, weight, indices*)
LeastSquaresMethod(*proxy, indices*)
Parameters
----------
proxy : :class:`~openturns.DesignProxy`
Input sample
weight : sequence of float
Output weights
indices : sequence of int
Indices allowed in the basis
See also
--------
CholeskyMethod, SVDMethod, QRMethod
Notes
-----
Solve the least-squares problem:
.. math::
\\\\vect{a} = \\\\argmin_{\\\\vect{b} \\\\in \\\\Rset^P} ||y - \\\\vect{b}^{\\\\intercal} \\\\vect{\\\\Psi}(\\\\vect{U})||^2
"
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation
OT_LeastSquaresMethod_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getInputSample_doc
"Input sample accessor.
Returns
-------
inputSample : :class:`~openturns.Sample`
Input sample."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getInputSample
OT_LeastSquaresMethod_getInputSample_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getWeight_doc
"Weights accessor.
Returns
-------
weight : :class:`~openturns.Point`
Weights."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getWeight
OT_LeastSquaresMethod_getWeight_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getBasis_doc
"Basis accessor.
Returns
-------
basis : :class:`~openturns.getBasis`
Basis."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getBasis
OT_LeastSquaresMethod_getBasis_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getCurrentIndices_doc
"Current indices accessor.
Returns
-------
indices : :class:`~openturns.Indices`
Indices of the current decomposition in the global basis."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getCurrentIndices
OT_LeastSquaresMethod_getCurrentIndices_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getInitialIndices_doc
"Initial indices accessor.
Returns
-------
indices : :class:`~openturns.Indices`
Initial indices of the terms in the global basis."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getInitialIndices
OT_LeastSquaresMethod_getInitialIndices_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_buildCurrentBasis_doc
"Build the current basis.
Returns
-------
phi : :class:`~openturns.Basis`
The basis according to current indices."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::buildCurrentBasis
OT_LeastSquaresMethod_buildCurrentBasis_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_solve_doc
"Solve the least-squares problem.
.. math::
\\\\vect{a} = \\\\argmin_{\\\\vect{x} \\\\in \\\\Rset^P} ||M\\\\vect{x}-\\\\vect{b}||^2
Parameters
----------
b : sequence of float
Second term of the equation
Returns
-------
a : :class:`~openturns.Point`
The solution."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::solve
OT_LeastSquaresMethod_solve_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_solveNormal_doc
"Solve the least-squares problem using normal equation.
.. math::
M^T*M*x=M^T*b
Parameters
----------
b : sequence of float
Second term of the equation
Returns
-------
x : :class:`~openturns.Point`
The solution."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::solveNormal
OT_LeastSquaresMethod_solveNormal_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getGramInverse_doc
"Get the inverse Gram matrix of input sample.
.. math::
G^{-1} = (X^T * X)^{-1}
Returns
-------
c : :class:`~openturns.CovarianceMatrix`
The inverse Gram matrix."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getGramInverse
OT_LeastSquaresMethod_getGramInverse_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getGramInverseDiag_doc
"Get the diagonal of the inverse Gram matrix.
.. math::
diag(G^{-1}) = diag((X^T * X)^{-1})
Returns
-------
d : :class:`~openturns.Point`
The diagonal of the inverse Gram matrix."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getGramInverseDiag
OT_LeastSquaresMethod_getGramInverseDiag_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getGramInverseTrace_doc
"Get the trace of the inverse Gram matrix.
.. math::
Tr(G^{-1}) = Tr(x^T * x)^{-1}
Returns
-------
x : :class:`~openturns.Scalar`
The trace of inverse Gram matrix."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getGramInverseTrace
OT_LeastSquaresMethod_getGramInverseTrace_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getH_doc
"Get the projection matrix H.
.. math::
H = X * (X^T * X)^{-1} * X^T
Returns
-------
h : :class:`~openturns.SymmetricMatrix`
The projection matrix H."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getH
OT_LeastSquaresMethod_getH_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_getHDiag_doc
"Get the diagonal of the projection matrix H.
.. math::
H = X * (X^T * X)^{-1} * X^T
Returns
-------
d : :class:`~openturns.Point`
The diagonal of H."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::getHDiag
OT_LeastSquaresMethod_getHDiag_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_computeWeightedDesign_doc
"Build the design matrix.
Parameters
----------
whole : bool, defaults to False
Whether to use the initial indices instead of the current indices
Returns
-------
psiAk : :class:`~openturns.Matrix`
The design matrix"
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::computeWeightedDesign
OT_LeastSquaresMethod_computeWeightedDesign_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_trashDecomposition_doc
"Drop the current decomposition."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::trashDecomposition
OT_LeastSquaresMethod_trashDecomposition_doc
// ---------------------------------------------------------------------
%define OT_LeastSquaresMethod_update_doc
"Update the current decomposition.
Parameters
----------
addedIndices : sequence of int
Indices of added basis terms.
conservedIndices : sequence of int
Indices of conserved basis terms.
removedIndices : sequence of int
Indices of removed basis terms."
%enddef
%feature("docstring") OT::LeastSquaresMethodImplementation::update
OT_LeastSquaresMethod_update_doc
|