1%define OT_OptimalLHS_doc
2"OptimalLHS base class.
3
4See also
5--------
6MonteCarloLHS, SimulatedAnnealingLHS
7
8Notes
9-----
10Perform the generation of optimal LHS designs.
11
12See a complementary bibiliographic reference: [mckay1979]_"
13
14%enddef
15%feature("docstring") OT::OptimalLHSExperiment
16OT_OptimalLHS_doc
17
18// ---------------------------------------------------------------------
19%define OT_OptimalLHS_generate_doc
20"Generate an optimal design.
21
22Returns
23-------
24value : :class:`~openturns.Sample`
25    The optimal design"
26%enddef
27%feature("docstring") OT::OptimalLHSExperiment::generate
28OT_OptimalLHS_generate_doc
29
30// ---------------------------------------------------------------------
31%define OT_OptimalLHS_getResult_doc
32"Result accessor.
33
34Returns
35-------
36value : :class:`~openturns.LHSResult`
37    Result of generation that contains the optimal design, some criteria and history"
38%enddef
39%feature("docstring") OT::OptimalLHSExperiment::getResult
40OT_OptimalLHS_getResult_doc
41
42// ---------------------------------------------------------------------
43%define OT_OptimalLHS_getlhs_doc
44"Return the LHS design.
45
46Returns
47-------
48value : :class:`~openturns.LHSExperiment`
49    Result the factory that builds initial design to be optimized"
50%enddef
51%feature("docstring") OT::OptimalLHSExperiment::getLHS
52OT_OptimalLHS_getlhs_doc
53
54// ---------------------------------------------------------------------
55%define OT_OptimalLHS_get_space_filling_doc
56"Return the space-filling criterion to be optimized.
57
58Returns
59-------
60value : :class:`~openturns.SpaceFilling`
61    Criterion function to be optimized"
62%enddef
63%feature("docstring") OT::OptimalLHSExperiment::getSpaceFilling
64OT_OptimalLHS_get_space_filling_doc
65
66// ---------------------------------------------------------------------
67