/usr/include/openturns/swig/OptimizationProblemImplementation_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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | %define OT_OptimizationProblem_doc
"Base class to define an optimization problem.
Available constructors:
OptimizationProblem()
OptimizationProblem(*objective, equality, inequality, bounds*)
OptimizationProblem(*level, value*)
Parameters
----------
objective : :class:`~openturns.NumericalMathFunction`
Objective function.
equality : :class:`~openturns.NumericalMathFunction`
Equality constraints.
inequality : :class:`~openturns.NumericalMathFunction`
Inequality constraints.
bounds : :class:`~openturns.Interval`
Bounds.
level : :class:`~openturns.NumericalMathFunction`
Level function.
value : float
Level value.
Notes
-----
The first form represents a general optimization problem:
.. math::
\\\\min_{x\\\\in B} f(x) \\\\\\\\
g(x) = 0 \\\\\\\\
h(x) \\\\ge 0
where *B* is problem's bounds, *f* is the objective function, *g* are equality constraints, and *h* are inequality constraints.
The second form represents a nearest point problem:
.. math::
\\\\min_{x} ||x|| \\\\\\\\
g(x) = v
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)
Define an optimization problem to find the point with minimum norm which satisfies :math:`x1+2*x2-3*x3+4*x4=3`.
>>> import openturns as ot
>>> levelFunction = ot.NumericalMathFunction(
... ['x1', 'x2', 'x3', 'x4'], ['x1+2*x2-3*x3+4*x4'])
>>> problem = ot.OptimizationProblem(levelFunction, 3.0)"
%enddef
%feature("docstring") OT::OptimizationProblemImplementation
OT_OptimizationProblem_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getBounds_doc
"Accessor to bounds.
Returns
-------
bounds : :class:`~openturns.Interval`
Problem bounds."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getBounds
OT_OptimizationProblem_getBounds_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getDimension_doc
"Accessor to spatial dimension.
Returns
-------
dimension : int
Input dimension of objective function."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getDimension
OT_OptimizationProblem_getDimension_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getEqualityConstraint_doc
"Accessor to equality constraints.
Returns
-------
equality : :class:`~openturns.NumericalMathFunction`
Describe equality constraints."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getEqualityConstraint
OT_OptimizationProblem_getEqualityConstraint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getInequalityConstraint_doc
"Accessor to inequality constraints.
Returns
-------
inequality : :class:`~openturns.NumericalMathFunction`
Describe inequality constraints."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getInequalityConstraint
OT_OptimizationProblem_getInequalityConstraint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getLevelFunction_doc
"Accessor to level function.
Returns
-------
level : :class:`~openturns.NumericalMathFunction`
Level function."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getLevelFunction
OT_OptimizationProblem_getLevelFunction_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getLevelValue_doc
"Accessor to level value.
Returns
-------
value : float
Level value."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getLevelValue
OT_OptimizationProblem_getLevelValue_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_getObjective_doc
"Accessor to objective function.
Returns
-------
objective : :class:`~openturns.NumericalMathFunction`
Objective function."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::getObjective
OT_OptimizationProblem_getObjective_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_hasBounds_doc
"Test whether bounds had been specified.
Returns
-------
value : bool
*True* if bounds had been set for this problem, *False* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::hasBounds
OT_OptimizationProblem_hasBounds_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_hasEqualityConstraint_doc
"Test whether equality constraints had been specified.
Returns
-------
value : bool
*True* if equality constraints had been set for this problem, *False* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::hasEqualityConstraint
OT_OptimizationProblem_hasEqualityConstraint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_hasInequalityConstraint_doc
"Test whether inequality constraints had been specified.
Returns
-------
value : bool
*True* if inequality constraints had been set for this problem, *False* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::hasInequalityConstraint
OT_OptimizationProblem_hasInequalityConstraint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_hasLevelFunction_doc
"Test whether level function had been specified.
Returns
-------
value : bool
*True* if level function had been set for this problem, *False* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::hasLevelFunction
OT_OptimizationProblem_hasLevelFunction_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_hasMultipleObjective_doc
"Test whether objective function is a scalar or vector function.
Returns
-------
value : bool
*False* if objective function is scalar, *True* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::hasMultipleObjective
OT_OptimizationProblem_hasMultipleObjective_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_isMinimization_doc
"Test whether this is a minimization or maximization problem.
Returns
-------
value : bool
*True* if this is a minimization problem (default), *False* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::isMinimization
OT_OptimizationProblem_isMinimization_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_setBounds_doc
"Accessor to bounds.
Parameters
----------
bounds : :class:`~openturns.Interval`
Problem bounds."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setBounds
OT_OptimizationProblem_setBounds_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_setEqualityConstraint_doc
"Accessor to equality constraints.
Parameters
----------
equalityConstraint : :class:`~openturns.NumericalMathFunction`
Equality constraints."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setEqualityConstraint
OT_OptimizationProblem_setEqualityConstraint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_setInequalityConstraint_doc
"Accessor to inequality constraints.
Parameters
----------
inequalityConstraint : :class:`~openturns.NumericalMathFunction`
Inequality constraints."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setInequalityConstraint
OT_OptimizationProblem_setInequalityConstraint_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_setLevelFunction_doc
"Accessor to level function.
Parameters
----------
levelFunction : :class:`~openturns.NumericalMathFunction`
Level function."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setLevelFunction
OT_OptimizationProblem_setLevelFunction_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_setLevelValue_doc
"Accessor to level value.
Parameters
----------
levelValue : float
Level value."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setLevelValue
OT_OptimizationProblem_setLevelValue_doc
%define OT_OptimizationProblem_setMinimization_doc
"Tell whether this is a minimization or maximization problem.
Parameters
----------
minimization : bool
*True* if this is a minimization problem, *False* otherwise."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setMinimization
OT_OptimizationProblem_setMinimization_doc
// ---------------------------------------------------------------------
%define OT_OptimizationProblem_setObjective_doc
"Accessor to objective function.
Parameters
----------
objectiveFunction : :class:`~openturns.NumericalMathFunction`
Objective function."
%enddef
%feature("docstring") OT::OptimizationProblemImplementation::setObjective
OT_OptimizationProblem_setObjective_doc
|