/usr/include/openturns/swig/MultiStart_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 | %feature("docstring") OT::MultiStart
"Multi start optimization algorithm.
The algorithm runs an optimization solver for N starting points and returns the
best result of each local search.
The algorithm succeeds when at least one local search succeeds.
Available constructors:
MultiStart(*solver, startingPoints*)
Parameters
----------
solver : :class:`~openturns.OptimizationAlgorithm`
The internal solver
startingPoints : 2-d sequence of float
Starting point candidates
Examples
--------
>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> dim = 2
>>> model = ot.SymbolicFunction(['x', 'y'], ['x^2+y^2*(1-x)^3'])
>>> bounds = ot.Interval([-3.0] * dim, [3.0] * dim)
>>> problem = ot.OptimizationProblem(model)
>>> problem.setBounds(bounds)
>>> solver = ot.TNC(problem)
>>> startingPoints = ot.Normal(dim).getSample(3)
>>> algo = ot.MultiStart(solver, startingPoints)
>>> algo.run()
>>> result = algo.getResult()"
// ---------------------------------------------------------------------
%feature("docstring") OT::MultiStart::getOptimizationAlgorithm
"Solver accessor.
Returns
-------
solver : :class:`~openturns.OptimizationAlgorithm`
The internal solver"
// ---------------------------------------------------------------------
%feature("docstring") OT::MultiStart::setOptimizationAlgorithm
"Solver accessor.
Parameters
----------
solver : :class:`~openturns.OptimizationAlgorithm`
The internal solver"
// ---------------------------------------------------------------------
%feature("docstring") OT::MultiStart::setStartingPoints
"Starting points accessor.
Parameters
----------
startingPointNumber : :class:`~openturns.Sample`
Starting points"
// ---------------------------------------------------------------------
%feature("docstring") OT::MultiStart::getStartingPoints
"Starting points accessor.
Returns
-------
startingPointNumber : :class:`~openturns.Sample`
Starting points"
// ---------------------------------------------------------------------
%feature("docstring") OT::MultiStart::getResultCollection
"Intermediate optimization results accessor.
Returns
-------
results : :class:`~openturns.OptimizationResultCollection`
Intermediate optimization results"
|