Updating documentation by systematic review: EN part

diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst
index 28cbe2d55077b1078e3a690337802347a2f6818c..e4364e7ca3b158e9dd54a29ad80545b80e84439e 100644 (file)
--- a/doc/en/ref_algorithm_3DVAR.rst
+++ b/doc/en/ref_algorithm_3DVAR.rst
@@ -89,10 +89,12 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "APosterioriCorrelations",
   "APosterioriCovariance",
   "APosterioriStandardDeviations",
@@ -124,7 +126,7 @@ StoreSupplementaryCalculations
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -140,6 +142,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo05.rst
 
+.. include:: snippets/Analysis.rst
+
 .. include:: snippets/APosterioriCorrelations.rst
 
 .. include:: snippets/APosterioriCovariance.rst
@@ -150,10 +154,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/en/ref_algorithm_4DVAR.rst b/doc/en/ref_algorithm_4DVAR.rst
index d12a2dd376feb50eccdef480a7735a9efc52fb05..b838cc094bd46d3e9800c7f22c44e801220e1419 100644 (file)
--- a/doc/en/ref_algorithm_4DVAR.rst
+++ b/doc/en/ref_algorithm_4DVAR.rst
@@ -96,23 +96,26 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "BMA",
   "CostFunctionJ",
-  "CostFunctionJb",
-  "CostFunctionJo",
   "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
   "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
   "CurrentOptimum",
   "CurrentState",
   "IndexOfOptimum",
   ].
 
-  Example : ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
+  Example :
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -128,12 +131,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/en/ref_algorithm_AdjointTest.rst b/doc/en/ref_algorithm_AdjointTest.rst
index 03763b9ad0a91513461d89746c51da6cbd7d0ecc..5aec2830005c5ad0faba3bcab470682801706a76 100644 (file)
--- a/doc/en/ref_algorithm_AdjointTest.rst
+++ b/doc/en/ref_algorithm_AdjointTest.rst
@@ -66,17 +66,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CurrentState",
   "Residu",
   "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -88,6 +89,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentState.rst
 
+.. include:: snippets/Residu.rst
+
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 
 .. ------------------------------------ ..

diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst
index e379ef110b7df9fde485f23c18fdcd91c75c8c25..be0d7ff2d8cd7ed448b9bc974a5488e2980eb32e 100644 (file)
--- a/doc/en/ref_algorithm_Blue.rst
+++ b/doc/en/ref_algorithm_Blue.rst
@@ -71,10 +71,12 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "APosterioriCorrelations",
   "APosterioriCovariance",
   "APosterioriStandardDeviations",
@@ -102,7 +104,7 @@ StoreSupplementaryCalculations
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -112,6 +114,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo05.rst
 
+.. include:: snippets/Analysis.rst
+
 .. include:: snippets/APosterioriCorrelations.rst
 
 .. include:: snippets/APosterioriCovariance.rst
@@ -152,7 +156,7 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/SimulatedObservationAtBackground.rst
 
-.. include:: snippets/SimulatedObservationAtOptimum.rst
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
 
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 

diff --git a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst
index 2c970dbc82edf9e897280373c03d15a79b165243..1b7553879b9d969c3be35243ff4581e4818ae318 100644 (file)
--- a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst
+++ b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst
@@ -76,16 +76,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "BMA",
   "CostFunctionJ",
-  "CostFunctionJAtCurrentOptimum",
   "CostFunctionJb",
-  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJoAtCurrentOptimum",
   "CurrentOptimum",
   "CurrentState",
@@ -101,7 +103,7 @@ StoreSupplementaryCalculations
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -119,8 +121,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
@@ -129,6 +139,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentOptimum.rst
 
+.. include:: snippets/CurrentState.rst
+
 .. include:: snippets/IndexOfOptimum.rst
 
 .. include:: snippets/Innovation.rst

