/usr/include/openturns/swig/GumbelCopula_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 | %feature("docstring") OT::GumbelCopula
"Gumbel copula.
Available constructor:
GumbelCopula(*theta=2.0*)
Parameters
----------
theta : float, :math:`\\\\theta \\\\geq 1`
Parameter :math:`\\\\theta`.
Notes
-----
The Gumbel copula is a bivariate asymmetric Archimedean copula, exhibiting
greater dependence in the positive tail than in the negative. It is defined by:
.. math::
C(u_1, u_2) = \\\\exp(-((-log(u_1))^{\\\\theta} + (-log(u_2))^{\\\\theta}))^{1/\\\\theta})
for :math:`(u_1, u_2) \\\\in [0, 1]^2`
And its generator is:
.. math::
\\\\varphi(t) = (-\\\\log(t))^{\\\\theta}
See also
--------
ArchimedeanCopula
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> copula = ot.GumbelCopula(2.5)
Draw a sample:
>>> sample = copula.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::GumbelCopula::getTheta
"Get the parameter :math:`\\\\theta`.
Returns
-------
theta : float
Parameter :math:`\\\\theta` of the copula."
// ---------------------------------------------------------------------
%feature("docstring") OT::GumbelCopula::setTheta
"Set the parameter :math:`\\\\theta`.
Parameters
----------
theta : float, :math:`\\\\theta \\\\geq 1`
Parameter :math:`\\\\theta` of the copula."
|