Salome HOME
Documentation update with features and review corrections
[modules/adao.git] / doc / en / ref_algorithm_DerivativeFreeOptimization.rst
1 ..
2    Copyright (C) 2008-2024 EDF R&D
3
4    This file is part of SALOME ADAO module.
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    This library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19
20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21
22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
23
24 .. index:: single: DerivativeFreeOptimization
25 .. _section_ref_algorithm_DerivativeFreeOptimization:
26
27 Calculation algorithm "*DerivativeFreeOptimization*"
28 ----------------------------------------------------
29
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
32
33 This algorithm realizes an estimation of the state of a system by minimization
34 without gradient of a cost function :math:`J`, using a search method by simplex
35 type or similar approximation. It is a method that does not use the derivatives
36 of the cost function. It falls in the same category than the
37 :ref:`section_ref_algorithm_DifferentialEvolution`,
38 :ref:`section_ref_algorithm_ParticleSwarmOptimization` or
39 :ref:`section_ref_algorithm_TabuSearch`.
40
41 This is a mono-objective optimization method allowing for global minimum search
42 of a general error function :math:`J` of type :math:`L^1`, :math:`L^2` or
43 :math:`L^{\infty}`, with or without weights. The default error function is the
44 augmented weighted least squares function, classically used in data
45 assimilation.
46
47 .. ------------------------------------ ..
48 .. include:: snippets/Header2Algo12.rst
49
50 .. include:: snippets/FeaturePropNonLocalOptimization.rst
51
52 .. include:: snippets/FeaturePropDerivativeFree.rst
53
54 .. include:: snippets/FeaturePropParallelFree.rst
55
56 .. ------------------------------------ ..
57 .. include:: snippets/Header2Algo02.rst
58
59 .. include:: snippets/Background.rst
60
61 .. include:: snippets/BackgroundError.rst
62
63 .. include:: snippets/Observation.rst
64
65 .. include:: snippets/ObservationError.rst
66
67 .. include:: snippets/ObservationOperator.rst
68
69 .. ------------------------------------ ..
70 .. include:: snippets/Header2Algo03AdOp.rst
71
72 .. include:: snippets/Minimizer_DFO.rst
73
74 .. include:: snippets/BoundsWithNone.rst
75
76 .. include:: snippets/MaximumNumberOfIterations.rst
77
78 .. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
79
80 .. include:: snippets/StateVariationTolerance.rst
81
82 .. include:: snippets/CostDecrementTolerance.rst
83
84 .. include:: snippets/QualityCriterion.rst
85
86 StoreSupplementaryCalculations
87   .. index:: single: StoreSupplementaryCalculations
88
89   *List of names*. This list indicates the names of the supplementary
90   variables, that can be available during or at the end of the algorithm, if
91   they are initially required by the user. Their availability involves,
92   potentially, costly calculations or memory consumptions. The default is then
93   a void list, none of these variables being calculated and stored by default
94   (excepted the unconditional variables). The possible names are in the
95   following list (the detailed description of each named variable is given in
96   the following part of this specific algorithmic documentation, in the
97   sub-section "*Information and variables available at the end of the
98   algorithm*"): [
99   "Analysis",
100   "BMA",
101   "CostFunctionJ",
102   "CostFunctionJb",
103   "CostFunctionJo",
104   "CostFunctionJAtCurrentOptimum",
105   "CostFunctionJbAtCurrentOptimum",
106   "CostFunctionJoAtCurrentOptimum",
107   "CurrentIterationNumber",
108   "CurrentOptimum",
109   "CurrentState",
110   "IndexOfOptimum",
111   "Innovation",
112   "InnovationAtCurrentState",
113   "OMA",
114   "OMB",
115   "SimulatedObservationAtBackground",
116   "SimulatedObservationAtCurrentOptimum",
117   "SimulatedObservationAtCurrentState",
118   "SimulatedObservationAtOptimum",
119   ].
120
121   Example :
122   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
123
124 .. ------------------------------------ ..
125 .. include:: snippets/Header2Algo04.rst
126
127 .. include:: snippets/Analysis.rst
128
129 .. include:: snippets/CostFunctionJ.rst
130
131 .. include:: snippets/CostFunctionJb.rst
132
133 .. include:: snippets/CostFunctionJo.rst
134
135 .. include:: snippets/CurrentState.rst
136
137 .. ------------------------------------ ..
138 .. include:: snippets/Header2Algo05.rst
139
140 .. include:: snippets/Analysis.rst
141
142 .. include:: snippets/BMA.rst
143
144 .. include:: snippets/CostFunctionJ.rst
145
146 .. include:: snippets/CostFunctionJb.rst
147
148 .. include:: snippets/CostFunctionJo.rst
149
150 .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
151
152 .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
153
154 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
155
156 .. include:: snippets/CurrentIterationNumber.rst
157
158 .. include:: snippets/CurrentOptimum.rst
159
160 .. include:: snippets/CurrentState.rst
161
162 .. include:: snippets/IndexOfOptimum.rst
163
164 .. include:: snippets/Innovation.rst
165
166 .. include:: snippets/InnovationAtCurrentState.rst
167
168 .. include:: snippets/OMA.rst
169
170 .. include:: snippets/OMB.rst
171
172 .. include:: snippets/SimulatedObservationAtBackground.rst
173
174 .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
175
176 .. include:: snippets/SimulatedObservationAtCurrentState.rst
177
178 .. include:: snippets/SimulatedObservationAtOptimum.rst
179
180 .. ------------------------------------ ..
181 .. _section_ref_algorithm_DerivativeFreeOptimization_examples:
182
183 .. include:: snippets/Header2Algo09.rst
184
185 .. include:: scripts/simple_DerivativeFreeOptimization.rst
186
187 .. literalinclude:: scripts/simple_DerivativeFreeOptimization.py
188
189 .. include:: snippets/Header2Algo10.rst
190
191 .. literalinclude:: scripts/simple_DerivativeFreeOptimization.res
192     :language: none
193
194 .. include:: snippets/Header2Algo11.rst
195
196 .. _simple_DerivativeFreeOptimization:
197 .. image:: scripts/simple_DerivativeFreeOptimization.png
198   :align: center
199   :width: 90%
200
201 .. ------------------------------------ ..
202 .. include:: snippets/Header2Algo06.rst
203
204 - :ref:`section_ref_algorithm_ParticleSwarmOptimization`
205 - :ref:`section_ref_algorithm_DifferentialEvolution`
206 - :ref:`section_ref_algorithm_TabuSearch`
207
208 .. ------------------------------------ ..
209 .. include:: snippets/Header2Algo07.rst
210
211 - [Johnson08]_
212 - [Nelder65]_
213 - [Powell64]_
214 - [Powell94]_
215 - [Powell98]_
216 - [Powell04]_
217 - [Powell07]_
218 - [Powell09]_
219 - [Rowan90]_
220 - [WikipediaNM]_