/usr/include/openturns/swig/Frechet_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 100 101 | %feature("docstring") OT::Frechet
"Frechet distribution.
Available constructors:
Frechet(*alpha=1.0, beta=1.0, gamma=0.0*)
Parameters
----------
alpha : float, :math:`\\\\alpha > 0`
Shape parameter
beta : float, :math:`\\\\beta > 0`
Concentration parameter
gamma : float
Location parameter
Notes
-----
Its probability density function is defined as:
.. math::
f_X(x) = \\\\frac{\\\\alpha}{\\\\beta}(\\\\frac{x-\\\\gamma}{\\\\beta})^{-1-\\\\alpha}e^{-\\\\left(\\\\frac{x-\\\\gamma}{\\\\beta}\\\\right)^{-\\\\alpha}}
with :math:`\\\\alpha > 0` and :math:`\\\\beta > 0`.
Its cumulative density function is defined as:
.. math::
F_X(x) = e^{-\\\\left(\\\\frac{x-\\\\gamma}{\\\\beta}\\\\right)^{-\\\\alpha}}
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> distribution = ot.Frechet(3.0, 1.0, 0.0)
Draw a sample:
>>> sample = distribution.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::Frechet::getAlpha
"Accessor to the shape parameter.
Returns
-------
alpha : float
Shape parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Frechet::setAlpha
"Accessor to the shape parameter.
Parameters
----------
alpha : float, :math:`\\\\alpha > 0`
Shape parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Frechet::getBeta
"Accessor to the scale parameter.
Returns
-------
beta : float
Scale parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Frechet::setBeta
"Accessor to the scale parameter.
Parameters
----------
beta : float, :math:`\\\\beta > 0`
Scale parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Frechet::getGamma
"Accessor to the location parameter.
Returns
-------
gamma : float
Location parameter."
// ---------------------------------------------------------------------
%feature("docstring") OT::Frechet::setGamma
"Accessor to the location parameter.
Parameters
----------
gamma : float, :math:`\\\\gamma > 0`
Location parameter."
|