/usr/include/openturns/swig/FORMResult_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::FORMResult
"Result of a FORM analysis.
Available constructors:
FORMResult(*designPoint, limitStateVariable, isInFailureSpace*)
Notes
-----
Structure created by the method run() of the :class:`~openturns.FORM`
class and obtained thanks to its method getResult().
Parameters
----------
designPoint : sequence of float
Design point in the standard space resulting from the optimization
algorithm.
limitStateVariable : :class:`~openturns.Event`
Event of which the probability is calculated.
isInFailureSpace : bool
Indicates whether the origin of the standard space is in the failure space.
See also
--------
Analytical, AnalyticalResult, SORM, SORMResult, FORM, StrongMaximumTest"
// ---------------------------------------------------------------------
%feature("docstring") OT::FORMResult::drawEventProbabilitySensitivity
"Draw the sensitivities of the FORM failure probability.
Parameters
----------
width : float, optional
Value to calculate the shift position of the :class:`~openturns.BarPlot`.
By default it is 1.0.
Returns
-------
graphCollection : list of two :class:`~openturns.Graph` containing a barplot
The first graph drawing the sensitivities of the FORM failure probability
with regards to the parameters of the probabilistic input vector.
The second graph drawing the sensitivities of the FORM failure probability
with regards to the parameters of the dependence structure of the
probabilistic input vector."
// ---------------------------------------------------------------------
%feature("docstring") OT::FORMResult::getEventProbability
"Accessor to the failure probability :math:`P_f`.
Returns
-------
probability : positive float
The FORM failure probability :math:`P_f`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FORMResult::getEventProbabilitySensitivity
"Accessor to the sentivities of the FORM failure probability :math:`P_f`.
Returns
-------
sentivities : :class:`~openturns.Point`
Sentivities of the FORM failure probability with regards to the parameters
of the probabilistic input vector and to parameters of the dependence
structure of the probabilistic input vector."
// ---------------------------------------------------------------------
%feature("docstring") OT::FORMResult::getGeneralisedReliabilityIndex
"Accessor to the Generalised Reliability Index.
Returns
-------
index : float
Generalised reliability index :math:`\\\\beta_g` from the FORM failure
probability is equal to :math:`\\\\pm` the Hasofer reliability index
:math:`\\\\beta_{HL}` according to the fact the standard space center
fulfills the event or not."
|