/usr/include/openturns/swig/Exponential_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 | %feature("docstring") OT::Exponential
"Exponential distribution.
Available constructors:
Exponential(*lambda=1.0, gamma=0.*)
Parameters
----------
lambda : float, :math:`\\\\lambda > 0`
Failure rate parameter.
gamma : float, optional
Shift parameter :math:`\\\\gamma`.
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\lambda \\\\exp\\\\left(- \\\\lambda\\\\,(x - \\\\gamma)\\\\right),
\\\\quad x \\\\in [\\\\gamma; +\\\\infty[
with :math:`\\\\lambda > 0` and :math:`\\\\gamma \\\\in \\\\Rset`.
Its first moments are:
.. math::
:nowrap:
\\\\begin{eqnarray*}
\\\\Expect{X} & = & \\\\gamma + \\\\frac{1}{\\\\lambda} \\\\\\\\
\\\\Var{X} & = & \\\\frac{1}{\\\\lambda^2}
\\\\end{eqnarray*}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Exponential(1.)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Exponential::getLambda
"Accessor to the failure rate parameter.
Returns
-------
lambda : float
Failure rate parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Exponential::getGamma
"Accessor to the shift parameter.
Returns
-------
gamma : float
Shift parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Exponential::setLambda
"Accessor to the failure rate parameter.
Parameters
----------
lambda : float, :math:`\\\\lambda > 0`
Failure rate parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Exponential::setGamma
"Accessor to the shift parameter.
Parameters
----------
gamma : float, :math:`\\\\gamma \\\\in \\\\Rset`
Shift parameter."
|