From 8d04279889b50e2da3a383d11da579251b317b3f Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Sun, 24 Mar 2019 15:02:33 +0100 Subject: [PATCH] Updating documentation by systematic review: FR part --- doc/fr/ref_algorithm_3DVAR.rst | 20 ++++++--- doc/fr/ref_algorithm_4DVAR.rst | 25 ++++++++--- doc/fr/ref_algorithm_AdjointTest.rst | 13 +++--- doc/fr/ref_algorithm_Blue.rst | 16 ++++--- ...f_algorithm_DerivativeFreeOptimization.rst | 26 ++++++++--- .../ref_algorithm_DifferentialEvolution.rst | 26 ++++++++--- doc/fr/ref_algorithm_EnsembleBlue.rst | 27 ++++++++--- doc/fr/ref_algorithm_EnsembleKalmanFilter.rst | 41 ++++++++++++++--- doc/fr/ref_algorithm_ExtendedBlue.rst | 45 ++++++++++++++----- doc/fr/ref_algorithm_ExtendedKalmanFilter.rst | 42 ++++++++++++++--- doc/fr/ref_algorithm_FunctionTest.rst | 11 ++--- doc/fr/ref_algorithm_GradientTest.rst | 13 +++--- doc/fr/ref_algorithm_KalmanFilter.rst | 43 +++++++++++++++--- doc/fr/ref_algorithm_LinearLeastSquares.rst | 43 +++++++++++++++--- doc/fr/ref_algorithm_LinearityTest.rst | 13 +++--- doc/fr/ref_algorithm_LocalSensitivityTest.rst | 13 +++--- .../ref_algorithm_NonLinearLeastSquares.rst | 45 ++++++++++++++----- ...ef_algorithm_ParticleSwarmOptimization.rst | 24 +++++++--- doc/fr/ref_algorithm_QuantileRegression.rst | 22 ++++++--- doc/fr/ref_algorithm_SamplingTest.rst | 17 ++++--- doc/fr/ref_algorithm_TabuSearch.rst | 30 ++++++++----- doc/fr/ref_algorithm_TangentTest.rst | 13 +++--- .../ref_algorithm_UnscentedKalmanFilter.rst | 18 +++++--- doc/fr/snippets/Header2Algo04.rst | 2 + doc/fr/snippets/Header2Algo05.rst | 5 ++- doc/fr/snippets/PredictedState.rst | 9 ++++ 26 files changed, 450 insertions(+), 152 deletions(-) create mode 100644 doc/fr/snippets/PredictedState.rst diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst index b3c11e2..25f9a71 100644 --- a/doc/fr/ref_algorithm_3DVAR.rst +++ b/doc/fr/ref_algorithm_3DVAR.rst @@ -91,10 +91,12 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", @@ -126,7 +128,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -142,6 +144,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -152,10 +156,16 @@ StoreSupplementaryCalculations .. include:: snippets/BMA.rst +.. include:: snippets/CostFunctionJ.rst + .. include:: snippets/CostFunctionJAtCurrentOptimum.rst +.. include:: snippets/CostFunctionJb.rst + .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst .. include:: snippets/CurrentOptimum.rst diff --git a/doc/fr/ref_algorithm_4DVAR.rst b/doc/fr/ref_algorithm_4DVAR.rst index 0550c94..43807d0 100644 --- a/doc/fr/ref_algorithm_4DVAR.rst +++ b/doc/fr/ref_algorithm_4DVAR.rst @@ -98,23 +98,26 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "BMA", "CostFunctionJ", - "CostFunctionJb", - "CostFunctionJo", "CostFunctionJAtCurrentOptimum", + "CostFunctionJb", "CostFunctionJbAtCurrentOptimum", + "CostFunctionJo", "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", "IndexOfOptimum", ]. - Exemple : ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + Exemple : + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -130,12 +133,20 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst +.. include:: snippets/CostFunctionJ.rst + .. include:: snippets/CostFunctionJAtCurrentOptimum.rst +.. include:: snippets/CostFunctionJb.rst + .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst .. include:: snippets/CurrentOptimum.rst diff --git a/doc/fr/ref_algorithm_AdjointTest.rst b/doc/fr/ref_algorithm_AdjointTest.rst index b3af821..a9a352e 100644 --- a/doc/fr/ref_algorithm_AdjointTest.rst +++ b/doc/fr/ref_algorithm_AdjointTest.rst @@ -65,17 +65,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CurrentState", "Residu", "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -87,6 +88,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/Residu.rst + .. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index 342838c..305e20f 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -72,10 +72,12 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", @@ -103,7 +105,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -113,6 +115,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -153,7 +157,7 @@ StoreSupplementaryCalculations .. include:: snippets/SimulatedObservationAtBackground.rst -.. include:: snippets/SimulatedObservationAtOptimum.rst +.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst .. include:: snippets/SimulatedObservationAtCurrentState.rst diff --git a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst index 2d93d30..8d0b069 100644 --- a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst @@ -78,16 +78,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "BMA", "CostFunctionJ", - "CostFunctionJAtCurrentOptimum", "CostFunctionJb", - "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJAtCurrentOptimum", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", @@ -103,7 +105,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -121,8 +123,16 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst +.. include:: snippets/CostFunctionJ.rst + +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CostFunctionJAtCurrentOptimum.rst .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst @@ -131,6 +141,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentOptimum.rst +.. include:: snippets/CurrentState.rst + .. include:: snippets/IndexOfOptimum.rst .. include:: snippets/Innovation.rst diff --git a/doc/fr/ref_algorithm_DifferentialEvolution.rst b/doc/fr/ref_algorithm_DifferentialEvolution.rst index ea778cb..2b93c5d 100644 --- a/doc/fr/ref_algorithm_DifferentialEvolution.rst +++ b/doc/fr/ref_algorithm_DifferentialEvolution.rst @@ -85,16 +85,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "BMA", "CostFunctionJ", - "CostFunctionJAtCurrentOptimum", "CostFunctionJb", - "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJAtCurrentOptimum", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", @@ -110,7 +112,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -128,8 +130,16 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst +.. include:: snippets/CostFunctionJ.rst + +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CostFunctionJAtCurrentOptimum.rst .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst @@ -138,6 +148,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentOptimum.rst +.. include:: snippets/CurrentState.rst + .. include:: snippets/IndexOfOptimum.rst .. include:: snippets/Innovation.rst diff --git a/doc/fr/ref_algorithm_EnsembleBlue.rst b/doc/fr/ref_algorithm_EnsembleBlue.rst index 0932233..5b322f8 100644 --- a/doc/fr/ref_algorithm_EnsembleBlue.rst +++ b/doc/fr/ref_algorithm_EnsembleBlue.rst @@ -62,10 +62,12 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "CurrentState", "Innovation", "SimulatedObservationAtBackground", @@ -74,7 +76,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -85,6 +87,21 @@ StoreSupplementaryCalculations .. include:: snippets/Innovation.rst +.. ------------------------------------ .. +.. include:: snippets/Header2Algo05.rst + +.. include:: snippets/Analysis.rst + +.. include:: snippets/CurrentState.rst + +.. include:: snippets/Innovation.rst + +.. include:: snippets/SimulatedObservationAtBackground.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst + +.. include:: snippets/SimulatedObservationAtOptimum.rst + .. ------------------------------------ .. .. include:: snippets/Header2Algo06.rst diff --git a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst index ef0c84d..6b55b69 100644 --- a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst @@ -77,23 +77,34 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "CostFunctionJ", + "CostFunctionJAtCurrentOptimum", "CostFunctionJb", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJoAtCurrentOptimum", + "CurrentOptimum", "CurrentState", + "IndexOfOptimum", + "InnovationAtCurrentState", + "PredictedState", + "SimulatedObservationAtCurrentOptimum", + "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -103,6 +114,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -115,13 +128,29 @@ StoreSupplementaryCalculations .. include:: snippets/CostFunctionJ.rst +.. include:: snippets/CostFunctionJAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJb.rst +.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJo.rst +.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst + +.. include:: snippets/CurrentOptimum.rst + .. include:: snippets/CurrentState.rst -.. include:: snippets/Innovation.rst +.. include:: snippets/IndexOfOptimum.rst + +.. include:: snippets/InnovationAtCurrentState.rst + +.. include:: snippets/PredictedState.rst + +.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. .. include:: snippets/Header2Algo06.rst diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index c68b0e6..ee894cd 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -69,33 +69,40 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", - "OMA", - "OMB", - "CurrentState", "CostFunctionJ", + "CostFunctionJAtCurrentOptimum", "CostFunctionJb", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJoAtCurrentOptimum", + "CurrentOptimum", + "CurrentState", "Innovation", + "MahalanobisConsistency", + "OMA", + "OMB", "SigmaBck2", "SigmaObs2", - "MahalanobisConsistency", - "SimulationQuantiles", "SimulatedObservationAtBackground", + "SimulatedObservationAtCurrentOptimum", "SimulatedObservationAtCurrentState", - "SimulatedObservationAtOptimum", + "SimulatedObservationAtOptimum", + "SimulationQuantiles", ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -105,6 +112,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -117,10 +126,20 @@ StoreSupplementaryCalculations .. include:: snippets/CostFunctionJ.rst +.. include:: snippets/CostFunctionJAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJb.rst +.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJo.rst +.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst + +.. include:: snippets/CurrentOptimum.rst + +.. include:: snippets/CurrentState.rst + .. include:: snippets/Innovation.rst .. include:: snippets/MahalanobisConsistency.rst @@ -135,6 +154,10 @@ StoreSupplementaryCalculations .. include:: snippets/SimulatedObservationAtBackground.rst +.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst + .. include:: snippets/SimulatedObservationAtOptimum.rst .. include:: snippets/SimulationQuantiles.rst diff --git a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst index 8696d30..5a3a3ba 100644 --- a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst @@ -71,24 +71,34 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "CostFunctionJ", + "CostFunctionJAtCurrentOptimum", "CostFunctionJb", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJoAtCurrentOptimum", + "CurrentOptimum", "CurrentState", - "Innovation", + "IndexOfOptimum", + "InnovationAtCurrentState", + "PredictedState", + "SimulatedObservationAtCurrentOptimum", + "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -98,6 +108,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -110,13 +122,29 @@ StoreSupplementaryCalculations .. include:: snippets/CostFunctionJ.rst +.. include:: snippets/CostFunctionJAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJb.rst +.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJo.rst +.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst + +.. include:: snippets/CurrentOptimum.rst + .. include:: snippets/CurrentState.rst -.. include:: snippets/Innovation.rst +.. include:: snippets/IndexOfOptimum.rst + +.. include:: snippets/InnovationAtCurrentState.rst + +.. include:: snippets/PredictedState.rst + +.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. .. include:: snippets/Header2Algo06.rst diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst index 954476d..f122a5a 100644 --- a/doc/fr/ref_algorithm_FunctionTest.rst +++ b/doc/fr/ref_algorithm_FunctionTest.rst @@ -62,16 +62,17 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CurrentState", "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_GradientTest.rst b/doc/fr/ref_algorithm_GradientTest.rst index 2791477..f09919a 100644 --- a/doc/fr/ref_algorithm_GradientTest.rst +++ b/doc/fr/ref_algorithm_GradientTest.rst @@ -124,17 +124,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CurrentState", "Residu", "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -146,6 +147,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/Residu.rst + .. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst index 6517773..1f92ad3 100644 --- a/doc/fr/ref_algorithm_KalmanFilter.rst +++ b/doc/fr/ref_algorithm_KalmanFilter.rst @@ -69,23 +69,34 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", "APosterioriVariances", "BMA", "CostFunctionJ", + "CostFunctionJAtCurrentOptimum", "CostFunctionJb", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJoAtCurrentOptimum", + "CurrentOptimum", "CurrentState", - "Innovation", + "IndexOfOptimum", + "InnovationAtCurrentState", + "PredictedState", + "SimulatedObservationAtCurrentOptimum", + "SimulatedObservationAtCurrentState", ]. - Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + Exemple : + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -95,6 +106,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -107,13 +120,29 @@ StoreSupplementaryCalculations .. include:: snippets/CostFunctionJ.rst +.. include:: snippets/CostFunctionJAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJb.rst +.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst + .. include:: snippets/CostFunctionJo.rst +.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst + +.. include:: snippets/CurrentOptimum.rst + .. include:: snippets/CurrentState.rst -.. include:: snippets/Innovation.rst +.. include:: snippets/IndexOfOptimum.rst + +.. include:: snippets/InnovationAtCurrentState.rst + +.. include:: snippets/PredictedState.rst + +.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. .. include:: snippets/Header2Algo06.rst diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst index d67065b..ccd4a99 100644 --- a/doc/fr/ref_algorithm_LinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst @@ -61,21 +61,28 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ - "OMA", - "CurrentState", + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "CostFunctionJ", + "CostFunctionJAtCurrentOptimum", "CostFunctionJb", + "CostFunctionJbAtCurrentOptimum", "CostFunctionJo", + "CostFunctionJoAtCurrentOptimum", + "CurrentOptimum", + "CurrentState", + "OMA", + "SimulatedObservationAtCurrentOptimum", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum", ]. Exemple : - ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` *Astuce pour cet algorithme :* @@ -99,8 +106,30 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + +.. include:: snippets/CostFunctionJ.rst + +.. include:: snippets/CostFunctionJAtCurrentOptimum.rst + +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst + +.. include:: snippets/CostFunctionJo.rst + +.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst + +.. include:: snippets/CurrentOptimum.rst + +.. include:: snippets/CurrentState.rst + .. include:: snippets/OMA.rst +.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst + .. include:: snippets/SimulatedObservationAtOptimum.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_LinearityTest.rst b/doc/fr/ref_algorithm_LinearityTest.rst index aecefe4..14e6185 100644 --- a/doc/fr/ref_algorithm_LinearityTest.rst +++ b/doc/fr/ref_algorithm_LinearityTest.rst @@ -148,17 +148,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CurrentState", "Residu", "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -170,6 +171,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/Residu.rst + .. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_LocalSensitivityTest.rst b/doc/fr/ref_algorithm_LocalSensitivityTest.rst index 7d64101..185317e 100644 --- a/doc/fr/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/fr/ref_algorithm_LocalSensitivityTest.rst @@ -66,17 +66,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CurrentState", "JacobianMatrixAtCurrentState", "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -88,6 +89,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/JacobianMatrixAtCurrentState.rst + .. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index 32c9a13..483a60e 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -86,19 +86,34 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : ["BMA", "CostFunctionJ", - "CostFunctionJb", "CostFunctionJo", "CostFunctionJAtCurrentOptimum", - "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum", - "CurrentState", "CurrentOptimum", "IndexOfOptimum", "Innovation", - "InnovationAtCurrentState", "OMA", "OMB", - "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", - "SimulatedObservationAtOptimum", "SimulatedObservationAtCurrentOptimum"]. + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", + "BMA", + "CostFunctionJ", + "CostFunctionJAtCurrentOptimum", + "CostFunctionJb", + "CostFunctionJbAtCurrentOptimum", + "CostFunctionJo", + "CostFunctionJoAtCurrentOptimum", + "CurrentOptimum", + "CurrentState", + "IndexOfOptimum", + "Innovation", + "InnovationAtCurrentState", + "OMA", + "OMB", + "SimulatedObservationAtBackground", + "SimulatedObservationAtCurrentOptimum", + "SimulatedObservationAtCurrentState", + "SimulatedObservationAtOptimum", + ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` *Astuce pour cet algorithme :* @@ -122,12 +137,20 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst +.. include:: snippets/CostFunctionJ.rst + .. include:: snippets/CostFunctionJAtCurrentOptimum.rst +.. include:: snippets/CostFunctionJb.rst + .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst .. include:: snippets/CurrentOptimum.rst diff --git a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst index 083a7aa..8e8e534 100644 --- a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst @@ -112,25 +112,27 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "BMA", + "CurrentState", "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", - "CurrentState", + "Innovation", "OMA", "OMB", - "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum", ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -146,10 +148,18 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst .. include:: snippets/CurrentState.rst +.. include:: snippets/CostFunctionJ.rst + +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/Innovation.rst .. include:: snippets/OMA.rst diff --git a/doc/fr/ref_algorithm_QuantileRegression.rst b/doc/fr/ref_algorithm_QuantileRegression.rst index 7b80715..de4b6d3 100644 --- a/doc/fr/ref_algorithm_QuantileRegression.rst +++ b/doc/fr/ref_algorithm_QuantileRegression.rst @@ -59,25 +59,27 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "BMA", "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "CurrentState", + "Innovation", "OMA", "OMB", - "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum", ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` *Astuce pour cet algorithme :* @@ -101,8 +103,16 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst +.. include:: snippets/CostFunctionJ.rst + +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CurrentState.rst .. include:: snippets/Innovation.rst diff --git a/doc/fr/ref_algorithm_SamplingTest.rst b/doc/fr/ref_algorithm_SamplingTest.rst index e581a49..be45d5a 100644 --- a/doc/fr/ref_algorithm_SamplingTest.rst +++ b/doc/fr/ref_algorithm_SamplingTest.rst @@ -88,10 +88,11 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", @@ -101,7 +102,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["CostFunctionJ", "SimulatedObservationAtCurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -115,6 +116,12 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/CostFunctionJ.rst + +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJo.rst + .. include:: snippets/CurrentState.rst .. include:: snippets/InnovationAtCurrentState.rst diff --git a/doc/fr/ref_algorithm_TabuSearch.rst b/doc/fr/ref_algorithm_TabuSearch.rst index 501a4db..e3df349 100644 --- a/doc/fr/ref_algorithm_TabuSearch.rst +++ b/doc/fr/ref_algorithm_TabuSearch.rst @@ -88,25 +88,27 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "BMA", - "OMA", - "OMB", "CurrentState", "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "Innovation", + "OMA", + "OMB", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum", ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -122,16 +124,24 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/BMA.rst -.. include:: snippets/OMA.rst +.. include:: snippets/CurrentState.rst -.. include:: snippets/OMB.rst +.. include:: snippets/CostFunctionJ.rst -.. include:: snippets/CurrentState.rst +.. include:: snippets/CostFunctionJb.rst + +.. include:: snippets/CostFunctionJo.rst .. include:: snippets/Innovation.rst +.. include:: snippets/OMA.rst + +.. include:: snippets/OMB.rst + .. include:: snippets/SimulatedObservationAtBackground.rst .. include:: snippets/SimulatedObservationAtCurrentState.rst diff --git a/doc/fr/ref_algorithm_TangentTest.rst b/doc/fr/ref_algorithm_TangentTest.rst index 3152eef..0903edd 100644 --- a/doc/fr/ref_algorithm_TangentTest.rst +++ b/doc/fr/ref_algorithm_TangentTest.rst @@ -75,17 +75,18 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ "CurrentState", "Residu", "SimulatedObservationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -97,6 +98,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/Residu.rst + .. include:: snippets/SimulatedObservationAtCurrentState.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst index bddd0c8..de39ae9 100644 --- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst @@ -79,10 +79,12 @@ StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être - disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs ou du stockage coûteux. La valeur par défaut est une liste vide, - aucune de ces variables n'étant calculée et stockée par défaut. Les noms - possibles sont dans la liste suivante : [ + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "Analysis", "APosterioriCorrelations", "APosterioriCovariance", "APosterioriStandardDeviations", @@ -92,11 +94,11 @@ StoreSupplementaryCalculations "CostFunctionJb", "CostFunctionJo", "CurrentState", - "Innovation", + "InnovationAtCurrentState", ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}`` + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst @@ -106,6 +108,8 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. include:: snippets/Header2Algo05.rst +.. include:: snippets/Analysis.rst + .. include:: snippets/APosterioriCorrelations.rst .. include:: snippets/APosterioriCovariance.rst @@ -124,7 +128,7 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst -.. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentState.rst .. ------------------------------------ .. .. include:: snippets/Header2Algo06.rst diff --git a/doc/fr/snippets/Header2Algo04.rst b/doc/fr/snippets/Header2Algo04.rst index 73d9d24..43bddd3 100644 --- a/doc/fr/snippets/Header2Algo04.rst +++ b/doc/fr/snippets/Header2Algo04.rst @@ -9,4 +9,6 @@ graphique, ou du cas en interface textuelle. Les variables d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter l'écriture des procédures de post-processing, sont décrites dans l':ref:`subsection_r_o_v_Inventaire`. +**Sorties permanentes (non conditionnelles)** + Les sorties non conditionnelles de l'algorithme sont les suivantes : diff --git a/doc/fr/snippets/Header2Algo05.rst b/doc/fr/snippets/Header2Algo05.rst index 4c3e3ec..edb1cf8 100644 --- a/doc/fr/snippets/Header2Algo05.rst +++ b/doc/fr/snippets/Header2Algo05.rst @@ -1 +1,4 @@ -Les sorties conditionnelles de l'algorithme sont les suivantes : +**Ensemble des sorties à la demande (conditionnelles ou non)** + +L'ensemble des sorties (conditionnelles ou non) de l'algorithme, classées par +ordre alphabétique, est le suivant : diff --git a/doc/fr/snippets/PredictedState.rst b/doc/fr/snippets/PredictedState.rst new file mode 100644 index 0000000..35a8230 --- /dev/null +++ b/doc/fr/snippets/PredictedState.rst @@ -0,0 +1,9 @@ +.. index:: single: PredictedState + +PredictedState + *Liste de vecteurs*. Chaque élément est un vecteur d'état prévu par le modèle + dans le cas d'un filtre itératif, au cours du déroulement itératif de + l'algorithme utilisé. + + Exemple : + ``Xp = ADD.get("PredictedState")[:]`` -- 2.39.2