Minor documentation and code review corrections (22)

diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst
index 38de01f56e4dcf9504c9707280736de1d841cc23..c8484f8b50fe736a34d4d56465f3ec215328ecb0 100644 (file)
--- a/doc/en/ref_algorithm_KalmanFilter.rst
+++ b/doc/en/ref_algorithm_KalmanFilter.rst
@@ -109,9 +109,9 @@ StoreSupplementaryCalculations
   "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
-  "CurrentIterationNumber",
   "CurrentOptimum",
   "CurrentState",
+  "CurrentStepNumber",
   "ForecastCovariance",
   "ForecastState",
   "IndexOfOptimum",
@@ -157,12 +157,12 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-.. include:: snippets/CurrentIterationNumber.rst
-
 .. include:: snippets/CurrentOptimum.rst
 
 .. include:: snippets/CurrentState.rst
 
+.. include:: snippets/CurrentStepNumber.rst
+
 .. include:: snippets/ForecastCovariance.rst
 
 .. include:: snippets/ForecastState.rst

diff --git a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst
index 2e26be26062bad6bde6e5efa26f69c1dd369bb35..cf8de36f27ca0ab4d51456f28b6037a50d2661f1 100644 (file)
--- a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst
+++ b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst
@@ -114,7 +114,6 @@ StoreSupplementaryCalculations
   "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
-  "CurrentIterationNumber",
   "CurrentOptimum",
   "CurrentState",
   "ForecastCovariance",
@@ -164,8 +163,6 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-.. include:: snippets/CurrentIterationNumber.rst
-
 .. include:: snippets/CurrentOptimum.rst
 
 .. include:: snippets/CurrentState.rst

diff --git a/doc/en/snippets/CurrentStepNumber.rst b/doc/en/snippets/CurrentStepNumber.rst
new file mode 100644 (file)
index 0000000..9896f05
--- /dev/null
+++ b/doc/en/snippets/CurrentStepNumber.rst
@@ -0,0 +1,10 @@
+.. index:: single: CurrentStepNumber
+
+CurrentStepNumber
+  *List of integers*. Each element is the index of the current step in the
+  iterative process, driven by the series of observations, of the algorithm
+  used. Note: it is not the index of the current iteration of the algorithm
+  even if it coincides for non-iterative algorithms.
+
+  Example:
+  ``i = ADD.get("CurrentStepNumber")[-1]``

diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst
index 272c9097f87e5a55d9abb956fba3db44747f2cda..359baf5cd8a793bd89b26d9e59190ab70f7a99f8 100644 (file)
--- a/doc/fr/ref_algorithm_KalmanFilter.rst
+++ b/doc/fr/ref_algorithm_KalmanFilter.rst
@@ -109,9 +109,9 @@ StoreSupplementaryCalculations
   "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
-  "CurrentIterationNumber",
   "CurrentOptimum",
   "CurrentState",
+  "CurrentStepNumber",
   "ForecastCovariance",
   "ForecastState",
   "IndexOfOptimum",
@@ -157,12 +157,12 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-.. include:: snippets/CurrentIterationNumber.rst
-
 .. include:: snippets/CurrentOptimum.rst
 
 .. include:: snippets/CurrentState.rst
 
+.. include:: snippets/CurrentStepNumber.rst
+
 .. include:: snippets/ForecastCovariance.rst
 
 .. include:: snippets/ForecastState.rst

diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
index facee3cdb26a49a879106a6a3376041dbafba095..0f6ceb6ee12c075e73563042fad5d6b4aa7e2522 100644 (file)
--- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
+++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst
@@ -115,7 +115,6 @@ StoreSupplementaryCalculations
   "CostFunctionJbAtCurrentOptimum",
   "CostFunctionJo",
   "CostFunctionJoAtCurrentOptimum",
-  "CurrentIterationNumber",
   "CurrentOptimum",
   "CurrentState",
   "ForecastCovariance",
@@ -165,8 +164,6 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-.. include:: snippets/CurrentIterationNumber.rst
-
 .. include:: snippets/CurrentOptimum.rst
 
 .. include:: snippets/CurrentState.rst

diff --git a/doc/fr/snippets/CurrentStepNumber.rst b/doc/fr/snippets/CurrentStepNumber.rst
new file mode 100644 (file)
index 0000000..033ad41
--- /dev/null
+++ b/doc/fr/snippets/CurrentStepNumber.rst
@@ -0,0 +1,10 @@
+.. index:: single: CurrentStepNumber
+
+CurrentStepNumber
+  *Liste d'entiers*. Chaque élément est l'index du pas courant au cours du
+  déroulement itératif, piloté par la série des observations, de l'algorithme
+  utilisé. Remarque : ce n'est pas l'index d'itération courant d'algorithme
+  même si cela coïncide pour des algorithmes non itératifs.
+
+  Exemple :
+  ``i = ADD.get("CurrentStepNumber")[-1]``