From: Jean-Philippe ARGAUD Date: Sun, 24 Mar 2019 15:02:28 +0000 (+0100) Subject: Updating documentation by systematic review: EN part X-Git-Tag: V9_3_0rc2~14 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=8d6e587441ba144c55a8250e2e9b8637dfaeea62;p=modules%2Fadao.git Updating documentation by systematic review: EN part --- diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst index 28cbe2d..e4364e7 100644 --- 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 d12a2dd..b838cc0 100644 --- 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 03763b9..5aec283 100644 --- 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 e379ef1..be0d7ff 100644 --- 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 2c970db..1b75538 100644 --- 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 235aa1c..470d446 100644 --- 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 c15d62c..77e95ff 100644 --- 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 c6010f0..0497cfa 100644 --- 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 aa461d5..988e1cf 100644 --- 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 836c313..2a082a7 100644 --- 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 1d83930..2542a08 100644 --- 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 ba6821e..f70147b 100644 --- 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 7001556..7c52db1 100644 --- 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 6ddd05c..07251b0 100644 --- 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 c9bff17..753c01b 100644 --- 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 2186dce..d1992c9 100644 --- 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 07e90d9..51e065f 100644 --- 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 25141f6..e777084 100644 --- 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 6949aad..07f016a 100644 --- 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 7103f0a..41c08f5 100644 --- 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 72f7bb9..bff3ee9 100644 --- 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 ff3f4d1..6269d38 100644 --- 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 3c48907..f84ab52 100644 --- 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 08bb3fa..d778b79 100644 --- 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 ed4d265..4fd85cf 100644 --- 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 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")[:]``