/usr/include/openturns/swig/KPermutationsDistribution_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::KPermutationsDistribution
"KPermutations distribution.
Available constructors:
KPermutationsDistribution(*k=1, n=1*)
Parameters
----------
k : int, :math:`k > 0`
n : int, :math:`n > 0`
Notes
-----
:class:`~openturns.KPermutationsDistribution` is the discrete uniform
distribution on the set of injective functions :math:`(i_0, \\\\hdots, i_{k_1})`
from :math:`\\\\{0, \\\\hdots, k-1\\\\}` into :math:`\\\\{0, \\\\hdots, n-1\\\\}`.
Its probability density function is defined as:
.. math::
\\\\Prob{\\\\vect{X} = (i_0, \\\\hdots, i_{k-1})} = \\\\frac{(n-k)!}{n!}
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{\\\\vect{X}} & = & \\\\frac{n - 1}{2}\\\\\\\\
\\\\Cov{\\\\vect{X}} & = & \\\\left\\\\{
\\\\begin{array}{ll}
\\\\displaystyle \\\\frac{n^2-1}{12} \\\\\\\\
\\\\displaystyle -\\\\frac{1 + n}{12}
\\\\end{array}
\\\\right.
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.KPermutationsDistribution(6, 8)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::KPermutationsDistribution::getN
"Accessor to the parameter :math:`n`.
Returns
-------
n : int"
// ---------------------------------------------------------------------
%feature("docstring") OT::KPermutationsDistribution::getK
"Accessor to the parameter :math:`k`.
Returns
-------
k : int"
// ---------------------------------------------------------------------
%feature("docstring") OT::KPermutationsDistribution::setN
"Accessor to the parameter :math:`n`.
Parameters
----------
n : int, :math:`n > 0`"
// ---------------------------------------------------------------------
%feature("docstring") OT::KPermutationsDistribution::setK
"Accessor to the parameter :math:`k`.
Parameters
----------
k : int, :math:`k > 0`"
|