1%feature("docstring") OT::LHSResult
2"Summarize the results of an LHS optimization.
3
4Available constructor:
5    LHSResult(*bounds, spaceFilling, nRestart*)
6
7Parameters
8----------
9spaceFilling : :class:`~openturns.SpaceFilling`
10    The space filling criteria used by optimization algorithm
11nRestart : int
12    The number of restarts performed by optimization algorithm
13
14Notes
15-----
16This class is not intendeted to be built by hand, but returned by optimization algorithms.
17
18Examples
19--------
20>>> import openturns as ot
21>>> lhs = ot.LHSExperiment(ot.ComposedDistribution([ot.Uniform(0.0, 1.0)]*3), 100)
22>>> lhs.setAlwaysShuffle(True) # randomized
23>>> profile = ot.GeometricProfile()
24>>> spaceFilling = ot.SpaceFillingC2()
25>>> # Optim algo
26>>> algo = ot.SimulatedAnnealingLHS(lhs, spaceFilling, profile)
27>>> # first, generate a design
28>>> design = algo.generate()
29>>> # then, get the result
30>>> result = algo.getResult()
31"
32
33// ---------------------------------------------------------------------
34
35%feature("docstring") OT::LHSResult::getOptimalDesign
36"Accessor to the optimal design.
37
38Returns
39-------
40design : :class:`~openturns.Sample`
41    The design that optimizes the criterion.
42"
43
44// ---------------------------------------------------------------------
45
46%feature("docstring") OT::LHSResult::getAlgoHistory
47"Accessor to the internal values computed during optimization algorithm.
48
49Returns
50-------
51history : :class:`~openturns.Point`
52    Some internal values computed during optimization algorithm.
53    SimulatedAnnealingLHS stores criterion value, temperature
54    and probability at each iteration.
55"
56
57// ---------------------------------------------------------------------
58
59%feature("docstring") OT::LHSResult::getC2
60"Accessor to the C2 criterion evaluated on the optimal design.
61
62Returns
63-------
64c2 : float
65    The C2 criterion.
66"
67
68// ---------------------------------------------------------------------
69
70%feature("docstring") OT::LHSResult::getPhiP
71"Accessor the PhiP criterion evaluated on the optimal design.
72
73Returns
74-------
75phiP : float
76    The PhiP criterion.
77"
78
79// ---------------------------------------------------------------------
80
81%feature("docstring") OT::LHSResult::drawHistoryCriterion
82"Draw criterion history.
83
84Parameters
85----------
86restart : int (optional)
87    The restart index.
88title : str (optional)
89    Graph title.
90
91Returns
92-------
93graph : :class:`~openturns.Graph`
94    The resulting graph."
95
96// ---------------------------------------------------------------------
97
98%feature("docstring") OT::LHSResult::drawHistoryProbability
99"Draw probability history.
100
101Parameters
102----------
103restart : int (optional)
104    The restart index.
105title : str (optional)
106    Graph title.
107
108Returns
109-------
110graph : :class:`~openturns.Graph`
111    The resulting graph."
112
113// ---------------------------------------------------------------------
114
115%feature("docstring") OT::LHSResult::drawHistoryTemperature
116"Draw temperature history.
117
118Parameters
119----------
120restart : int (optional)
121    The restart index.
122title : str (optional)
123    Graph title.
124
125Returns
126-------
127graph : :class:`~openturns.Graph`
128    The resulting graph."
129
130// ---------------------------------------------------------------------
131
132%feature("docstring") OT::LHSResult::getMinDist
133"Minimum distance accessor.
134
135Parameters
136----------
137restart : int (optional)
138    The restart index.
139
140Returns
141-------
142minDist : float
143    The minimum distance of sample points."
144
145// ---------------------------------------------------------------------
146
147%feature("docstring") OT::LHSResult::getNumberOfRestarts
148"Restart number accessor.
149
150Returns
151-------
152restart : int (optional)
153    The number of restart."
154
155// ---------------------------------------------------------------------
156
157%feature("docstring") OT::LHSResult::getOptimalValue
158"Optimal value accessor.
159
160Returns
161-------
162value : float (optional)
163    The optimal value."
164