/usr/include/openturns/swig/OptimizationSolverImplementation_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 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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | %define OT_OptimizationSolver_doc
"Base class for optimization wrappers.
Available constructors:
OptimizationSolver(*problem, verbose=False*)
Parameters
----------
problem : :class:`~openturns.OptimizationProblem`
Optimization problem.
verbose : bool
Let solver be more verbose.
Notes
-----
Class :class:`~openturns.OptimizationSolver` is an abstract class, which has several implementations.
The default implementation is :class:`~openturns.Cobyla`, but there are also
:class:`~openturns.AbdoRackwitz`, :class:`~openturns.SQP` and :class:`~openturns.TNC`.
Examples
--------
Define an optimization problem to find the minimum of the Rosenbrock function:
>>> import openturns as ot
>>> rosenbrock = ot.NumericalMathFunction(['x1', 'x2'], ['(1-x1)^2+100*(x2-x1^2)^2'])
>>> problem = ot.OptimizationProblem()
>>> problem.setObjective(rosenbrock)
>>> solver = ot.OptimizationSolver(problem)
>>> solver.setStartingPoint([0, 0])
>>> solver.setMaximumResidualError(1.e-8)
>>> solver.setMaximumIterationNumber(100000)
>>> solver.run()
>>> result = solver.getResult()"
%enddef
%feature("docstring") OT::OptimizationSolverImplementation
OT_OptimizationSolver_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getMaximumAbsoluteError_doc
"Accessor to maximum allowed absolute error.
Returns
-------
maximumAbsoluteError : float
Maximum allowed absolute error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getMaximumAbsoluteError
OT_OptimizationSolver_getMaximumAbsoluteError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getMaximumConstraintError_doc
"Accessor to maximum allowed constraint error.
Returns
-------
maximumConstraintError : float
Maximum allowed constraint error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getMaximumConstraintError
OT_OptimizationSolver_getMaximumConstraintError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getMaximumIterationNumber_doc
"Accessor to maximum allowed number of iterations.
Returns
-------
N : int
Maximum allowed number of iterations."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getMaximumIterationNumber
OT_OptimizationSolver_getMaximumIterationNumber_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getMaximumEvaluationNumber_doc
"Accessor to maximum allowed number of evaluations.
Returns
-------
N : int
Maximum allowed number of evaluations."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getMaximumEvaluationNumber
OT_OptimizationSolver_getMaximumEvaluationNumber_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getMaximumRelativeError_doc
"Accessor to maximum allowed relative error.
Returns
-------
maximumRelativeError : float
Maximum allowed relative error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getMaximumRelativeError
OT_OptimizationSolver_getMaximumRelativeError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getMaximumResidualError_doc
"Accessor to maximum allowed residual error.
Returns
-------
maximumResidualError : float
Maximum allowed residual error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getMaximumResidualError
OT_OptimizationSolver_getMaximumResidualError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getProblem_doc
"Accessor to optimization problem.
Returns
-------
problem : :class:`~openturns.OptimizationProblem`
Optimization problem."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getProblem
OT_OptimizationSolver_getProblem_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getResult_doc
"Accessor to optimization result.
Returns
-------
result : :class:`~openturns.OptimizationResult`
Result class."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getResult
OT_OptimizationSolver_getResult_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getStartingPoint_doc
"Accessor to starting point.
Returns
-------
startingPoint : :class:`~openturns.NumericalPoint`
Starting point."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getStartingPoint
OT_OptimizationSolver_getStartingPoint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_run_doc
"Launch the optimization."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::run
OT_OptimizationSolver_run_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setMaximumAbsoluteError_doc
"Accessor to maximum allowed absolute error.
Parameters
----------
maximumAbsoluteError : float
Maximum allowed absolute error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setMaximumAbsoluteError
OT_OptimizationSolver_setMaximumAbsoluteError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setMaximumConstraintError_doc
"Accessor to maximum allowed constraint error.
Parameters
----------
maximumConstraintError : float
Maximum allowed constraint error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setMaximumConstraintError
OT_OptimizationSolver_setMaximumConstraintError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setMaximumIterationNumber_doc
"Accessor to maximum allowed number of iterations.
Parameters
----------
N : int
Maximum allowed number of iterations."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setMaximumIterationNumber
OT_OptimizationSolver_setMaximumIterationNumber_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setMaximumEvaluationNumber_doc
"Accessor to maximum allowed number of evaluations.
Parameters
----------
N : int
Maximum allowed number of evaluations."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setMaximumEvaluationNumber
OT_OptimizationSolver_setMaximumEvaluationNumber_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setMaximumRelativeError_doc
"Accessor to maximum allowed relative error.
Parameters
----------
maximumRelativeError : float
Maximum allowed relative error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setMaximumRelativeError
OT_OptimizationSolver_setMaximumRelativeError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setMaximumResidualError_doc
"Accessor to maximum allowed residual error.
Parameters
----------
maximumResidualError : float
Maximum allowed residual error."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setMaximumResidualError
OT_OptimizationSolver_setMaximumResidualError_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setProblem_doc
"Accessor to optimization problem.
Parameters
----------
problem : :class:`~openturns.OptimizationProblem`
Optimization problem."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setProblem
OT_OptimizationSolver_setProblem_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setResult_doc
"Accessor to optimization result.
Parameters
----------
result : :class:`~openturns.OptimizationResult`
Result class."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setResult
OT_OptimizationSolver_setResult_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setStartingPoint_doc
"Accessor to starting point.
Parameters
----------
startingPoint : :class:`~openturns.NumericalPoint`
Starting point."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setStartingPoint
OT_OptimizationSolver_setStartingPoint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_setVerbose_doc
"Accessor to the verbosity flag.
Parameters
----------
verbose : bool
Verbosity flag state."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::setVerbose
OT_OptimizationSolver_setVerbose_doc
// ---------------------------------------------------------------------
%define OT_OptimizationSolver_getVerbose_doc
"Accessor to the verbosity flag.
Returns
----------
verbose : bool
Verbosity flag state."
%enddef
%feature("docstring") OT::OptimizationSolverImplementation::getVerbose
OT_OptimizationSolver_getVerbose_doc
|