diff --git a/doc/en/ref_algorithm_DifferentialEvolution.rst b/doc/en/ref_algorithm_DifferentialEvolution.rst
index 235aa1cd2177f8527e6fafc6e908cce2c82cd176..470d4460a756c62312afe0c0b3e8ccc9249dec86 100644 (file)
--- a/doc/en/ref_algorithm_DifferentialEvolution.rst
+++ b/doc/en/ref_algorithm_DifferentialEvolution.rst
@@ -84,16 +84,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "BMA",
   "CostFunctionJ",
-  "CostFunctionJAtCurrentOptimum",
   "CostFunctionJb",
-  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJoAtCurrentOptimum",
   "CurrentOptimum",
   "CurrentState",
@@ -109,7 +111,7 @@ StoreSupplementaryCalculations
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -127,8 +129,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
@@ -137,6 +147,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentOptimum.rst
 
+.. include:: snippets/CurrentState.rst
+
 .. include:: snippets/IndexOfOptimum.rst
 
 .. include:: snippets/Innovation.rst

diff --git a/doc/en/ref_algorithm_EnsembleBlue.rst b/doc/en/ref_algorithm_EnsembleBlue.rst
index c15d62ca79a55ca530651af5cc8e06064b27563c..77e95fff03af46d128caefe1be756abbba5e84bb 100644 (file)
--- a/doc/en/ref_algorithm_EnsembleBlue.rst
+++ b/doc/en/ref_algorithm_EnsembleBlue.rst
@@ -62,10 +62,12 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "CurrentState",
   "Innovation",
   "SimulatedObservationAtBackground",
@@ -74,7 +76,7 @@ StoreSupplementaryCalculations
   ].
 
   Example :
-  ``{"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/en/ref_algorithm_EnsembleKalmanFilter.rst b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst
index c6010f059f710b58643f920c70b7638c2b354a87..0497cfac7e90006455604503a8ae93fb7ebe8fda 100644 (file)
--- a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst
+++ b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst
@@ -76,23 +76,34 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "APosterioriCorrelations",
   "APosterioriCovariance",
   "APosterioriStandardDeviations",
   "APosterioriVariances",
   "BMA",
   "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
   "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
   "CurrentState",
+  "IndexOfOptimum",
+  "InnovationAtCurrentState",
+  "PredictedState",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -102,6 +113,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo05.rst
 
+.. include:: snippets/Analysis.rst
+
 .. include:: snippets/APosterioriCorrelations.rst
 
 .. include:: snippets/APosterioriCovariance.rst
@@ -114,13 +127,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/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst
index aa461d59f7f1f3367334dcda2c1713a3de82e546..988e1cffe600f1b506afadee1dd6aa5cdc8eac8e 100644 (file)
--- a/doc/en/ref_algorithm_ExtendedBlue.rst
+++ b/doc/en/ref_algorithm_ExtendedBlue.rst
@@ -69,33 +69,40 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "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",
+  "SimulationQuantiles",
   ].
 
   Example :
