/usr/include/openturns/swig/SolverImplementation_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 | %define OT_Solver_doc
"SolverImplementation of 1D non linear equations.
Available constructor:
SolverImplementation()
SolverImplementation(*solverImplementation*)
SolverImplementation(*absError, relError, resError, maximumFunctionEvaluation*)
Parameters
----------
solverImplementation : SolverImplementationImplementation
The implementation of a particular solver which is :class:`~openturns.Bisection`,
:class:`~openturns.Brent` or :class:`~openturns.Secant`.
absError : positive float
Absolute error: distance between two successive iterates at the end point.
Default is :math:`10^{-5}`.
relError : positive float
Relative error: distance between the two last successive iterates with
regards to the last iterate. Default is :math:`10^{-5}`.
resError : positive float
Residual error: difference between the last iterate value and the expected
value. Default is :math:`10^{-8}`.
maximumFunctionEvaluation : int
The maximum number of evaluations of the function. Default is :math:`100`.
See also
--------
Bisection, Brent, Secant
Notes
-----
This class enables to solve 1D non linear equations :
.. math::
f(x) = value, \\\\forall x \\\\in [infPoint, supPoint]
if :math:`f` is a continuous function from :math:`\\\\Rset` to :math:`\\\\Rset`,
:math:`infPoint, supPoint \\\\in \\\\Rset` and if :math:`f` is such that
:math:`f(infPoint) \\\\times f(supPoint) < 0`, then :math:`f` has at least a zero
in the interval :math:`[infPoint, supPoint]`. In particular, it is used in the
root research of a
:class:`Directional Sampling simulation <openturns.DirectionalSampling>`."
%enddef
%feature("docstring") OT::SolverImplementation
OT_Solver_doc
// ---------------------------------------------------------------------
%define OT_Solver_getAbsoluteError_doc
"Accessor to the absolute error.
Returns
-------
absError : float
The absolute error: distance between two successive iterates at the end point."
%enddef
%feature("docstring") OT::SolverImplementation::getAbsoluteError
OT_Solver_getAbsoluteError_doc
// ---------------------------------------------------------------------
%define OT_Solver_getMaximumFunctionEvaluation_doc
"Accessor to the maximum number of evaluations of the function.
Returns
-------
maxEval : int
The maximum number of evaluations of the function."
%enddef
%feature("docstring") OT::SolverImplementation::getMaximumFunctionEvaluation
OT_Solver_getMaximumFunctionEvaluation_doc
// ---------------------------------------------------------------------
%define OT_Solver_getRelativeError_doc
"Accessor to the relative error.
Returns
-------
relError : float
The relative error: distance between the two last successive iterates with
regards to the last iterate."
%enddef
%feature("docstring") OT::SolverImplementation::getRelativeError
OT_Solver_getRelativeError_doc
// ---------------------------------------------------------------------
%define OT_Solver_getResidualError_doc
"Accessor to the residual error.
Returns
-------
resError : float
The residual errors: difference between the last iterate value and the
expected value."
%enddef
%feature("docstring") OT::SolverImplementation::getResidualError
OT_Solver_getResidualError_doc
// ---------------------------------------------------------------------
%define OT_Solver_setAbsoluteError_doc
"Accessor to the absolute error.
Parameters
----------
absError : float
The absolute error: distance between two successive iterates at the end point."
%enddef
%feature("docstring") OT::SolverImplementation::setAbsoluteError
OT_Solver_setAbsoluteError_doc
// ---------------------------------------------------------------------
%define OT_Solver_setMaximumFunctionEvaluation_doc
"Accessor to the maximum number of evaluations of the function.
Parameters
----------
maxEval : int
The maximum number of evaluations of the function."
%enddef
%feature("docstring") OT::SolverImplementation::setMaximumFunctionEvaluation
OT_Solver_setMaximumFunctionEvaluation_doc
// ---------------------------------------------------------------------
%define OT_Solver_setRelativeError_doc
"Accessor to the relative error.
Parameters
----------
relError : float
The relative error: distance between the two last successive iterates with
regards to the last iterate."
%enddef
%feature("docstring") OT::SolverImplementation::setRelativeError
OT_Solver_setRelativeError_doc
// ---------------------------------------------------------------------
%define OT_Solver_setResidualError_doc
"Accessor to the residual error.
Parameters
----------
resError : float
The residual errors: difference between the last iterate value and the
expected value."
%enddef
%feature("docstring") OT::SolverImplementation::setResidualError
OT_Solver_setResidualError_doc
// ---------------------------------------------------------------------
%define OT_Solver_getUsedFunctionEvaluation_doc
"Accessor to the number of evaluations of the function.
Returns
-------
nEval : int
The number of evaluations of the function."
%enddef
%feature("docstring") OT::SolverImplementation::getUsedFunctionEvaluation
OT_Solver_getUsedFunctionEvaluation_doc
|