From: Jean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Date: Sun, 13 Feb 2022 17:06:25 +0000 (+0100)
Subject: Minor documentation and code review corrections (22)
X-Git-Tag: V9_9_0a2~13
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=c5e947560a24d1ea5bdafe06181db19a76822577;p=modules%2Fadao.git

Minor documentation and code review corrections (22)
---

diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst
index 38de01f..c8484f8 100644
--- 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 2e26be2..cf8de36 100644
--- 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
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 272c909..359baf5 100644
--- 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 facee3c..0f6ceb6 100644
--- 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
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]``