/usr/include/openturns/swig/LowDiscrepancyExperiment_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 | %feature("docstring") OT::LowDiscrepancyExperiment
"LowDiscrepancy experiment.
Available constructors:
LowDiscrepancyExperiment(*size*)
LowDiscrepancyExperiment(*sequence, size*)
LowDiscrepancyExperiment(*sequence, distribution, size*)
Parameters
----------
size : positive int
Number :math:`N` of points of the sequence.
sequence : :class:`~openturns.LowDiscrepancySequence`
Sequence of points :math:`(u_1, \\\\cdots, u_N)` with low discrepancy.
If not specified, the sequence is a :class:`~openturns.SobolSequence`.
distribution :
Distribution :math:`\\\\mu` of dimension :math:`n` with an independent copula.
The low discrepancy sequence :math:`(u_1, \\\\cdots, u_N)` is uniformly
distributed over :math:`[0,1]^n`. We use the marginal transformation
:math:`\\\\Xi_i =F_i^{-1}(u_i)` to generate points :math:`(\\\\Xi_i)_{i\\\\in I}`
according to the distribution :math:`\\\\mu`. The weights are all equal to
:math:`1/N`.
Notes
-----
The :meth:`generate` method generates points :math:`(\\\\Xi_i)_{i \\\\in I}`
independently from the distribution :math:`\\\\mu`. When the :meth:`generate`
method is recalled, the generated sample changes.
See also
--------
WeightedExperiment
Examples
--------
>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> distribution = ot.ComposedDistribution([ot.Uniform(0, 1)] * 2)
>>> myPlane = ot.LowDiscrepancyExperiment(ot.SobolSequence(), distribution, 5)
>>> print(myPlane.generate())
[ marginal_1_marginal 1 marginal_2_marginal 1 ]
0 : [ 0.5 0.5 ]
1 : [ 0.75 0.25 ]
2 : [ 0.25 0.75 ]
3 : [ 0.375 0.375 ]
4 : [ 0.875 0.875 ]"
// ---------------------------------------------------------------------
%feature("docstring") OT::LowDiscrepancyExperiment::getSequence
"Return the sequence.
Returns
-------
sequence : :class:`~openturns.LowDiscrepancySequence`
Sequence of points :math:`(u_1, \\\\cdots, u_N)` with low discrepancy."
|