-  ``{"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/en/ref_algorithm_ExtendedKalmanFilter.rst b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst
index 836c3138c0ed50090d32b3b86e650fb6f8eb828a..2a082a7b308cbd683526dda15e4b192eb3d38220 100644 (file)
--- a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst
+++ b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst
@@ -70,24 +70,34 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "APosterioriCorrelations",
   "APosterioriCovariance",
   "APosterioriStandardDeviations",
   "APosterioriVariances",
   "BMA",
   "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
   "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
   "CurrentState",
-  "Innovation",
+  "IndexOfOptimum",
+  "InnovationAtCurrentState",
+  "PredictedState",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -97,6 +107,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo05.rst
 
+.. include:: snippets/Analysis.rst
+
 .. include:: snippets/APosterioriCorrelations.rst
 
 .. include:: snippets/APosterioriCovariance.rst
@@ -109,13 +121,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/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst
index 1d839300c347e03d18b7d7e0edbf2f5b97d1259b..2542a085e741e9cef2befcbcdac6c8a622ba4e3a 100644 (file)
--- a/doc/en/ref_algorithm_FunctionTest.rst
+++ b/doc/en/ref_algorithm_FunctionTest.rst
@@ -60,16 +60,17 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CurrentState",
   "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst

diff --git a/doc/en/ref_algorithm_GradientTest.rst b/doc/en/ref_algorithm_GradientTest.rst
index ba6821ebbcbbdcb47f841c917476b1925b2dd988..f70147b9711b6fd26f6af4984fbb7d75d484db2b 100644 (file)
--- a/doc/en/ref_algorithm_GradientTest.rst
+++ b/doc/en/ref_algorithm_GradientTest.rst
@@ -125,17 +125,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CurrentState",
   "Residu",
   "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -147,6 +148,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentState.rst
 
+.. include:: snippets/Residu.rst
+
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 
 .. ------------------------------------ ..

diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst
index 70015566e4e94aa1e95843067cf092945a62cf39..7c52db11245d869ce91b62dbf2ad677e294bee48 100644 (file)
--- a/doc/en/ref_algorithm_KalmanFilter.rst
+++ b/doc/en/ref_algorithm_KalmanFilter.rst
@@ -69,23 +69,34 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "APosterioriCorrelations",
   "APosterioriCovariance",
   "APosterioriStandardDeviations",
   "APosterioriVariances",
   "BMA",
   "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
   "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
   "CurrentState",
-  "Innovation",
+  "IndexOfOptimum",
+  "InnovationAtCurrentState",
+  "PredictedState",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
   ].
 
