/usr/include/openturns/swig/Binomial_doc.i is in libopenturns-dev 1.9-5.
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 | %feature("docstring") OT::Binomial
"Binomial distribution.
Available constructors:
Binomial(*n=1, p=0.5*)
Parameters
----------
n : int, :math:`n \\\\in \\\\Nset`
The number of Bernoulli trials.
p : float, :math:`0 \\\\leq p \\\\leq 1`
The success probability of the Bernoulli trial.
Notes
-----
Its probability density function is defined as:
.. math::
\\\\Prob{X = k} = C_n^k p^k (1-p)^{n-k},
\\\\quad \\\\forall k \\\\in \\\\{0, \\\\ldots, n\\\\}
with :math:`n \\\\in \\\\Nset` and :math:`0 \\\\leq p \\\\leq 1`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & n\\\\,p \\\\\\\\
\\\\Var{X} & = & n\\\\,p\\\\,(1-p)
\\\\end{eqnarray*}
See Also
--------
Bernoulli
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Binomial(10, 0.5)
Draw a sample:
>>> sample = distribution.getSample(5)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Binomial::getP
"Accessor to the success probability parameter.
Returns
-------
p : float
The success probability of the Bernoulli trial."
// ---------------------------------------------------------------------
%feature("docstring") OT::Binomial::getN
"Accessor to the number of trials.
Returns
-------
n : int
The number of Bernoulli trials."
// ---------------------------------------------------------------------
%feature("docstring") OT::Binomial::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::Binomial::setN
"Accessor to the number of trials.
Parameters
----------
n : int, :math:`n \\\\in \\\\Nset`
The number of Bernoulli trials."
|