/usr/include/openturns/swig/LHSExperiment_doc.i is in libopenturns-dev 1.5-7build2.
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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | %feature("docstring") OT::LHSExperiment
"LHS experiment.
Available constructors:
LHSExperiment(*size*)
LHSExperiment(*distribution, 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
-----
The method generate generates a NumericalSample of points :math:`\\\\Xi_i`
which points are generated according to :math:`\\\\mu` with the LHS technique:
some cells are determined, with the same probabilistic content according to distribution,
each line and each column contains exactly one cell,
then points are selected among these selected cells.
When the method generate is recalled, the NumericalSample generated changes:
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.
Examples
--------
Create an *LHSExperiment*:
>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> experiment = ot.LHSExperiment(ot.Normal(2), 5)
>>> sample = experiment.generate()
>>> print(sample)
[ marginal 1 marginal 2 ]
0 : [ 0.280461 0.0925621 ]
1 : [ 1.10798 -0.74677 ]
2 : [ -0.804439 -1.26184 ]
3 : [ -1.69566 2.53286 ]
4 : [ 0.520312 -0.604502 ]"
// ---------------------------------------------------------------------
%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"
%feature("docstring") OT::LHSExperiment
"LHS experiment.
Available constructors:
LHSExperiment(*size*)
LHSExperiment(*distribution, 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
-----
The method generate generates a NumericalSample of points :math:`\\\\Xi_i`
which points are generated according to :math:`\\\\mu` with the LHS technique:
some cells are determined, with the same probabilistic content according to distribution,
each line and each column contains exactly one cell,
then points are selected among these selected cells.
When the method generate is recalled, the NumericalSample generated changes:
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.
Examples
--------
Create an *LHSExperiment*:
>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> experiment = ot.LHSExperiment(ot.Normal(2), 5)
>>> sample = experiment.generate()
>>> print(sample)
[ marginal 1 marginal 2 ]
0 : [ 0.280461 0.0925621 ]
1 : [ 1.10798 -0.74677 ]
2 : [ -0.804439 -1.26184 ]
3 : [ -1.69566 2.53286 ]
4 : [ 0.520312 -0.604502 ]"
// ---------------------------------------------------------------------
%feature("docstring") OT::LHSExperiment::getShuffle
"Return the cell randomization.
Returns
-------
shuffle : :class:`~openturns.Matrix
For each point, the indices of the shuffled cells"
// ---------------------------------------------------------------------
%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 cells"
|