/usr/include/openturns/swig/LHSExperiment_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 66 67 68 69 70 71 72 73 74 | %feature("docstring") OT::LHSExperiment
"LHS experiment.
Available constructors:
LHSExperiment(*distribution, size*)
LHSExperiment(*size*)
Parameters
----------
distribution : :class:`~openturns.Distribution`
Distribution :math:`\\\\mu` with an independent copula used to generate the
set of input data.
size : positive int
Number :math:`cardI` of points that will be generated in the experiment.
Notes
-----
LHSExperiment is a random weighted design of experiments.
The method generates a sample of points :math:`\\\\Xi_i` according to the
distribution :math:`\\\\mu` with the LHS technique: some cells are determined,
with the same probabilistic content according to the distribution, each line
and each column contains exactly one cell, then points are selected among these
selected cells. The weights associated to the points are all equal to
:math:`1/cardI`. When recalled, the :meth:`generate` method generates a new
sample: the point selection within the cells changes but not the cells
selection. To change the cell selection, it is necessary to create a new LHS
Experiment.
See also
--------
WeightedExperiment
Examples
--------
Create an *LHSExperiment*:
>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> experiment = ot.LHSExperiment(ot.Normal(2), 5)
>>> print(experiment.generate())
[ marginal 1 marginal 2 ]
0 : [ 0.887671 -0.647818 ]
1 : [ 0.107683 1.15851 ]
2 : [ 0.453077 -1.04742 ]
3 : [ -0.928012 0.409732 ]
4 : [ -0.290539 0.16153 ]"
// ---------------------------------------------------------------------
%feature("docstring") OT::LHSExperiment::getShuffle
"Return the cell randomization.
Returns
-------
shuffle : :class:`~openturns.Matrix`
For each point, the indices of the shuffled components."
// ---------------------------------------------------------------------
%feature("docstring") OT::LHSExperiment::ComputeShuffle
"Generate a new cell randomization for external use.
Parameters
----------
dimension : positive int
Number of input dimension.
totalSize : positive int
Number :math:`cardI` of points that need to be shuffled.
Returns
-------
shuffle : :class:`~openturns.Matrix`
For each point, the indices of the shuffled components."
|