/usr/include/openturns/swig/DistributionParametersImplementation_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 | %define OT_DistributionParameters_doc
"Define a distribution with particular parameters.
This class enables to create a set of non-native parameters in order to
define distribution.
A *DistributionParameters* object can be used through its derived classes:
- :class:`~openturns.ArcsineMuSigma`
- :class:`~openturns.BetaMuSigma`
- :class:`~openturns.GammaMuSigma`
- :class:`~openturns.GumbelMuSigma`
- :class:`~openturns.GumbelAB`
- :class:`~openturns.LogNormalMuSigma`
- :class:`~openturns.LogNormalMuSigmaOverMu`
- :class:`~openturns.WeibullMuSigma`
See also
--------
ParametrizedDistribution, Distribution"
%enddef
%feature("docstring") OT::DistributionParametersImplementation
OT_DistributionParameters_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_getDistribution_doc
"Build a distribution based on a set of native parameters.
Returns
-------
distribution : :class:`~openturns.Distribution`
Distribution built with the native parameters."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::getDistribution
OT_DistributionParameters_getDistribution_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_setValues_doc
"Accessor to the parameters values.
Parameters
----------
values : sequence of float
List of parameters values."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::setValues
OT_DistributionParameters_setValues_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_getValues_doc
"Accessor to the parameters values.
Returns
-------
values : :class:`~openturns.Point`
List of parameters values."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::getValues
OT_DistributionParameters_getValues_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_getDescription_doc
"Get the description of the parameters.
Returns
-------
collection : :class:`~openturns.Description`
List of parameters names."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::getDescription
OT_DistributionParameters_getDescription_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_evaluate_doc
"Compute native parameters values.
Returns
-------
values : :class:`~openturns.Point`
The native parameter values."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::evaluate
OT_DistributionParameters_evaluate_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_gradient_doc
"Get the gradient.
Returns
-------
gradient : :class:`~openturns.Matrix`
The gradient of the transformation of the native parameters into the new
parameters.
Notes
-----
If we note :math:`(p_1, \\\\dots, p_q)` the native parameters and :math:`(p'_1, \\\\dots, p'_q)` the new ones, then the gradient matrix is :math:`\\\\left( \\\\dfrac{\\\\partial p'_i}{\\\\partial p_j} \\\\right)_{1 \\\\leq i,j \\\\leq q}`."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::gradient
OT_DistributionParameters_gradient_doc
// ---------------------------------------------------------------------
%define OT_DistributionParameters_inverse_doc
"Convert to native parameters.
Parameters
----------
inP : sequence of float
The non-native parameters.
Returns
-------
outP : :class:`~openturns.Point`
The native parameters."
%enddef
%feature("docstring") OT::DistributionParametersImplementation::inverse
OT_DistributionParameters_inverse_doc
|