1%feature("docstring") OT::GumbelCopula
2"Gumbel copula.
3
4Parameters
5----------
6theta : float
7    Parameter :math:`\theta`, :math:`\theta \geq 1`. Default is :math:`\theta=2`.
8
9Notes
10-----
11The Gumbel copula is a bivariate asymmetric Archimedean copula, exhibiting
12greater dependence in the positive tail than in the negative. It is defined by:
13
14.. math::
15
16    C(u_1, u_2) = \exp(-((-log(u_1))^{\theta} + (-log(u_2))^{\theta}))^{1/\theta})
17
18for :math:`(u_1, u_2) \in [0, 1]^2`
19
20And its generator is:
21
22.. math::
23
24    \varphi(t) = (-\log(t))^{\theta}
25
26See also
27--------
28ArchimedeanCopula
29
30Examples
31--------
32Create a distribution:
33
34>>> import openturns as ot
35>>> copula = ot.GumbelCopula(2.5)
36
37Draw a sample:
38
39>>> sample = copula.getSample(5)"
40
41// ---------------------------------------------------------------------
42
43%feature("docstring") OT::GumbelCopula::getTheta
44"Get the parameter :math:`\theta`.
45
46Returns
47-------
48theta : float
49    Parameter :math:`\theta` of the copula."
50
51// ---------------------------------------------------------------------
52
53%feature("docstring") OT::GumbelCopula::setTheta
54"Set the parameter :math:`\theta`.
55
56Parameters
57----------
58theta : float, :math:`\theta \geq 1`
59    Parameter :math:`\theta` of the copula."
60