/usr/include/openturns/swig/RootStrategyImplementation_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 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 | %define OT_RootStrategy_doc
"Base class for root strategies.
*RootStrategy* is used through its derived classes:
- :class:`~openturns.SafeAndSlow`
- :class:`~openturns.RiskyAndFast`
- :class:`~openturns.MediumSafe`
See also
--------
DirectionalSampling"
%enddef
%feature("docstring") OT::RootStrategyImplementation
OT_RootStrategy_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_getMaximumDistance_doc
"Get the maximum distance.
Returns
-------
maximumDistance : positive float
Distance from the center of the standard space until which we research an
intersection with the limit state function along each direction. By
default, the maximum distance is equal to the value defined through the key
RootStrategyImplementation-DefaultMaximumDistance of the
:class:`~openturns.ResourceMap`."
%enddef
%feature("docstring") OT::RootStrategyImplementation::getMaximumDistance
OT_RootStrategy_getMaximumDistance_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_setMaximumDistance_doc
"Set the maximum distance.
Parameters
----------
maximumDistance : positive float
Distance from the center of the standard space until which we research an
intersection with the limit state function along each direction. By
default, the maximum distance is equal to the value defined through the key
RootStrategyImplementation-DefaultMaximumDistance of the
:class:`~openturns.ResourceMap`."
%enddef
%feature("docstring") OT::RootStrategyImplementation::setMaximumDistance
OT_RootStrategy_setMaximumDistance_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_getOriginValue_doc
"Get the origin value.
Returns
-------
origin : float
Value of the limit state function at the center of the standard space."
%enddef
%feature("docstring") OT::RootStrategyImplementation::getOriginValue
OT_RootStrategy_getOriginValue_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_setOriginValue_doc
"Set the origin value.
Parameters
----------
origin : float
Value of the limit state function at the center of the standard space."
%enddef
%feature("docstring") OT::RootStrategyImplementation::setOriginValue
OT_RootStrategy_setOriginValue_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_getSolver_doc
"Get the solver.
Returns
-------
solver : :class:`~openturns.Solver`
Non linear solver which will research the root in a segment."
%enddef
%feature("docstring") OT::RootStrategyImplementation::getSolver
OT_RootStrategy_getSolver_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_setSolver_doc
"Set the solver.
Parameters
----------
solver : :class:`~openturns.Solver`
Non linear solver which will research the root in a segment."
%enddef
%feature("docstring") OT::RootStrategyImplementation::setSolver
OT_RootStrategy_setSolver_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_getStepSize_doc
"Get the step size.
Returns
-------
stepSize : float
Length of each segment inside which the root research is performed. By
default, the step size is equal to the value defined through the key
RootStrategyImplementation-DefaultStepSize of the
:class:`~openturns.ResourceMap`."
%enddef
%feature("docstring") OT::RootStrategyImplementation::getStepSize
OT_RootStrategy_getStepSize_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_setStepSize_doc
"Set the step size.
Parameters
----------
stepSize : float
Length of each segment inside which the root research is performed. By
default, the step size is equal to the value defined through the key
RootStrategyImplementation-DefaultStepSize of the
:class:`~openturns.ResourceMap`."
%enddef
%feature("docstring") OT::RootStrategyImplementation::setStepSize
OT_RootStrategy_setStepSize_doc
// ---------------------------------------------------------------------
%define OT_RootStrategy_solve_doc
"Give all the roots found applying the root strategy.
Parameters
----------
function : :class:`~openturns.Function`
Function from :math:`\\\\Rset` to :math:`\\\\Rset` along the ray, a linear
function along the direction.
value : float
Returns
-------
roots : :class:`~openturns.ScalarCollection`
All the roots found applying the root strategy.
- If :class:`~openturns.SafeAndSlow`:
all the real values :math:`x` such as *function(x) = value* researched in
each segment of length *stepSize*, within *[origin, maximumDistance]*.
- If :class:`~openturns.RiskyAndFast`:
the real value :math:`x` such as *function(x) = value* researched within
*[origin, maximumDistance]*.
- If :class:`~openturns.MediumSafe`:
the real value :math:`x` such as *function(x) = value* researched the
first segment of length *stepSize*, within *[origin, maximumDistance]*
where a sign changement of function has been detected."
%enddef
%feature("docstring") OT::RootStrategyImplementation::solve
OT_RootStrategy_solve_doc
|