/usr/include/openturns/swig/OptimizationResult_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 | %feature("docstring") OT::OptimizationResult
"Optimization result.
Returned by optimization solvers, see :class:`~openturns.OptimizationSolver`.
Parameters
----------
optimalPoint : sequence of float
Optimal point.
optimalValue : sequence of float
Value at optimal point.
iterationNumber : int
Number of iterations.
absoluteError : float
Parameters for this solver.
relativeError : float
Relative error.
residualError : float
Residual error.
constraintError : float
Constraint error."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getAbsoluteError
"Accessor to the absolute error.
Returns
-------
absoluteError : float
absolute error."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getConstraintError
"Accessor to the constraint error.
Returns
-------
constraintError : float
Constraint error."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getIterationNumber
"Accessor to the number of iterations.
Returns
-------
iterationNumber : int
Number of evaluations."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getRelativeError
"Accessor to the relative error.
Returns
-------
relativeError : float
allowed relative error."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getResidualError
"Accessor to the residual error.
Returns
-------
residualError : float
allowed residual error."
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getOptimalPoint
"Accessor to the optimal point.
Returns
-------
optimalPoint : :class:`~openturns.NumericalPoint`
Optimal point"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getOptimalValue
"Accessor to the optimal value.
Returns
-------
optimalValue : :class:`~openturns.NumericalPoint`
Value at the optimal point"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getInputSample
"Accessor to the input sample.
Returns
-------
inputSample : :class:`~openturns.NumericalSample`
Input points used by the solver"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::getOutputSample
"Accessor to the output sample.
Returns
-------
outputSample : :class:`~openturns.NumericalSample`
Output points used by the solver"
// ---------------------------------------------------------------------
%feature("docstring") OT::OptimizationResult::drawErrorHistory
"Draw the convergence criteria history.
Returns
-------
graph : :class:`~openturns.Graph`
Convergence criteria history graph"
// ---------------------------------------------------------------------
|