/usr/include/openturns/swig/Logistic_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 | %feature("docstring") OT::Logistic
"Logistic distribution.
Available constructors:
Logistic(*alpha=0., beta=1.0*)
Parameters
----------
alpha : float
Location parameter :math:`\\\\alpha`.
beta : float, :math:`\\\\beta > 0`
Scale parameter :math:`\\\\beta`.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{\\\\exp\\\\left(\\\\left(- \\\\frac{x - \\\\alpha}{\\\\beta}\\\\right)\\\\right)}
{\\\\beta \\\\left(1 + \\\\exp\\\\left(- \\\\frac{x-\\\\alpha}{\\\\beta}
\\\\right)\\\\right)^2},
\\\\quad x \\\\in \\\\Rset
with :math:`\\\\alpha \\\\in \\\\Rset` and :math:`\\\\beta > 0`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\alpha \\\\\\\\
\\\\Var{X} & = & \\\\frac{1}{3} \\\\pi^2 \\\\beta^2
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Logistic(0., 1.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Logistic::getAlpha
"Accessor to the distribution's location parameter :math:`\\\\alpha`.
Returns
-------
alpha : float
Location parameter :math:`\\\\alpha`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Logistic::getBeta
"Accessor to the distribution's scale parameter :math:`\\\\beta`.
Returns
-------
beta : float
Scale parameter :math:`\\\\beta`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Logistic::setAlpha
"Accessor to the distribution's location parameter :math:`\\\\alpha`.
Parameters
----------
alpha : float, :math:`\\\\alpha \\\\in \\\\Rset`
Location parameter :math:`\\\\alpha`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Logistic::setBeta
"Accessor to the distribution's scale parameter :math:`\\\\beta`.
Parameters
----------
beta : float, :math:`\\\\beta > 0`
Scale parameter :math:`\\\\beta`."
|