/usr/include/openturns/swig/FrankCopula_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 | %feature("docstring") OT::FrankCopula
"Frank copula.
Available constructor:
FrankCopula(*theta=2.0*)
Parameters
----------
theta : float
Parameter :math:`\\\\theta`, :math:`\\\\theta \\\\in \\\\Rset`.
Notes
-----
The Frank copula is a bivariate symmetric Archimedean copula defined by:
.. math::
C(u_1, u_2) = -\\\\frac{1}{\\\\theta}
log \\\\left( 1 +
\\\\frac{(e^{-\\\\theta u_1} - 1)(e^{-\\\\theta u_2} - 1)}
{e^{-\\\\theta} - 1}
\\\\right)
for :math:`(u_1, u_2) \\\\in [0, 1]^2`
And its generator is:
.. math::
\\\\varphi(t) = -\\\\log \\\\left( \\\\frac{e^{-\\\\theta t}-1}{e^{-\\\\theta}-1} \\\\right)
See also
--------
ArchimedeanCopula
Examples
--------
Create a distribution:
>>> import openturns as ot
>>> copula = ot.FrankCopula(2.5)
Draw a sample:
>>> sample = copula.getSample(10)"
// ---------------------------------------------------------------------
%feature("docstring") OT::FrankCopula::getTheta
"Get the parameter :math:`\\\\theta`.
Returns
-------
theta : float
Parameter :math:`\\\\theta` of the copula."
// ---------------------------------------------------------------------
%feature("docstring") OT::FrankCopula::setTheta
"Set the parameter :math:`\\\\theta`.
Parameters
----------
theta : float
Parameter :math:`\\\\theta` of the copula."
|