/usr/include/openturns/swig/OptimizationResult_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 | %feature("docstring") OT::OptimizationResult
"Optimization result.
Returned by optimization solvers, see :class:`~openturns.OptimizationAlgorithm`.
Available constructors:
OptimizationResult(*optimalPoint, optimalValue, iterationNumber, absoluteError, relativeError, residualError, constraintError*)
Parameters
----------
optimalPoint : sequence of float
Optimal point.
optimalValue : sequence of float
Value at optimal point.
iterationNumber : int
Number of iterations.
absoluteError : float
Parameters for this solver.
relativeError : float
Relative error.
residualError : float
Residual error.
constraintError : float
Constraint error.
problem : :class:`~openturns.OptimizationProblem`
Associated problem."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getAbsoluteError
"Accessor to the absolute error.
Returns
-------
absoluteError : float
Absolute error, defined by :math:`\\\\epsilon^a_n=\\\\|\\\\vect{x}_{n+1}-\\\\vect{x}_n\\\\|_{\\\\infty}` where :math:`\\\\vect{x}_{n+1}` and :math:`\\\\vect{x}_n` are two consecutive approximations of the optimum."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getAbsoluteErrorHistory
"Accessor to the evolution of the absolute error.
Returns
-------
absoluteErrorHistory : :class:`~openturns.Sample`
Value of the absolute error at each iteration of the solver."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getConstraintError
"Accessor to the constraint error.
Returns
-------
constraintError : float
Constraint error, defined by :math:`\\\\gamma_n=\\\\|g(\\\\vect{x}_n)\\\\|_{\\\\infty}` where :math:`\\\\vect{x}_n` is the current approximation of the optimum and :math:`g` is the function that gather all the equality and inequality constraints."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getConstraintErrorHistory
"Accessor to the evolution of the constraint error.
Returns
-------
constraintErrorHistory : :class:`~openturns.Sample`
Value of the constrainte error at each iteration of the solver."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::setIterationNumber
"Accessor to the number of iterations.
Parameters
----------
iterationNumber : int
Number of evaluations."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getIterationNumber
"Accessor to the number of iterations.
Returns
-------
iterationNumber : int
Number of evaluations."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getRelativeError
"Accessor to the relative error.
Returns
-------
relativeError : float
Relative error, defined by :math:`\\\\epsilon^r_n=\\\\epsilon^a_n/\\\\|\\\\vect{x}_{n+1}\\\\|_{\\\\infty}` if :math:`\\\\|\\\\vect{x}_{n+1}\\\\|_{\\\\infty}\\\\neq 0`, else :math:`\\\\epsilon^r_n=-1`."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getRelativeErrorHistory
"Accessor to the evolution of the relative error.
Returns
-------
relativeErrorHistory : :class:`~openturns.Sample`
Value of the relative error at each iteration of the solver."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getResidualError
"Accessor to the residual error.
Returns
-------
residualError : float
Residual error, defined by :math:`\\\\eta^r_n=\\\\|\\\\nabla\\\\cL{\\\\vect{x}_n}\\\\|_{\\\\infty}` where :math:`\\\\vect{x}_n` is the current approximation of the optimum and :math:`\\\\cL` is the Lagrangian of the problem."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getResidualErrorHistory
"Accessor to the evolution of the residual error.
Returns
-------
residualErrorHistory : :class:`~openturns.Sample`
Value of the residual error at each iteration of the solver."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::setOptimalPoint
"Accessor to the optimal point.
Parameters
----------
optimalPoint : :class:`~openturns.Point`
Optimal point"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getOptimalPoint
"Accessor to the optimal point.
Returns
-------
optimalPoint : :class:`~openturns.Point`
Optimal point"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::setLagrangeMultipliers
"Accessor to the Lagrange multipliers.
Parameters
----------
multipliers : :class:`~openturns.Point`
Lagrange multipliers.
Notes
-----
See :class:`~openturns.OptimizationAlgorithm` for the details on how the multipliers are defined and stored in the result.
"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getLagrangeMultipliers
"Accessor to the Lagrange multipliers.
Returns
-------
multipliers : :class:`~openturns.Point`
Lagrange multipliers.
Notes
-----
See :class:`~openturns.OptimizationAlgorithm` for the details on how the multipliers are defined and stored in the result.
"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::setOptimalValue
"Accessor to the optimal value.
Parameters
----------
optimalValue : :class:`~openturns.Point`
Value at the optimal point"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getOptimalValue
"Accessor to the optimal value.
Returns
-------
optimalValue : :class:`~openturns.Point`
Value at the optimal point"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getInputSample
"Accessor to the input sample.
Returns
-------
inputSample : :class:`~openturns.Sample`
Input points used by the solver"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getOutputSample
"Accessor to the output sample.
Returns
-------
outputSample : :class:`~openturns.Sample`
Output points used by the solver"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::setProblem
"Accessor to the underlying optimization problem.
Parameters
----------
problem : :class:`~openturns.OptimizationProblem`
Problem corresponding to the result"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getProblem
"Accessor to the underlying optimization problem.
Returns
-------
problem : :class:`~openturns.OptimizationProblem`
Problem corresponding to the result"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::drawErrorHistory
"Draw the convergence criteria history.
Returns
-------
graph : :class:`~openturns.Graph`
Convergence criteria history graph"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::drawOptimalValueHistory
"Draw the optimal value history.
Returns
-------
graph : :class:`~openturns.Graph`
Optimal value history graph"
|