/usr/include/openturns/swig/Chi_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 | %feature("docstring") OT::Chi
":math:`\\\\chi` distribution.
Available constructors:
Chi(*nu=1.0*)
Parameters
----------
nu : float, :math:`\\\\nu > 0`
Degrees of freedom.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{2^{1 - \\\\nu / 2} x^{\\\\nu - 1} \\\\exp(- x^2 / 2)}
{\\\\Gamma(\\\\nu / 2)}, \\\\quad x \\\\in \\\\Rset^{+*}
with :math:`\\\\nu > 0`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\sqrt{2}\\\\,\\\\frac{\\\\Gamma((\\\\nu + 1) / 2)}
{\\\\Gamma(\\\\nu / 2)} \\\\\\\\
\\\\Var{X} & = & \\\\nu - \\\\mu^2
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Chi(2.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Chi::getNu
"Accessor to the degrees of freedom parameter.
Returns
-------
nu : float
Degrees of freedom."
// ---------------------------------------------------------------------
%feature("docstring") OT::Chi::setNu
"Accessor to the degrees of freedom parameter.
Parameters
----------
nu : float, :math:`\\\\nu > 0`
Degrees of freedom."
|