/usr/include/openturns/swig/NegativeBinomial_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::NegativeBinomial
"NegativeBinomial distribution.
Available constructors:
NegativeBinomial(*r=1.0, p=0.5*)
Parameters
----------
r : float, :math:`r > 0`
Number of failures until the Bernoulli trial is stopped.
p : float, :math:`0 < p < 1`
Success probability of the Bernoulli trial.
Notes
-----
Its probability density function is defined as:
.. math::
\\\\Prob{X = k} = \\\\frac{\\\\Gamma(k + r)}{\\\\Gamma(r)\\\\Gamma(k+1)}p^k(1-p)^r,
\\\\, \\\\forall k \\\\in \\\\Nset
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\frac{rp}{1-p} \\\\\\\\
\\\\Var{X} & = & \\\\frac{rp}{(1-p)^2}
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.NegativeBinomial(1., 0.6)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::NegativeBinomial::getP
"Accessor to the success probability parameter.
Returns
-------
p : float
The success probability of the Bernoulli trial."
// ---------------------------------------------------------------------
%feature("docstring") OT::NegativeBinomial::getR
"Accessor to the number of failures parameter.
Returns
-------
r : float
Number of failures until the Bernoulli trial is stopped."
// ---------------------------------------------------------------------
%feature("docstring") OT::NegativeBinomial::setP
"Accessor to the success probability parameter.
Parameters
----------
p : float, :math:`0 \\\\leq p \\\\leq 1`
The success probability of the Bernoulli trial."
// ---------------------------------------------------------------------
%feature("docstring") OT::NegativeBinomial::setR
"Accessor to the number of failures parameter.
Parameters
----------
r : float, :math:`r > 0`
Number of failures until the Bernoulli trial is stopped."
|