/usr/include/openturns/swig/Laplace_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 | %feature("docstring") OT::Laplace
"Laplace distribution.
Available constructors:
Laplace(*lambda=1.0, mu=0.*)
Parameters
----------
lambda : float, :math:`\\\\lambda > 0`
Scale parameter :math:`\\\\lambda`.
mu : float
Location parameter :math:`\\\\mu`.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{\\\\lambda}{2}
\\\\exp\\\\left(- \\\\lambda |x - \\\\mu|\\\\right),
\\\\quad x \\\\in \\\\Rset
with :math:`\\\\lambda > 0` and :math:`\\\\mu \\\\in \\\\Rset`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\mu \\\\\\\\
\\\\Var{X} & = & \\\\frac{2}{\\\\lambda^2}
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Laplace(1., 0.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Laplace::getLambda
"Accessor to the distribution's scale parameter :math:`\\\\lambda`.
Returns
-------
lambda : float
Scale parameter :math:`\\\\lambda`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Laplace::getMu
"Accessor to the distribution's location parameter :math:`\\\\mu`.
Returns
-------
mu : float
Location parameter :math:`\\\\mu`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Laplace::setLambda
"Accessor to the distribution's scale parameter :math:`\\\\lambda`.
Parameters
----------
lambda : float, :math:`\\\\lambda > 0`
Scale parameter :math:`\\\\lambda`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Laplace::setMu
"Accessor to the distribution's location parameter :math:`\\\\mu`.
Parameters
----------
mu : float, :math:`\\\\mu \\\\in \\\\Rset`
Location parameter :math:`\\\\mu`."
|