/usr/include/openturns/swig/Rayleigh_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 | %feature("docstring") OT::Rayleigh
"Rayleigh distribution.
Available constructors:
Rayleigh(*sigma=1.0, gamma=0.*)
Parameters
----------
sigma : float, :math:`\\\\sigma > 0`
Scale parameter :math:`\\\\sigma`.
gamma : float
Location parameter :math:`\\\\gamma`.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{(x - \\\\gamma)} {\\\\sigma^2}
exp \\\\left(-\\\\frac{(x - \\\\gamma)^2}{2\\\\sigma^2}\\\\right)
\\\\quad x \\\\in [\\\\gamma,+\\\\infty[
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\sigma sqrt{\\\\frac{\\\\pi}{2}} + \\\\gamma \\\\\\\\
\\\\Var{X} & = & \\\\frac{4 - \\\\pi}{2} \\\\sigma^2
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Poisson(10.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Rayleigh::getSigma
"Accessor to the distribution's scale parameter :math:`\\\\sigma`.
Returns
-------
sigma : float
Scale parameter :math:`\\\\sigma`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Rayleigh::getGamma
"Accessor to the distribution's location parameter :math:`\\\\gamma`.
Returns
-------
gamma : float
Location parameter :math:`\\\\gamma`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Rayleigh::setSigma
"Accessor to the distribution's scale parameter :math:`\\\\sigma`.
Parameters
----------
sigma : float, :math:`\\\\sigma > 0`
Scale parameter :math:`\\\\sigma`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Rayleigh::setGamma
"Accessor to the distribution's location parameter :math:`\\\\gamma`.
Parameters
----------
gamma : float
Location parameter :math:`\\\\gamma`."
|