/usr/include/openturns/swig/NonCentralChiSquare_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 91 92 93 94 95 96 97 98 99 | %feature("docstring") OT::NonCentralChiSquare
"NonCentralChiSquare distribution.
Available constructors:
NonCentralChiSquare(*nu=5.0, lambda=0.*)
Parameters
----------
nu : float, :math:`\\\\nu > 0`
Generalised number degree of freedom.
lambda : float, :math:`\\\\lambda \\\\geq 0`
Non-centrality parameter :math:`\\\\lambda`.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\sum_{j=0}^{\\\\infty} e^{-\\\\lambda}
\\\\frac{\\\\lambda^j}{j!}p_{\\\\chi^2(\\\\nu + 2j)}(x),
\\\\quad x \\\\in [0; +\\\\infty[
where :math:`p_{\\\\chi^2(q)}` is the probability density function of a
:math:`\\\\chi^2(q)` random variate.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\nu + \\\\lambda \\\\\\\\
\\\\Var{X} & = & 2(\\\\nu + 2\\\\lambda)
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.NonCentralChiSquare(6.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::NonCentralChiSquare::getNu
"Accessor to the distribution's generalised number degrees of freedom.
Returns
-------
nu : float
Generalised number degrees of freedom :math:`\\\\nu`."
// ---------------------------------------------------------------------
%feature("docstring") OT::NonCentralChiSquare::getLambda
"Accessor to the distribution's non-centrality parameter :math:`\\\\lambda`.
Returns
-------
lambda : float
Non-centrality parameter :math:`\\\\lambda`."
// ---------------------------------------------------------------------
%feature("docstring") OT::NonCentralChiSquare::setNu
"Accessor to the distribution's generalised number degrees of freedom.
Parameters
----------
nu : float, :math:`\\\\nu > 0`
Generalised number degrees of freedom :math:`\\\\nu`."
// ---------------------------------------------------------------------
%feature("docstring") OT::NonCentralChiSquare::setLambda
"Accessor to the distribution's non-centrality parameter :math:`\\\\lambda`.
Parameters
----------
lambda : float
Non-centrality parameter :math:`\\\\lambda`."
// ---------------------------------------------------------------------
%feature("docstring") OT::NonCentralChiSquare::setNuLambda
"Accessor to the distribution's non-centrality parameters.
Parameters :math:`\\\\lambda` and generalised number degrees of freedom.
Parameters
----------
nu : float, :math:`\\\\nu > 0`
Generalised number degrees of freedom :math:`\\\\nu`.
lambda : float
Non-centrality parameter :math:`\\\\lambda`."
|