-  Example : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  Example :
+  ``{"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/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst
index 6ddd05c5375e3e25b611911366738c6a446f7c56..07251b06c2d8a4f4e53f4a65fa0e2e5ef3ddd604 100644 (file)
--- a/doc/en/ref_algorithm_LinearLeastSquares.rst
+++ b/doc/en/ref_algorithm_LinearLeastSquares.rst
@@ -61,21 +61,28 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
-  "OMA",
-  "CurrentState",
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
   "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "OMA",
+  "SimulatedObservationAtCurrentOptimum",
   "SimulatedObservationAtCurrentState",
   "SimulatedObservationAtOptimum",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 *Tips for this algorithm:*
 
@@ -98,8 +105,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/en/ref_algorithm_LinearityTest.rst b/doc/en/ref_algorithm_LinearityTest.rst
index c9bff1756bab361c0722fff496c4941e8ad82bd6..753c01bd937252535c6ba300aa7e86e3dd9d3481 100644 (file)
--- a/doc/en/ref_algorithm_LinearityTest.rst
+++ b/doc/en/ref_algorithm_LinearityTest.rst
@@ -148,17 +148,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CurrentState",
   "Residu",
   "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"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/en/ref_algorithm_LocalSensitivityTest.rst b/doc/en/ref_algorithm_LocalSensitivityTest.rst
index 2186dceba06ac198c6a27bf6709fa6b11b9618ce..d1992c954a6cc84347c7aa41f36d7fc0f23dcf53 100644 (file)
--- a/doc/en/ref_algorithm_LocalSensitivityTest.rst
+++ b/doc/en/ref_algorithm_LocalSensitivityTest.rst
@@ -65,17 +65,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CurrentState",
   "JacobianMatrixAtCurrentState",
   "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -87,6 +88,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentState.rst
 
+.. include:: snippets/JacobianMatrixAtCurrentState.rst
+
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 
 .. ------------------------------------ ..

diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst
index 07e90d9cca634cba5d3223a121ce57a71df11421..51e065f253e714f9274e115457d852baa0f2b99b 100644 (file)
--- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst
+++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst
@@ -83,19 +83,34 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: ["BMA", "CostFunctionJ",
-  "CostFunctionJb", "CostFunctionJo", "CostFunctionJAtCurrentOptimum",
-  "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum",
-  "CurrentState", "CurrentOptimum", "IndexOfOptimum", "Innovation",
-  "InnovationAtCurrentState", "OMA", "OMB",
-  "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-  "SimulatedObservationAtOptimum", "SimulatedObservationAtCurrentOptimum"].
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "IndexOfOptimum",
+  "Innovation",
+  "InnovationAtCurrentState",
+  "OMA",
+  "OMB",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 *Tips for this algorithm:*
 
@@ -118,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/en/ref_algorithm_ParticleSwarmOptimization.rst b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst
index 25141f6bee605411c6bacfdaeff7ca95fd00832a..e7770847bdfcac1b8f8f520e2c9f7c15f9f26227 100644 (file)
--- a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst
+++ b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst
@@ -109,25 +109,27 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "BMA",
+  "CurrentState",
   "CostFunctionJ",
   "CostFunctionJb",
   "CostFunctionJo",
-  "CurrentState",
+  "Innovation",
   "OMA",
   "OMB",
-  "Innovation",
   "SimulatedObservationAtBackground",
   "SimulatedObservationAtCurrentState",
   "SimulatedObservationAtOptimum",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -143,10 +145,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/en/ref_algorithm_QuantileRegression.rst b/doc/en/ref_algorithm_QuantileRegression.rst
index 6949aad2a1cbb84c31d848c567bc5841f74c90e4..07f016a918c63a10ca0a00e3ecb947b6bf97c3b6 100644 (file)
--- a/doc/en/ref_algorithm_QuantileRegression.rst
+++ b/doc/en/ref_algorithm_QuantileRegression.rst
@@ -59,25 +59,27 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "BMA",
   "CostFunctionJ",
   "CostFunctionJb",
   "CostFunctionJo",
   "CurrentState",
+  "Innovation",
   "OMA",
   "OMB",
-  "Innovation",
   "SimulatedObservationAtBackground",
   "SimulatedObservationAtCurrentState",
   "SimulatedObservationAtOptimum",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 *Tips for this algorithm:*
 
@@ -100,8 +102,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/en/ref_algorithm_SamplingTest.rst b/doc/en/ref_algorithm_SamplingTest.rst
index 7103f0a9ab31b1c2016c3fe1e43795adec190124..41c08f531dc934da925bf506d03a7d39bc854031 100644 (file)
--- a/doc/en/ref_algorithm_SamplingTest.rst
+++ b/doc/en/ref_algorithm_SamplingTest.rst
@@ -86,10 +86,11 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CostFunctionJ",
   "CostFunctionJb",
   "CostFunctionJo",
@@ -99,7 +100,7 @@ StoreSupplementaryCalculations
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CostFunctionJ", "SimulatedObservationAtCurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -113,6 +114,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/en/ref_algorithm_TabuSearch.rst b/doc/en/ref_algorithm_TabuSearch.rst
index 72f7bb9cd904e9a108cff7eea0f8c61a17ce389f..bff3ee913320f96dfa5d715e0ed1e64f0b8ca4ba 100644 (file)
--- a/doc/en/ref_algorithm_TabuSearch.rst
+++ b/doc/en/ref_algorithm_TabuSearch.rst
@@ -86,25 +86,27 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "BMA",
-  "OMA",
-  "OMB",
   "CurrentState",
   "CostFunctionJ",
   "CostFunctionJb",
   "CostFunctionJo",
   "Innovation",
+  "OMA",
+  "OMB",
   "SimulatedObservationAtBackground",
   "SimulatedObservationAtCurrentState",
   "SimulatedObservationAtOptimum",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -120,16 +122,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/en/ref_algorithm_TangentTest.rst b/doc/en/ref_algorithm_TangentTest.rst
index ff3f4d19ac8f9f993490c43de0461c8af81f4d5a..6269d3864d93c75e09bd39c80305eeb5293ff57a 100644 (file)
--- a/doc/en/ref_algorithm_TangentTest.rst
+++ b/doc/en/ref_algorithm_TangentTest.rst
@@ -74,17 +74,18 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
   "CurrentState",
   "Residu",
   "SimulatedObservationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -96,6 +97,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentState.rst
 
+.. include:: snippets/Residu.rst
+
 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 
 .. ------------------------------------ ..

diff --git a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst
index 3c4890705a74434b95c67885d4a1eb3f2bf00a4d..f84ab52ea9bbc84d10a5b6d38a431f6e6f9b8e05 100644 (file)
--- a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst
+++ b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst
@@ -78,10 +78,12 @@ StoreSupplementaryCalculations
   .. index:: single: StoreSupplementaryCalculations
 
   This list indicates the names of the supplementary variables that can be
-  available at the end of the algorithm. It involves potentially costly
-  calculations or memory consumptions. The default is a void list, none of
-  these variables being calculated and stored by default. The possible names
-  are in the following list: [
+  available at the end of the algorithm, if they are initially required by the
+  user. It involves potentially costly calculations or memory consumptions. The
+  default is a void list, none of these variables being calculated and stored
+  by default excepted the unconditionnal variables. The possible names are in
+  the following list: [
+  "Analysis",
   "APosterioriCorrelations",
   "APosterioriCovariance",
   "APosterioriStandardDeviations",
@@ -91,11 +93,11 @@ StoreSupplementaryCalculations
   "CostFunctionJb",
   "CostFunctionJo",
   "CurrentState",
-  "Innovation",
+  "InnovationAtCurrentState",
   ].
 
   Example :
-  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo04.rst
@@ -105,6 +107,8 @@ StoreSupplementaryCalculations
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo05.rst
 
+.. include:: snippets/Analysis.rst
+
 .. include:: snippets/APosterioriCorrelations.rst
 
 .. include:: snippets/APosterioriCovariance.rst
@@ -123,7 +127,7 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CurrentState.rst
 
-.. include:: snippets/Innovation.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo06.rst

diff --git a/doc/en/snippets/Header2Algo04.rst b/doc/en/snippets/Header2Algo04.rst
index 08bb3fa4504f50704b872a63ce4c87a1209d572c..d778b79496a3a89b4e710e99eaa68b8f6122a2aa 100644 (file)
--- a/doc/en/snippets/Header2Algo04.rst
+++ b/doc/en/snippets/Header2Algo04.rst
@@ -9,4 +9,6 @@ interface, or of the case in textual interface. The input variables, available
 to the user at the output in order to facilitate the writing of post-processing
 procedures, are described in the :ref:`subsection_r_o_v_Inventaire`.
 
+**Permanent outputs (non conditional)**
+
 The unconditional outputs of the algorithm are the following:

diff --git a/doc/en/snippets/Header2Algo05.rst b/doc/en/snippets/Header2Algo05.rst
index ed4d26541b4c7770bf61604c9457a049b3762722..4fd85cf505ab02338684b6fad3854c99e3f061ab 100644 (file)
--- a/doc/en/snippets/Header2Algo05.rst
+++ b/doc/en/snippets/Header2Algo05.rst
@@ -1 +1,4 @@
-The conditional outputs of the algorithm are the following:
+**Set of on-demand outputs (conditional or not)**
+
+The whole set of algorithm outputs (conditional or not), sorted by
+alphabetical order, is the following:

diff --git a/doc/en/snippets/PredictedState.rst b/doc/en/snippets/PredictedState.rst
new file mode 100644 (file)
index 0000000..af3b8dd
--- /dev/null
+++ b/doc/en/snippets/PredictedState.rst
@@ -0,0 +1,8 @@
+.. index:: single: PredictedState
+
+PredictedState
+  *List of vectors*. Each element is a state vector predicted by the model
+  during the iterative algorithm procedure.
+
+  Example:
+  ``Xp = ADD.get("PredictedState")[:]``