1%feature("docstring") OT::Logistic
2"Logistic distribution.
3
4Parameters
5----------
6mu : float
7    Mean parameter :math:`\mu`.
8beta : float, :math:`\beta > 0`
9    Scale parameter :math:`\beta`.
10
11Notes
12-----
13Its probability density function is defined as:
14
15.. math::
16
17    f_X(x) = \frac{\exp\left(\left(- \frac{x - \mu}{\beta}\right)\right)}
18                  {\beta \left(1 + \exp\left(- \frac{x-\mu}{\beta}
19                                             \right)\right)^2},
20             \quad x \in \Rset
21
22with :math:`\mu \in \Rset` and :math:`\beta > 0`.
23
24Its first moments are:
25
26.. math::
27    :nowrap:
28
29    \begin{eqnarray*}
30        \Expect{X} & = & \mu \\
31        \Var{X} & = & \frac{1}{3} \pi^2 \beta^2
32    \end{eqnarray*}
33
34Examples
35--------
36Create a distribution:
37
38>>> import openturns as ot
39>>> distribution = ot.Logistic(0.0, 1.0)
40
41Draw a sample:
42
43>>> sample = distribution.getSample(5)"
44
45// ---------------------------------------------------------------------
46
47%feature("docstring") OT::Logistic::getMu
48"Accessor to the distribution's mean parameter :math:`\mu`.
49
50Returns
51-------
52mu : float
53    Mean parameter :math:`\mu`."
54
55// ---------------------------------------------------------------------
56
57%feature("docstring") OT::Logistic::getBeta
58"Accessor to the distribution's scale parameter :math:`\beta`.
59
60Returns
61-------
62beta : float
63    Scale parameter :math:`\beta`."
64
65// ---------------------------------------------------------------------
66
67%feature("docstring") OT::Logistic::setMu
68"Accessor to the distribution's mean parameter :math:`\mu`.
69
70Parameters
71----------
72mu : float, :math:`\mu \in \Rset`
73    Mean parameter :math:`\mu`."
74
75// ---------------------------------------------------------------------
76
77%feature("docstring") OT::Logistic::setBeta
78"Accessor to the distribution's scale parameter :math:`\beta`.
79
80Parameters
81----------
82beta : float, :math:`\beta > 0`
83    Scale parameter :math:`\beta`."
84