/usr/include/openturns/swig/ZipfMandelbrot_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::ZipfMandelbrot
"ZipfMandelbrot distribution.
Available constructors:
ZipfMandelbrot(*N=1.0, q=0., s=1.0*)
Parameters
----------
N : int, :math:`N > 0`
q : float, :math:`q \\\\geq 0`
s : float, :math:`s > 0`
Notes
-----
Its probability density function is defined as:
.. math::
\\\\Prob{X = k} = \\\\frac{1}{(k+q)^s H(N,q,s)},
\\\\quad \\\\forall k \\\\in [1, N]
where :math:`H(N,q,s)` is the Generalized Harmonic Number:
:math:`H(N,q,s) = \\\\sum_{i=1}^{N} \\\\frac{1}{(i+q)^s}`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\frac{H_{N,q,s-1}}{H_{N,q,s}}-q \\\\\\\\
\\\\Var{X} & = & \\\\frac{\\\\displaystyle \\\\sum_{i=1}^N
\\\\frac{(i - \\\\Expect{X})^2}{(i+q)^s}}{H_{N,q,s}}
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.ZipfMandelbrot(15, 1.2, 2.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::ZipfMandelbrot::getN
"Accessor to the parameter :math:`N`.
Returns
-------
N : int"
// ---------------------------------------------------------------------
%feature("docstring") OT::ZipfMandelbrot::getQ
"Accessor to the parameter :math:`q`.
Returns
-------
q : float"
// ---------------------------------------------------------------------
%feature("docstring") OT::ZipfMandelbrot::getS
"Accessor to the parameter :math:`s`.
Returns
-------
s : float"
// ---------------------------------------------------------------------
%feature("docstring") OT::ZipfMandelbrot::setN
"Accessor to the parameter :math:`N`.
Parameters
----------
N : int, :math:`N > 0`"
// ---------------------------------------------------------------------
%feature("docstring") OT::ZipfMandelbrot::setQ
"Accessor to the parameter :math:`q`.
Parameters
----------
q : float, :math:`q >= 0`"
// ---------------------------------------------------------------------
%feature("docstring") OT::ZipfMandelbrot::setS
"Accessor to the parameter :math:`s`.
Parameters
----------
s : float, :math:`s > 0`"
|