1// OptimizationAlgorithm docstrings are defined in OptimizationAlgorithmImplementation_doc.i.in
2
3%feature("docstring") OT::OptimizationAlgorithm
4OT_OptimizationAlgorithm_doc
5%feature("docstring") OT::OptimizationAlgorithm::getMaximumAbsoluteError
6OT_OptimizationAlgorithm_getMaximumAbsoluteError_doc
7%feature("docstring") OT::OptimizationAlgorithm::getMaximumConstraintError
8OT_OptimizationAlgorithm_getMaximumConstraintError_doc
9%feature("docstring") OT::OptimizationAlgorithm::getMaximumIterationNumber
10OT_OptimizationAlgorithm_getMaximumIterationNumber_doc
11%feature("docstring") OT::OptimizationAlgorithm::getMaximumEvaluationNumber
12OT_OptimizationAlgorithm_getMaximumEvaluationNumber_doc
13%feature("docstring") OT::OptimizationAlgorithm::getMaximumRelativeError
14OT_OptimizationAlgorithm_getMaximumRelativeError_doc
15%feature("docstring") OT::OptimizationAlgorithm::getMaximumResidualError
16OT_OptimizationAlgorithm_getMaximumResidualError_doc
17%feature("docstring") OT::OptimizationAlgorithm::getProblem
18OT_OptimizationAlgorithm_getProblem_doc
19%feature("docstring") OT::OptimizationAlgorithm::getResult
20OT_OptimizationAlgorithm_getResult_doc
21%feature("docstring") OT::OptimizationAlgorithm::getStartingPoint
22OT_OptimizationAlgorithm_getStartingPoint_doc
23%feature("docstring") OT::OptimizationAlgorithm::run
24OT_OptimizationAlgorithm_run_doc
25%feature("docstring") OT::OptimizationAlgorithm::setMaximumAbsoluteError
26OT_OptimizationAlgorithm_setMaximumAbsoluteError_doc
27%feature("docstring") OT::OptimizationAlgorithm::setMaximumConstraintError
28OT_OptimizationAlgorithm_setMaximumConstraintError_doc
29%feature("docstring") OT::OptimizationAlgorithm::setMaximumIterationNumber
30OT_OptimizationAlgorithm_setMaximumIterationNumber_doc
31%feature("docstring") OT::OptimizationAlgorithm::setMaximumEvaluationNumber
32OT_OptimizationAlgorithm_setMaximumEvaluationNumber_doc
33%feature("docstring") OT::OptimizationAlgorithm::setMaximumRelativeError
34OT_OptimizationAlgorithm_setMaximumRelativeError_doc
35%feature("docstring") OT::OptimizationAlgorithm::setMaximumResidualError
36OT_OptimizationAlgorithm_setMaximumResidualError_doc
37%feature("docstring") OT::OptimizationAlgorithm::setProblem
38OT_OptimizationAlgorithm_setProblem_doc
39%feature("docstring") OT::OptimizationAlgorithm::setResult
40OT_OptimizationAlgorithm_setResult_doc
41%feature("docstring") OT::OptimizationAlgorithm::setStartingPoint
42OT_OptimizationAlgorithm_setStartingPoint_doc
43%feature("docstring") OT::OptimizationAlgorithm::setVerbose
44OT_OptimizationAlgorithm_setVerbose_doc
45%feature("docstring") OT::OptimizationAlgorithm::getVerbose
46OT_OptimizationAlgorithm_getVerbose_doc
47%feature("docstring") OT::OptimizationAlgorithm::setProgressCallback
48OT_OptimizationAlgorithm_setProgressCallback_doc
49%feature("docstring") OT::OptimizationAlgorithm::setStopCallback
50OT_OptimizationAlgorithm_setStopCallback_doc
51
52// ---------------------------------------------------------------------
53
54%feature("docstring") OT::OptimizationAlgorithm::Build
55"Instanciate an optimization algorithm from name or problem.
56
57Parameters
58----------
59name : str or :class:`~openturns.OptimizationProblem`
60    Name of the algorithm or problem to solve.
61    For example `TNC`, `Cobyla` or one of the :class:`~openturns.NLopt` solver names."
62
63// ---------------------------------------------------------------------
64
65%feature("docstring") OT::OptimizationAlgorithm::GetAlgorithmNames
66"Get the list of available solver names.
67
68Parameters
69----------
70problem : :class:`~openturns.OptimizationProblem`, optional
71    Problem to solve.
72
73Returns
74-------
75names : :class:`~openturns.Description`
76    List of available solver names."
77