/usr/include/openturns/swig/ComposedDistribution_doc.i is in libopenturns-dev 1.9-5.
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 | %feature("docstring") OT::ComposedDistribution
"Composed distribution.
Available constructors:
ComposedDistribution(*distributions, copula=ot.IndependentCopula(n)*)
Parameters
----------
distributions : list of :class:`~openturns.Distribution`
List of :math:`n` marginals of the distribution. Each marginal must be of
dimension 1.
copula : :class:`~openturns.Distribution`
A copula. If not mentioned, the copula is set to an
:class:`~openturns.IndependentCopula` with the same dimension as
*distributions*.
Notes
-----
A ComposedDistribution is a :math:`n`-dimensional distribution which can be
written in terms of 1-d marginal distribution functions and a copula :math:`C`
which describes the dependence structure between the variables.
Its cumulative distribution function :math:`F` is defined by its marginal
distributions :math:`F_i` and the copula :math:`C` through the relation:
.. math::
F(x_1, \\\\cdots, x_n) = C(F_1(x_1), \\\\cdots, F_n(x_n))
See also
--------
Copula, SklarCopula
Examples
--------
>>> import openturns as ot
>>> correlation = ot.CorrelationMatrix(2)
>>> correlation[1, 0] = 0.25
>>> aCopula = ot.NormalCopula(correlation)
>>> marginals = [ot.Normal(1.0, 2.0), ot.Normal(2.0, 3.0)]
>>> distribution = ot.ComposedDistribution(marginals, aCopula)
Draw a sample:
>>> sample = distribution.getSample(5)"
// ---------------------------------------------------------------------
%feature("docstring") OT::ComposedDistribution::getDistributionCollection
"Get the marginals of the distribution.
Returns
-------
distributions : list of :class:`~openturns.Distribution`
List of the marginals of the distribution."
// ---------------------------------------------------------------------
%feature("docstring") OT::ComposedDistribution::setDistributionCollection
"Set the marginals of the distribution.
Parameters
----------
distributions : list of :class:`~openturns.Distribution`
List of the marginals of the distribution."
// ---------------------------------------------------------------------
%feature("docstring") OT::ComposedDistribution::setCopula
"Set the copula of the distribution.
Parameters
----------
copula : :class:`~openturns.Distribution`
Copula of the distribution."
|