From: Jean-Philippe ARGAUD Date: Wed, 24 Apr 2024 09:50:34 +0000 (+0200) Subject: Documentation update with features and review corrections X-Git-Tag: V9_13_0a1~14 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=88cf026f2f6a6a0b8cfd374595dc768bc780b54d;p=modules%2Fadao.git Documentation update with features and review corrections --- diff --git a/doc/en/ref_algorithm_4DVAR.rst b/doc/en/ref_algorithm_4DVAR.rst index 7f99292..2b1f119 100644 --- a/doc/en/ref_algorithm_4DVAR.rst +++ b/doc/en/ref_algorithm_4DVAR.rst @@ -46,6 +46,15 @@ similar to the one of Kalman filters, specially the :ref:`section_ref_algorithm_ExtendedKalmanFilter` or the :ref:`section_ref_algorithm_UnscentedKalmanFilter`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_AdjointTest.rst b/doc/en/ref_algorithm_AdjointTest.rst index 4a930af..ab2a069 100644 --- a/doc/en/ref_algorithm_AdjointTest.rst +++ b/doc/en/ref_algorithm_AdjointTest.rst @@ -54,6 +54,13 @@ in which the optional quantity :math:`\mathbf{y}` must be in the image of This residue must remain constantly equal to zero at the accuracy of the calculation. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst index beb27b9..dbc1062 100644 --- a/doc/en/ref_algorithm_Blue.rst +++ b/doc/en/ref_algorithm_Blue.rst @@ -67,6 +67,15 @@ these disadvantages is to adapt very precisely the elements of the method to each physical model, making the method not robust. For these reasons, this method is not proposed nor recommended. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ControledFunctionTest.rst b/doc/en/ref_algorithm_ControledFunctionTest.rst index abb1ae2..ebf5df4 100644 --- a/doc/en/ref_algorithm_ControledFunctionTest.rst +++ b/doc/en/ref_algorithm_ControledFunctionTest.rst @@ -51,6 +51,13 @@ facilitate automatic tests of operator. It may also be useful to check the entries themselves beforehand with the intended test :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst index e8af797..6d80050 100644 --- a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst @@ -44,6 +44,15 @@ of a general error function :math:`J` of type :math:`L^1`, :math:`L^2` or augmented weighted least squares function, classically used in data assimilation. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_DifferentialEvolution.rst b/doc/en/ref_algorithm_DifferentialEvolution.rst index 6bb41b9..b0d185f 100644 --- a/doc/en/ref_algorithm_DifferentialEvolution.rst +++ b/doc/en/ref_algorithm_DifferentialEvolution.rst @@ -43,6 +43,13 @@ error function :math:`J` of type :math:`L^1`, :math:`L^2` or :math:`L^{\infty}`, with or without weights. The default error function is the augmented weighted least squares function, classically used in data assimilation. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_EnsembleBlue.rst b/doc/en/ref_algorithm_EnsembleBlue.rst index 4a15ff0..d1bbb88 100644 --- a/doc/en/ref_algorithm_EnsembleBlue.rst +++ b/doc/en/ref_algorithm_EnsembleBlue.rst @@ -40,6 +40,15 @@ but has to work also in "slightly" non-linear cases. One can verify the linearity of the observation operator with the help of the :ref:`section_ref_algorithm_LinearityTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst index 65c78f7..0421aee 100644 --- a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst @@ -90,6 +90,15 @@ formulation as a reference algorithm, **"ETKF-N" ou "IEnKF" formulation for robust performance**, and the other algorithms (in this order) as means to obtain a less costly data assimilation with (hopefully) the same quality. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst b/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst index 302e86e..418d1a2 100644 --- a/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst +++ b/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst @@ -67,6 +67,13 @@ error, an :ref:`section_ref_algorithm_SamplingTest` uses the same sampling commands to establish a set of error functional values :math:`J` from observations :math:`\mathbf{y}^o`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst index 008d030..b5c51bb 100644 --- a/doc/en/ref_algorithm_ExtendedBlue.rst +++ b/doc/en/ref_algorithm_ExtendedBlue.rst @@ -52,6 +52,15 @@ knowing that the state error covariance remains the background covariance initially provided by the user. To be explicit, unlike Kalman-type filters, the state error covariance is not updated. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst index 758b473..2a091a6 100644 --- a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst @@ -80,6 +80,15 @@ variant is named "CEKF", it is recommended and is used by default), or conducted without any constraint (the variant is named "EKF", and it is not recommended). +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index 023b791..c7ee526 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -50,6 +50,13 @@ facilitate automatic tests of operator. It may also be useful to check the entries themselves beforehand with the intended test :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_GradientTest.rst b/doc/en/ref_algorithm_GradientTest.rst index 08064fd..f6d44bc 100644 --- a/doc/en/ref_algorithm_GradientTest.rst +++ b/doc/en/ref_algorithm_GradientTest.rst @@ -90,6 +90,13 @@ One observe the residue based on the gradient approximation: which has to remain stable until the calculation precision is reached. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_InputValuesTest.rst b/doc/en/ref_algorithm_InputValuesTest.rst index 5cb3490..9aa36bb 100644 --- a/doc/en/ref_algorithm_InputValuesTest.rst +++ b/doc/en/ref_algorithm_InputValuesTest.rst @@ -36,6 +36,11 @@ size information and statistics on the inputs. It also allows to display the whole content of the variables read in printed form for verification (*warning, if a variable is large in size, this can be difficult*). +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_InterpolationByReducedModelTask.rst b/doc/en/ref_algorithm_InterpolationByReducedModelTask.rst index f7cc27a..661646e 100644 --- a/doc/en/ref_algorithm_InterpolationByReducedModelTask.rst +++ b/doc/en/ref_algorithm_InterpolationByReducedModelTask.rst @@ -67,6 +67,11 @@ analysis. .. centered:: **General scheme for using the algorithm** +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst index c316c44..8ac9ff7 100644 --- a/doc/en/ref_algorithm_KalmanFilter.rst +++ b/doc/en/ref_algorithm_KalmanFilter.rst @@ -77,6 +77,15 @@ preferred a :ref:`section_ref_algorithm_ExtendedKalmanFilter`, or a can verify the linearity of the operators with the help of a :ref:`section_ref_algorithm_LinearityTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst index 02d6d0a..c779acd 100644 --- a/doc/en/ref_algorithm_LinearLeastSquares.rst +++ b/doc/en/ref_algorithm_LinearLeastSquares.rst @@ -52,6 +52,15 @@ In all cases, it is recommended to prefer at least a :ref:`section_ref_algorithm_ExtendedBlue` or a :ref:`section_ref_algorithm_3DVAR`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_LinearityTest.rst b/doc/en/ref_algorithm_LinearityTest.rst index 5cfa3d4..4c5059a 100644 --- a/doc/en/ref_algorithm_LinearityTest.rst +++ b/doc/en/ref_algorithm_LinearityTest.rst @@ -113,6 +113,13 @@ If it is equal to 0 only on part of the variation domain of increment :math:`\alpha`, it is on this sub-domain that the linearity hypothesis of :math:`F` is verified. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_LocalSensitivityTest.rst b/doc/en/ref_algorithm_LocalSensitivityTest.rst index c4f2b27..3f0e9a8 100644 --- a/doc/en/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/en/ref_algorithm_LocalSensitivityTest.rst @@ -40,6 +40,13 @@ operator :math:`\mathcal{H}` with respect to the input variables linearized operator (or the tangent one) :math:`\mathbf{H}` of the :math:`\mathcal{H}` near the chosen checking point. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 181281e..7e260eb 100644 --- a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -98,6 +98,13 @@ It is possible to exclude a priori potential positions for measurement positioning, using the analysis variant "*lcEIM*" or "*lcDEIM*" for a constrained positioning search. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index 8de69f4..6bbf909 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -50,6 +50,15 @@ predicted by the incremental evolution model. In all cases, it is recommended to prefer a :ref:`section_ref_algorithm_3DVAR` for its stability as for its behavior during optimization. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ObservationSimulationComparisonTest.rst b/doc/en/ref_algorithm_ObservationSimulationComparisonTest.rst index 932d3ac..45e23a8 100644 --- a/doc/en/ref_algorithm_ObservationSimulationComparisonTest.rst +++ b/doc/en/ref_algorithm_ObservationSimulationComparisonTest.rst @@ -54,6 +54,11 @@ facilitate automatic tests of operator. It may also be useful to check the entries themselves beforehand with the intended test :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ObserverTest.rst b/doc/en/ref_algorithm_ObserverTest.rst index c6a20bd..8fcdbb1 100644 --- a/doc/en/ref_algorithm_ObserverTest.rst +++ b/doc/en/ref_algorithm_ObserverTest.rst @@ -35,6 +35,11 @@ an *observer*. This external function can be applied to each of the variables that can be potentially observed. It is activated only on those who are explicitly associated with the *observer* in its declaration. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ParallelFunctionTest.rst b/doc/en/ref_algorithm_ParallelFunctionTest.rst index 71a57b5..b6872d1 100644 --- a/doc/en/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/en/ref_algorithm_ParallelFunctionTest.rst @@ -50,6 +50,13 @@ facilitate automatic tests of operator. It may also be useful to check the entries themselves beforehand with the intended test :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst index 40f44f9..3448ba7 100644 --- a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst @@ -128,6 +128,15 @@ numerical approximation complicated or invalid. But it is also necessary that the calculation of the function to be simulated is not too costly to avoid a prohibitive optimization time length. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_QuantileRegression.rst b/doc/en/ref_algorithm_QuantileRegression.rst index 90030eb..257d9c8 100644 --- a/doc/en/ref_algorithm_QuantileRegression.rst +++ b/doc/en/ref_algorithm_QuantileRegression.rst @@ -36,6 +36,13 @@ observed variables. These are then the quantiles on the observed variables which will allow to determine the model parameters that satisfy to the quantiles conditions. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_ReducedModelingTest.rst b/doc/en/ref_algorithm_ReducedModelingTest.rst index 4748fb7..489d193 100644 --- a/doc/en/ref_algorithm_ReducedModelingTest.rst +++ b/doc/en/ref_algorithm_ReducedModelingTest.rst @@ -46,6 +46,11 @@ variance. Once the analysis is complete, a summary is displayed and, on request, a graphical representation of the same information is produced. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_SamplingTest.rst b/doc/en/ref_algorithm_SamplingTest.rst index 5879786..f71f0a7 100644 --- a/doc/en/ref_algorithm_SamplingTest.rst +++ b/doc/en/ref_algorithm_SamplingTest.rst @@ -64,6 +64,13 @@ no results are requested, nothing is available). One use for that, on the desired variable, the final saving through "*UserPostAnalysis*" or the treatment during the calculation by well suited "*observer*". +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_TabuSearch.rst b/doc/en/ref_algorithm_TabuSearch.rst index f09f610..ecc0965 100644 --- a/doc/en/ref_algorithm_TabuSearch.rst +++ b/doc/en/ref_algorithm_TabuSearch.rst @@ -50,6 +50,13 @@ returning to a point already explored, the algorithm's memory mechanism allows to exclude (hence the name *tabu*) the return to the last explored states. Positions already explored are kept in a list of finite length. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_TangentTest.rst b/doc/en/ref_algorithm_TangentTest.rst index 441acdb..c176dd4 100644 --- a/doc/en/ref_algorithm_TangentTest.rst +++ b/doc/en/ref_algorithm_TangentTest.rst @@ -58,6 +58,11 @@ almost linear or quasi-linear (which can be verified by the :ref:`section_ref_algorithm_LinearityTest`), and the tangent is valid until the calculation precision is reached. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst index f954eea..bdbf155 100644 --- a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst @@ -94,6 +94,15 @@ algorithms: therefore be parallelized or distributed if the function to be simulated supports this. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_4DVAR.rst b/doc/fr/ref_algorithm_4DVAR.rst index 8d9f86e..6bd3313 100644 --- a/doc/fr/ref_algorithm_4DVAR.rst +++ b/doc/fr/ref_algorithm_4DVAR.rst @@ -47,6 +47,15 @@ algorithmes de filtrage de Kalman et en particulier l':ref:`section_ref_algorithm_ExtendedKalmanFilter` ou l':ref:`section_ref_algorithm_UnscentedKalmanFilter`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_AdjointTest.rst b/doc/fr/ref_algorithm_AdjointTest.rst index d5c7735..93d0f54 100644 --- a/doc/fr/ref_algorithm_AdjointTest.rst +++ b/doc/fr/ref_algorithm_AdjointTest.rst @@ -52,6 +52,13 @@ de :math:`F`. Si elle n'est pas donnée, on prend son évaluation par défaut Ce résidu doit rester constamment égal à zéro à la précision du calcul. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index 5f3ef28..3fe8c63 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -68,6 +68,15 @@ moyen d'éviter ces désavantages est d'adapter très précisément les élémen la méthode à chaque modèle physique, la rendant non robuste. Pour ces raisons, cette méthode n'est donc pas proposée. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ControledFunctionTest.rst b/doc/fr/ref_algorithm_ControledFunctionTest.rst index 9b57cd2..1fa6a57 100644 --- a/doc/fr/ref_algorithm_ControledFunctionTest.rst +++ b/doc/fr/ref_algorithm_ControledFunctionTest.rst @@ -52,6 +52,13 @@ permettre l'automatisation des tests d'opérateur. Il peut être aussi utile de vérifier préalablement les entrées elles-mêmes avec le test prévu :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst index 0420ed1..9bb5a17 100644 --- a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst @@ -45,6 +45,15 @@ minimum global d'une fonctionnelle d'erreur :math:`J` quelconque de type fonctionnelle d'erreur par défaut est celle de moindres carrés pondérés augmentés, classiquement utilisée en assimilation de données. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_DifferentialEvolution.rst b/doc/fr/ref_algorithm_DifferentialEvolution.rst index f8bc851..43c3a36 100644 --- a/doc/fr/ref_algorithm_DifferentialEvolution.rst +++ b/doc/fr/ref_algorithm_DifferentialEvolution.rst @@ -45,6 +45,13 @@ fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou défaut est celle de moindres carrés pondérés augmentés, classiquement utilisée en assimilation de données. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_EnsembleBlue.rst b/doc/fr/ref_algorithm_EnsembleBlue.rst index 8bbc797..ca4fcaa 100644 --- a/doc/fr/ref_algorithm_EnsembleBlue.rst +++ b/doc/fr/ref_algorithm_EnsembleBlue.rst @@ -40,6 +40,15 @@ doit fonctionner aussi dans les cas "faiblement" non-linéaire. On peut vérifie la linéarité de l'opérateur d'observation à l'aide de l':ref:`section_ref_algorithm_LinearityTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst index cc28ba4..71cdc51 100644 --- a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst @@ -94,6 +94,15 @@ une performance robuste**, et les autres algorithmes (dans l'ordre) comme des moyens pour obtenir une assimilation de données plus économique et de qualité (éventuellement) similaire. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst b/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst index 1305628..852e342 100644 --- a/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst +++ b/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst @@ -69,6 +69,13 @@ complémentaire, et si le but est d'évaluer l'erreur calcul-mesure, un d'échantillonnage pour établir un ensemble de valeurs de fonctionnelle d'erreur :math:`J` à partir d'observations :math:`\mathbf{y}^o`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index f5588a2..357f44d 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -54,6 +54,15 @@ reste la covariance d'ébauche initialement fournie par l'utilisateur. Pour êtr explicite, contrairement aux filtres de type Kalman, la covariance d'erreurs sur les états n'est pas remise à jour. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst index dd6c03f..66cc9b6 100644 --- a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst @@ -81,6 +81,15 @@ variante est nommée "CEKF", elle est recommandée et elle est utilisée par défaut), ou être conduit sans aucune contrainte (cette variante est nommée "EKF", et elle n'est pas recommandée). +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst index ee917b7..2429a04 100644 --- a/doc/fr/ref_algorithm_FunctionTest.rst +++ b/doc/fr/ref_algorithm_FunctionTest.rst @@ -51,6 +51,13 @@ permettre l'automatisation des tests d'opérateur. Il peut être aussi utile de vérifier préalablement les entrées elles-mêmes avec le test prévu :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_GradientTest.rst b/doc/fr/ref_algorithm_GradientTest.rst index 86f6b63..bed820c 100644 --- a/doc/fr/ref_algorithm_GradientTest.rst +++ b/doc/fr/ref_algorithm_GradientTest.rst @@ -92,6 +92,13 @@ On observe le résidu, qui est basé sur une approximation du gradient : qui doit rester constant jusqu'à ce que l'on atteigne la précision du calcul. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_InputValuesTest.rst b/doc/fr/ref_algorithm_InputValuesTest.rst index 4dca375..d940850 100644 --- a/doc/fr/ref_algorithm_InputValuesTest.rst +++ b/doc/fr/ref_algorithm_InputValuesTest.rst @@ -38,6 +38,11 @@ contenu des variables lues sous forme imprimée pour vérification (*attention, si une variable est de grande taille, cette restitution peut être informatiquement problématique*). +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_InterpolationByReducedModelTask.rst b/doc/fr/ref_algorithm_InterpolationByReducedModelTask.rst index 6349f43..c3ae751 100644 --- a/doc/fr/ref_algorithm_InterpolationByReducedModelTask.rst +++ b/doc/fr/ref_algorithm_InterpolationByReducedModelTask.rst @@ -68,6 +68,11 @@ mesures aux positions requises, sans devoir refaire l'analyse préalable. .. centered:: **Schéma général d'utilisation de l'algorithme** +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst index 41f1672..19492cf 100644 --- a/doc/fr/ref_algorithm_KalmanFilter.rst +++ b/doc/fr/ref_algorithm_KalmanFilter.rst @@ -78,6 +78,15 @@ En cas de non-linéarité des opérateurs, même peu marquée, on lui préférer supportent des bornes sur l'état, etc. On peut vérifier la linéarité des opérateurs à l'aide d'un :ref:`section_ref_algorithm_LinearityTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst index 75bf92f..4fba77c 100644 --- a/doc/fr/ref_algorithm_LinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst @@ -53,6 +53,15 @@ Dans tous les cas, il est recommandé de lui préférer au minimum un :ref:`section_ref_algorithm_ExtendedBlue` ou un :ref:`section_ref_algorithm_3DVAR`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_LinearityTest.rst b/doc/fr/ref_algorithm_LinearityTest.rst index 617cd2f..3e4e04e 100644 --- a/doc/fr/ref_algorithm_LinearityTest.rst +++ b/doc/fr/ref_algorithm_LinearityTest.rst @@ -114,6 +114,13 @@ S'il est égal à 0 sur une partie seulement du domaine de variation de l'incrément :math:`\alpha`, c'est sur cette partie que l'hypothèse de linéarité de F est vérifiée. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_LocalSensitivityTest.rst b/doc/fr/ref_algorithm_LocalSensitivityTest.rst index ad6db9b..5cb9b2e 100644 --- a/doc/fr/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/fr/ref_algorithm_LocalSensitivityTest.rst @@ -40,6 +40,13 @@ d'observation :math:`\mathcal{H}` par rapport aux variables d'entrée est l'opérateur linéarisé (ou opérateur tangent) :math:`\mathbf{H}` de :math:`\mathcal{H}` autour du point de vérification choisi. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 4eb5bd3..26e45ee 100644 --- a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -101,6 +101,13 @@ Il est possible d'exclure a priori des positions potentielles pour le positionnement des mesures, en utilisant le variant "*lcEIM*" ou "*lcDEIM*" d'analyse pour une recherche de positionnement contraint. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index de8f035..13e0125 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -51,6 +51,15 @@ Dans tous les cas, il est recommandé de lui préférer un :ref:`section_ref_algorithm_3DVAR` pour sa stabilité comme pour son comportement lors de l'optimisation. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + +.. include:: snippets/FeaturePropParallelDerivativesOnly.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ObservationSimulationComparisonTest.rst b/doc/fr/ref_algorithm_ObservationSimulationComparisonTest.rst index 6032b9a..88665a8 100644 --- a/doc/fr/ref_algorithm_ObservationSimulationComparisonTest.rst +++ b/doc/fr/ref_algorithm_ObservationSimulationComparisonTest.rst @@ -56,6 +56,11 @@ permettre l'automatisation des tests d'opérateur. Il peut être aussi utile de vérifier préalablement les entrées elles-mêmes avec le test prévu :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ObserverTest.rst b/doc/fr/ref_algorithm_ObserverTest.rst index a356a89..095cff0 100644 --- a/doc/fr/ref_algorithm_ObserverTest.rst +++ b/doc/fr/ref_algorithm_ObserverTest.rst @@ -36,6 +36,11 @@ appliquée pour chacune des variables potentiellement observables. Elle n'est activée que sur celles qui sont explicitement associées avec cet *observer* dans sa déclaration. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ParallelFunctionTest.rst b/doc/fr/ref_algorithm_ParallelFunctionTest.rst index 0189a6e..a888314 100644 --- a/doc/fr/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/fr/ref_algorithm_ParallelFunctionTest.rst @@ -51,6 +51,13 @@ permettre l'automatisation des tests d'opérateur. Il peut être aussi utile de vérifier préalablement les entrées elles-mêmes avec le test prévu :ref:`section_ref_algorithm_InputValuesTest`. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst index e6bafe8..77d75e5 100644 --- a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst @@ -135,6 +135,15 @@ gradient de la fonctionnelle par approximation numérique. Mais il est aussi nécessaire que le calcul de la fonction à simuler ne soit pas trop coûteux pour éviter une durée d'optimisation rédhibitoire. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_QuantileRegression.rst b/doc/fr/ref_algorithm_QuantileRegression.rst index 93312bc..8fa169d 100644 --- a/doc/fr/ref_algorithm_QuantileRegression.rst +++ b/doc/fr/ref_algorithm_QuantileRegression.rst @@ -36,6 +36,13 @@ exprimés à l'aide d'un modèle des variables observées. Ce sont donc les quantiles sur les variables observées qui vont permettre de déterminer les paramètres de modèles satisfaisant aux conditions de quantiles. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_ReducedModelingTest.rst b/doc/fr/ref_algorithm_ReducedModelingTest.rst index c916a3e..c797655 100644 --- a/doc/fr/ref_algorithm_ReducedModelingTest.rst +++ b/doc/fr/ref_algorithm_ReducedModelingTest.rst @@ -47,6 +47,11 @@ point de vue statistique, en tant que variance restante. Une fois l'analyse terminée, un résumé est affiché et, sur demande, une représentation graphique des mêmes informations est produite. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_SamplingTest.rst b/doc/fr/ref_algorithm_SamplingTest.rst index 1c1e851..8101d17 100644 --- a/doc/fr/ref_algorithm_SamplingTest.rst +++ b/doc/fr/ref_algorithm_SamplingTest.rst @@ -67,6 +67,13 @@ disponible). On utilise pour cela, sur la variable désirée, la sauvegarde finale à l'aide du mot-clé "*UserPostAnalysis*" ou le traitement en cours de calcul à l'aide des "*observer*" adaptés. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_TabuSearch.rst b/doc/fr/ref_algorithm_TabuSearch.rst index 7dd0647..93562bd 100644 --- a/doc/fr/ref_algorithm_TabuSearch.rst +++ b/doc/fr/ref_algorithm_TabuSearch.rst @@ -52,6 +52,13 @@ l'algorithme permet d'interdire (d'où le nom de *tabou*) le retour dans les derniers états explorés. Les positions déjà explorées sont conservées dans une liste de longueur finie. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropNonLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_TangentTest.rst b/doc/fr/ref_algorithm_TangentTest.rst index bc05399..9a7d0cf 100644 --- a/doc/fr/ref_algorithm_TangentTest.rst +++ b/doc/fr/ref_algorithm_TangentTest.rst @@ -59,6 +59,11 @@ vraisemblablement linéaire ou quasi-linéaire (ce que l'on peut vérifier par l':ref:`section_ref_algorithm_LinearityTest`), et le tangent est valide jusqu'à ce que l'on atteigne la précision du calcul. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropDerivativeNeeded.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst index 53e6cbc..95954f9 100644 --- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst @@ -97,6 +97,15 @@ algorithmes : parallélisées ou distribuées dans le cas où la fonction à simuler le supporte. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo12.rst + +.. include:: snippets/FeaturePropLocalOptimization.rst + +.. include:: snippets/FeaturePropDerivativeFree.rst + +.. include:: snippets/FeaturePropParallelAlgorithm.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo02.rst diff --git a/src/daComposant/daAlgorithms/AdjointTest.py b/src/daComposant/daAlgorithms/AdjointTest.py index 142d989..bb46de9 100644 --- a/src/daComposant/daAlgorithms/AdjointTest.py +++ b/src/daComposant/daAlgorithms/AdjointTest.py @@ -90,9 +90,15 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): mandatory= ("Xb", "HO"), optional = ("Y", ), ) - self.setAttributes(tags=( - "Checking", - )) + self.setAttributes( + tags=( + "Checking", + ), + features=( + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), + ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): self._pre_run(Parameters, Xb, Y, U, HO, EM, CM, R, B, Q) diff --git a/src/daComposant/daAlgorithms/ControledFunctionTest.py b/src/daComposant/daAlgorithms/ControledFunctionTest.py index e38591c..3e615a2 100644 --- a/src/daComposant/daAlgorithms/ControledFunctionTest.py +++ b/src/daComposant/daAlgorithms/ControledFunctionTest.py @@ -78,7 +78,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + "ParallelFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/DifferentialEvolution.py b/src/daComposant/daAlgorithms/DifferentialEvolution.py index 2d671bc..0c00797 100644 --- a/src/daComposant/daAlgorithms/DifferentialEvolution.py +++ b/src/daComposant/daAlgorithms/DifferentialEvolution.py @@ -154,6 +154,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "MetaHeuristic", "Population", ), + features=( + "NonLocalOptimization", + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/EnsembleBlue.py b/src/daComposant/daAlgorithms/EnsembleBlue.py index fdcaf02..8255216 100644 --- a/src/daComposant/daAlgorithms/EnsembleBlue.py +++ b/src/daComposant/daAlgorithms/EnsembleBlue.py @@ -64,6 +64,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "Ensemble", "Reduction", ), + features=( + "LocalOptimization", + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/EnsembleKalmanFilter.py b/src/daComposant/daAlgorithms/EnsembleKalmanFilter.py index 65891bb..270364f 100644 --- a/src/daComposant/daAlgorithms/EnsembleKalmanFilter.py +++ b/src/daComposant/daAlgorithms/EnsembleKalmanFilter.py @@ -190,6 +190,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): ), features=( "LocalOptimization", + "DerivativeFree", "ParallelAlgorithm", ), ) diff --git a/src/daComposant/daAlgorithms/EnsembleOfSimulationGenerationTask.py b/src/daComposant/daAlgorithms/EnsembleOfSimulationGenerationTask.py index 84adcec..6751d31 100644 --- a/src/daComposant/daAlgorithms/EnsembleOfSimulationGenerationTask.py +++ b/src/daComposant/daAlgorithms/EnsembleOfSimulationGenerationTask.py @@ -93,7 +93,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): tags=( "Reduction", "Checking", - ) + ), + features=( + "DerivativeFree", + "ParallelAlgorithm", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ExtendedBlue.py b/src/daComposant/daAlgorithms/ExtendedBlue.py index 6981336..2a584ef 100644 --- a/src/daComposant/daAlgorithms/ExtendedBlue.py +++ b/src/daComposant/daAlgorithms/ExtendedBlue.py @@ -130,7 +130,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "DataAssimilation", "NonLinear", "Filter", - ) + ), + features=( + "LocalOptimization", + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ExtendedKalmanFilter.py b/src/daComposant/daAlgorithms/ExtendedKalmanFilter.py index 63a7ee7..269fc03 100644 --- a/src/daComposant/daAlgorithms/ExtendedKalmanFilter.py +++ b/src/daComposant/daAlgorithms/ExtendedKalmanFilter.py @@ -106,7 +106,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "NonLinear", "Filter", "Dynamic", - ) + ), + features=( + "LocalOptimization", + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/FunctionTest.py b/src/daComposant/daAlgorithms/FunctionTest.py index 219a18a..01fae12 100644 --- a/src/daComposant/daAlgorithms/FunctionTest.py +++ b/src/daComposant/daAlgorithms/FunctionTest.py @@ -77,7 +77,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + "ParallelFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/GradientTest.py b/src/daComposant/daAlgorithms/GradientTest.py index 851a4e7..14876e9 100644 --- a/src/daComposant/daAlgorithms/GradientTest.py +++ b/src/daComposant/daAlgorithms/GradientTest.py @@ -117,7 +117,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/InputValuesTest.py b/src/daComposant/daAlgorithms/InputValuesTest.py index 468c522..6695297 100644 --- a/src/daComposant/daAlgorithms/InputValuesTest.py +++ b/src/daComposant/daAlgorithms/InputValuesTest.py @@ -68,7 +68,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/InterpolationByReducedModelTask.py b/src/daComposant/daAlgorithms/InterpolationByReducedModelTask.py index e94f531..e15ae80 100644 --- a/src/daComposant/daAlgorithms/InterpolationByReducedModelTask.py +++ b/src/daComposant/daAlgorithms/InterpolationByReducedModelTask.py @@ -64,7 +64,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): tags=( "Reduction", "Interpolation", - ) + ), + features=( + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/InterpolationByReducedModelTest.py b/src/daComposant/daAlgorithms/InterpolationByReducedModelTest.py index 9512765..c45a028 100644 --- a/src/daComposant/daAlgorithms/InterpolationByReducedModelTest.py +++ b/src/daComposant/daAlgorithms/InterpolationByReducedModelTest.py @@ -84,7 +84,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): tags=( "Reduction", "Interpolation", - ) + ), + features=( + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/KalmanFilter.py b/src/daComposant/daAlgorithms/KalmanFilter.py index 22135d3..5d1b19e 100644 --- a/src/daComposant/daAlgorithms/KalmanFilter.py +++ b/src/daComposant/daAlgorithms/KalmanFilter.py @@ -93,7 +93,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "Linear", "Filter", "Dynamic", - ) + ), + features=( + "LocalOptimization", + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/LinearLeastSquares.py b/src/daComposant/daAlgorithms/LinearLeastSquares.py index b827d62..7f86dc6 100644 --- a/src/daComposant/daAlgorithms/LinearLeastSquares.py +++ b/src/daComposant/daAlgorithms/LinearLeastSquares.py @@ -85,7 +85,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "Optimization", "Linear", "Variational", - ) + ), + features=( + "LocalOptimization", + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/LinearityTest.py b/src/daComposant/daAlgorithms/LinearityTest.py index e8f7de4..e6f97f9 100644 --- a/src/daComposant/daAlgorithms/LinearityTest.py +++ b/src/daComposant/daAlgorithms/LinearityTest.py @@ -99,7 +99,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/LocalSensitivityTest.py b/src/daComposant/daAlgorithms/LocalSensitivityTest.py index 9bdf25a..78ed115 100644 --- a/src/daComposant/daAlgorithms/LocalSensitivityTest.py +++ b/src/daComposant/daAlgorithms/LocalSensitivityTest.py @@ -50,7 +50,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py b/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py index 12438cc..64398c6 100644 --- a/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py +++ b/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py @@ -166,7 +166,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): tags=( "Reduction", "Checking", - ) + ), + features=( + "DerivativeFree", + "ParallelAlgorithm", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/NonLinearLeastSquares.py b/src/daComposant/daAlgorithms/NonLinearLeastSquares.py index 2351c3d..371fd30 100644 --- a/src/daComposant/daAlgorithms/NonLinearLeastSquares.py +++ b/src/daComposant/daAlgorithms/NonLinearLeastSquares.py @@ -147,7 +147,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "Optimization", "NonLinear", "Variational", - ) + ), + features=( + "LocalOptimization", + "DerivativeNeeded", + "ParallelDerivativesOnly", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ObservationSimulationComparisonTest.py b/src/daComposant/daAlgorithms/ObservationSimulationComparisonTest.py index cab7514..2654dd7 100644 --- a/src/daComposant/daAlgorithms/ObservationSimulationComparisonTest.py +++ b/src/daComposant/daAlgorithms/ObservationSimulationComparisonTest.py @@ -84,7 +84,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ObserverTest.py b/src/daComposant/daAlgorithms/ObserverTest.py index c20d77f..a56325d 100644 --- a/src/daComposant/daAlgorithms/ObserverTest.py +++ b/src/daComposant/daAlgorithms/ObserverTest.py @@ -30,7 +30,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ParallelFunctionTest.py b/src/daComposant/daAlgorithms/ParallelFunctionTest.py index 88b4eaf..fe32909 100644 --- a/src/daComposant/daAlgorithms/ParallelFunctionTest.py +++ b/src/daComposant/daAlgorithms/ParallelFunctionTest.py @@ -77,7 +77,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + "ParallelAlgorithm", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py b/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py index 90969c5..8ff0219 100644 --- a/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py +++ b/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py @@ -186,7 +186,12 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "NonLinear", "MetaHeuristic", "Population", - ) + ), + features=( + "NonLocalOptimization", + "DerivativeFree", + "ParallelAlgorithm", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/QuantileRegression.py b/src/daComposant/daAlgorithms/QuantileRegression.py index 921793a..3fc63ce 100644 --- a/src/daComposant/daAlgorithms/QuantileRegression.py +++ b/src/daComposant/daAlgorithms/QuantileRegression.py @@ -101,7 +101,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "Optimization", "Risk", "Variational", - ) + ), + features=( + "LocalOptimization", + "DerivativeNeeded", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/ReducedModelingTest.py b/src/daComposant/daAlgorithms/ReducedModelingTest.py index 05f7198..14536e0 100644 --- a/src/daComposant/daAlgorithms/ReducedModelingTest.py +++ b/src/daComposant/daAlgorithms/ReducedModelingTest.py @@ -162,7 +162,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): tags=( "Reduction", "Checking", - ) + ), + features=( + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/SamplingTest.py b/src/daComposant/daAlgorithms/SamplingTest.py index c195fe9..062f602 100644 --- a/src/daComposant/daAlgorithms/SamplingTest.py +++ b/src/daComposant/daAlgorithms/SamplingTest.py @@ -125,7 +125,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeFree", + "ParallelAlgorithm", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/TabuSearch.py b/src/daComposant/daAlgorithms/TabuSearch.py index ec84a92..643ad63 100644 --- a/src/daComposant/daAlgorithms/TabuSearch.py +++ b/src/daComposant/daAlgorithms/TabuSearch.py @@ -134,7 +134,11 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "Optimization", "NonLinear", "MetaHeuristic", - ) + ), + features=( + "NonLocalOptimization", + "DerivativeFree", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daAlgorithms/TangentTest.py b/src/daComposant/daAlgorithms/TangentTest.py index 73a50dd..10e19fa 100644 --- a/src/daComposant/daAlgorithms/TangentTest.py +++ b/src/daComposant/daAlgorithms/TangentTest.py @@ -99,7 +99,10 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): self.setAttributes( tags=( "Checking", - ) + ), + features=( + "DerivativeNeeded", + ), ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None):