/usr/include/openturns/swig/Rice_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 87 88 89 90 | %feature("docstring") OT::Rice
"Rice distribution.
Available constructors:
Rice(*sigma=1.0, nu=0.*)
Parameters
----------
sigma : float, :math:`\\\\sigma > 0`
Scale parameter.
nu : float, :math:`\\\\nu \\\\geq 0`
Location parameter.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = 2\\\\frac{x}{\\\\sigma^2}p_{\\\\chi^2(2,\\\\frac{\\\\nu^2}{\\\\sigma^2})}
\\\\left(\\\\frac{x^2}{\\\\sigma^2}\\\\right),
\\\\quad x \\\\in [0; +\\\\infty[
where :math:`p_{\\\\chi^2(\\\\nu, \\\\lambda)}` is the probability density function of a
:class:`~openturns.NonCentralChiSquare` distribution.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\sigma \\\\sqrt{\\\\frac{\\\\pi}{2}}
L_{1/2}\\\\left(-\\\\frac{\\\\nu^2}{2\\\\sigma^2}\\\\right) \\\\\\\\
\\\\Var{X} & = & 2\\\\sigma^2 + \\\\nu^2 - \\\\frac{\\\\pi\\\\sigma^2}{2}
L_{1/2}^2\\\\left(\\\\frac{-\\\\nu^2}{2\\\\sigma^2}\\\\right)
\\\\end{eqnarray*}
where :math:`L_q(x)` denotes a Laguerre polynomial.
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Rice()
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Rice::getSigma
"Accessor to the distribution's scale parameter :math:`\\\\sigma`.
Returns
-------
sigma : float
Scale parameter :math:`\\\\sigma`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Rice::getNu
"Accessor to the distribution's location parameter :math:`\\\\nu`.
Returns
-------
nu : float
Location parameter :math:`\\\\nu`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Rice::setSigma
"Accessor to the distribution's scale parameter :math:`\\\\sigma`.
Parameters
----------
sigma : float, :math:`\\\\sigma > 0`
Scale parameter :math:`\\\\sigma`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Rice::setNu
"Accessor to the distribution's location parameter :math:`\\\\nu`.
Parameters
----------
nu : float, :math:`\\\\nu >= 0`
Location parameter :math:`\\\\nu`."
|