/usr/include/openturns/swig/SQP_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 | %feature("docstring") OT::SQP
"Sequential Quadratic Programming solver.
Available constructors:
SQP(*problem*)
SQP(*problem, tau, omega, smooth*)
Parameters
----------
problem : :class:`~openturns.OptimizationProblem`
Optimization problem to solve.
tau : float
Multiplicative decrease of linear step.
omega : float
Armijo factor.
smooth : float
Growing factor in penalization term.
Notes
-----
SQP methods solve a sequence of optimization subproblems,
each of which optimizes a quadratic model of the objective
subject to a linearization of the constraints.
See also
--------
AbdoRackwitz, Cobyla, TNC, NLopt
Examples
--------
>>> import openturns as ot
>>> model = ot.SymbolicFunction(['x1', 'x2', 'x3', 'x4'], ['x1*cos(x1)+2*x2*x3-3*x3+4*x3*x4'])
>>> problem = ot.OptimizationProblem(model, -0.5)
>>> algo = ot.SQP(problem)
>>> algo.setStartingPoint([0.0] * 4)
>>> algo.run()
>>> result = algo.getResult()"
// ---------------------------------------------------------------------
%feature("docstring") OT::SQP::getTau
"Accessor to tau parameter.
Returns
-------
tau : float
Multiplicative decrease of linear step."
// ---------------------------------------------------------------------
%feature("docstring") OT::SQP::setTau
"Accessor to tau parameter.
Parameters
----------
tau : float
Multiplicative decrease of linear step."
// ---------------------------------------------------------------------
%feature("docstring") OT::SQP::getOmega
"Accessor to omega parameter.
Returns
-------
omega : float
Armijo factor."
// ---------------------------------------------------------------------
%feature("docstring") OT::SQP::setOmega
"Accessor to omega parameter.
Parameters
----------
omega : float
Armijo factor."
// ---------------------------------------------------------------------
%feature("docstring") OT::SQP::getSmooth
"Accessor to smooth parameter.
Returns
-------
smooth : float
Growing factor in penalization term."
// ---------------------------------------------------------------------
%feature("docstring") OT::SQP::setSmooth
"Accessor to smooth parameter.
Parameters
----------
smooth : float
Growing factor in penalization term."
|