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