/usr/include/openturns/swig/VonMises_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 | %feature("docstring") OT::VonMises
"von Mises distribution.
Available constructors:
VonMises(*mu=0.0, kappa=1.0*)
Parameters
----------
mu : float
Location parameter
kappa : float, :math:`\\\\kappa > 0`
Concentration parameter
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{e^{\\\\kappa\\\\cos(x-\\\\mu)}}
{2\\\\pi I_0(\\\\kappa)}, \\\\quad x \\\\in [-\\\\pi, \\\\pi]
with :math:`\\\\kappa > 0` and :math:`I_0` the modified Bessel function of order 0.
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.VonMises(1.0, 2.0)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::VonMises::getMu
"Accessor to the location parameter.
Returns
-------
mu : float
Location parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::VonMises::setMu
"Accessor to the location parameter.
Parameters
----------
mu : float
Location parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::VonMises::getKappa
"Accessor to the concentration parameter.
Returns
-------
kappa : float
Concentration parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::VonMises::setKappa
"Accessor to the concentration parameter.
Parameters
----------
kappa : float, :math:`\\\\kappa > 0`
Concentration parameter."
|