StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
].
ResiduFormula
.. index:: single: ResiduFormula
- This key indicates the residue formula that has to be used for the test. The
- default choice is "Taylor", and the possible ones are "Taylor" (normalized
- residue of the Taylor development of the operator, which has to decrease
- with the square power of the perturbation), "TaylorOnNorm" (residue of the
- Taylor development of the operator with respect to the perturbation to the
- square, which has to remain constant) and "Norm" (residue obtained by taking
- the norm of the Taylor development at zero order approximation, which
- approximate the gradient, and which has to remain constant).
+ *Predefined name*. This key indicates the residue formula that has to be
+ used for the test. The default choice is "Taylor", and the possible ones are
+ "Taylor" (normalized residue of the Taylor development of the operator, which
+ has to decrease with the square power of the perturbation), "TaylorOnNorm"
+ (residue of the Taylor development of the operator with respect to the
+ perturbation to the square, which has to remain constant) and "Norm" (residue
+ obtained by taking the norm of the Taylor development at zero order
+ approximation, which approximate the gradient, and which has to remain
+ constant).
Example :
``{"ResiduFormula":"Taylor"}``
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
ResiduFormula
.. index:: single: ResiduFormula
- This key indicates the residue formula that has to be used for the test. The
- default choice is "CenteredDL", and the possible ones are "CenteredDL"
- (residue of the difference between the function at nominal point and the
- values with positive and negative increments, which has to stay very small),
- "Taylor" (residue of the Taylor development of the operator normalized by
- the nominal value, which has to stay very small), "NominalTaylor" (residue
- of the order 1 approximations of the operator, normalized to the nominal
- point, which has to stay close to 1), and "NominalTaylorRMS" (residue of the
- order 1 approximations of the operator, normalized by RMS to the nominal
- point, which has to stay close to 0).
+ *Predefined name*. This key indicates the residue formula that has to be
+ used for the test. The default choice is "CenteredDL", and the possible ones
+ are "CenteredDL" (residue of the difference between the function at nominal
+ point and the values with positive and negative increments, which has to stay
+ very small), "Taylor" (residue of the Taylor development of the operator
+ normalized by the nominal value, which has to stay very small),
+ "NominalTaylor" (residue of the order 1 approximations of the operator,
+ normalized to the nominal point, which has to stay close to 1), and
+ "NominalTaylorRMS" (residue of the order 1 approximations of the operator,
+ normalized by RMS to the nominal point, which has to stay close to 0).
Example :
``{"ResiduFormula":"CenteredDL"}``
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
].
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- This list indicates the names of the supplementary variables that can be
- 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: [
+ *List of names*. This list indicates the names of the supplementary variables
+ that can be available during or 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",
.. index:: single: Reconditioner
Alpha, Beta, Kappa, Reconditioner
- These keys are internal scaling parameters. "Alpha" requires a value between
- 1.e-4 and 1. "Beta" has an optimal value of 2 for Gaussian *a priori*
- distribution. "Kappa" requires an integer value, and the right default is
- obtained by setting it to 0. "Reconditioner" requires a value between 1.e-3
- and 10, it defaults to 1.
+ *Real or integer values*. These keys are internal scaling parameters. "Alpha"
+ requires a value between 1.e-4 and 1. "Beta" has an optimal value of 2 for
+ Gaussian *a priori* distribution. "Kappa" requires an integer value, and the
+ right default is obtained by setting it to 0. "Reconditioner" requires a
+ value between 1.e-3 and 10, it defaults to 1.
Example :
``{"Alpha":1,"Beta":2,"Kappa":0,"Reconditioner":1}``
.. index:: single: AmplitudeOfInitialDirection
AmplitudeOfInitialDirection
- This key indicates the scaling of the initial perturbation build as a vector
- used for the directional derivative around the nominal checking point. The
- default is 1, that means no scaling.
+ *Real value*. This key indicates the scaling of the initial perturbation
+ build as a vector used for the directional derivative around the nominal
+ checking point. The default is 1, that means no scaling.
Example:
``{"AmplitudeOfInitialDirection":0.5}``
.. index:: single: Bounds
Bounds
- This key allows to define upper and lower bounds for every state variable
- being optimized. Bounds have to be given by a list of list of pairs of
- lower/upper bounds for each variable, with extreme values every time there
- is no bound (``None`` is not allowed when there is no bound).
+ *List of pairs of real values*. This key allows to define upper and lower
+ bounds for every state variable being optimized. Bounds have to be given by a
+ list of list of pairs of lower/upper bounds for each variable, with extreme
+ values every time there is no bound (``None`` is not allowed when there is no
+ bound).
Example:
``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,1.e99],[-1.e99,1.e99]]}``
.. index:: single: Bounds
Bounds
- This key allows to define upper and lower bounds for every state variable
- being optimized. Bounds have to be given by a list of list of pairs of
- lower/upper bounds for each variable, with possibly ``None`` every time
- there is no bound. The bounds can always be specified, but they are taken
- into account only by the constrained optimizers.
+ *List of pairs of real values*. This key allows to define upper and lower
+ bounds for every state variable being optimized. Bounds have to be given by a
+ list of list of pairs of lower/upper bounds for each variable, with possibly
+ ``None`` every time there is no bound. The bounds can always be specified,
+ but they are taken into account only by the constrained optimizers.
Example:
``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,None],[None,None]]}``
.. index:: single: ConstrainedBy
ConstrainedBy
- This key allows to choose the method to take into account the bounds
- constraints. The only one available is the "EstimateProjection", which
- projects the current state estimate on the bounds constraints.
+ *Predefined name*. This key allows to choose the method to take into account
+ the bounds constraints. The only one available is the "EstimateProjection",
+ which projects the current state estimate on the bounds constraints.
Example:
``{"ConstrainedBy":"EstimateProjection"}``
.. index:: single: CostDecrementTolerance
CostDecrementTolerance
- This key indicates a limit value, leading to stop successfully the
- iterative optimization process when the cost function decreases less than
- this tolerance at the last step. The default is 1.e-7, and it is
- recommended to adapt it to the needs on real problems.
+ *Real value*. This key indicates a limit value, leading to stop successfully
+ the iterative optimization process when the cost function decreases less than
+ this tolerance at the last step. The default is 1.e-7, and it is recommended
+ to adapt it to the needs on real problems.
Example:
``{"CostDecrementTolerance":1.e-7}``
.. index:: single: CostDecrementTolerance
CostDecrementTolerance
- This key indicates a limit value, leading to stop successfully the
- iterative optimization process when the cost function decreases less than
- this tolerance at the last step. The default is 1.e-6, and it is
- recommended to adapt it to the needs on real problems.
+ *Real value*. This key indicates a limit value, leading to stop successfully
+ the iterative optimization process when the cost function decreases less than
+ this tolerance at the last step. The default is 1.e-6, and it is recommended
+ to adapt it to the needs on real problems.
Example:
``{"CostDecrementTolerance":1.e-6}``
.. index:: single: CrossOverProbability_CR
CrossOverProbability_CR
- This key is used to define the probability of recombination or crossover
- during the differential evolution. This variable is usually noted as ``CR``
- in the literature, and it is required to be between 0 and 1. The default
- value is 0.7, and it is recommended to change it if necessary.
+ *Real value*. This key is used to define the probability of recombination or
+ crossover during the differential evolution. This variable is usually noted
+ as ``CR`` in the literature, and it is required to be between 0 and 1. The
+ default value is 0.7, and it is recommended to change it if necessary.
Example:
``{"CrossOverProbability_CR":0.7}``
.. index:: single: CurrentOptimum
CurrentOptimum
- *List of vectors*. Each element is the optimal state obtained at the current
- step of the optimization algorithm. It is not necessarily the last state.
+ *List of vectors*. Each element is the optimal state obtained at the usual
+ step of the iterative algorithm procedure of the optimization algorithm. It
+ is not necessarily the last state.
Example:
``Xo = ADD.get("CurrentOptimum")[:]``
.. index:: single: Dict
**Dict**
- This indicates a variable that has to be filled by a Python dictionary
- ``{"key":"value...}``.
+ *Dictionary*. This indicates a variable that has to be filled by a Python
+ dictionary ``{"key":"value...}``.
.. index:: single: Function
**Function**
- This indicates a variable that must be given as a function in the Python
- sense.. The functions are special entries described by the
+ *Function*. This indicates a variable that must be given as a function in
+ the Python sense.. The functions are special entries described by the
:ref:`section_ref_operator_requirements`.
.. index:: single: Matrix
**Matrix**
- This indicates a variable that has to be filled by a matrix. The
+ *Matrix*. This indicates a variable that has to be filled by a matrix. The
matrices are special entries described by the
:ref:`section_ref_covariance_requirements`.
.. index:: single: Script
**Script**
- This indicates a script given as an external file. It can be described by a
- full absolute path name or only by the file name without path. If the file
- is given only by a file name without path, and if a study directory is also
- indicated, the file is searched in the given study directory.
+ *File name*. This indicates a script given as an external file. It can be
+ described by a full absolute path name or only by the file name without
+ path. If the file is given only by a file name without path, and if a study
+ directory is also indicated, the file is searched in the given study
+ directory.
.. index:: single: String
**String**
- This indicates a string giving a literal representation of a matrix, a
- vector or a vector series, such as "1 2 ; 3 4" or "[[1,2],[3,4]]" for a
- square 2x2 matrix.
+ *String*. This indicates a string giving a literal representation of a
+ matrix, a vector or a vector series, such as "1 2 ; 3 4" or "[[1,2],[3,4]]"
+ for a square 2x2 matrix.
.. index:: single: Vector
**Vector**
- This indicates a variable that has to be filled as a vector. It is a simple
- ordered collection of real numbers. The vectors can be described in row or
- column version without making any difference.
+ *List of real values*. This indicates a variable that has to be filled as a
+ vector. It is a simple ordered collection of real numbers. The vectors can
+ be described in row or column version without making any difference.
.. index:: single: VectorSerie
**VectorSerie**
- This indicates a variable that has to be filled in as a list of vectors. It
- is an ordered collection of vectors.
+ *List of list of real values*. This indicates a variable that has to be
+ filled in as a list of vectors. It is an ordered collection of vectors.
.. index:: single: EpsilonMinimumExponent
EpsilonMinimumExponent
- This key indicates the minimal exponent value of the power of 10 coefficient
- to be used to decrease the increment multiplier. The default is -8, and it
- has to be between 0 and -20. For example, its default value leads to
- calculate the residue of the scalar product formula with a fixed increment
- multiplied from 1.e0 to 1.e-8.
+ *Integer value*. This key indicates the minimal exponent value of the power
+ of 10 coefficient to be used to decrease the increment multiplier. The
+ default is -8, and it has to be negative between 0 and -20. For example, its
+ default value leads to calculate the residue of the scalar product formula
+ with a fixed increment multiplied from 1.e0 to 1.e-8.
Example:
``{"EpsilonMinimumExponent":-12}``
.. index:: single: EstimationOf
EstimationOf
- This key allows to choose the type of estimation to be performed. It can be
- either state-estimation, with a value of "State", or parameter-estimation,
- with a value of "Parameters". The default choice is "State".
+ *Predefined name*. This key allows to choose the type of estimation to be
+ performed. It can be either state-estimation, with a value of "State", or
+ parameter-estimation, with a value of "Parameters". The default choice is
+ "State".
Example:
``{"EstimationOf":"Parameters"}``
.. index:: single: GradientNormTolerance
GradientNormTolerance
- This key indicates a limit value, leading to stop successfully the
- iterative optimization process when the norm of the gradient is under this
- limit. It is only used for non-constrained optimizers. The default is
+ *Real value*. This key indicates a limit value, leading to stop successfully
+ the iterative optimization process when the norm of the gradient is under
+ this limit. It is only used for non-constrained optimizers. The default is
1.e-5 and it is not recommended to change it.
Example:
IndexOfOptimum
*List of integers*. Each element is the iteration index of the optimum
- obtained at the current step the optimization algorithm. It is not
- necessarily the number of the last iteration.
+ obtained at the current step of the iterative algorithm procedure of the
+ optimization algorithm. It is not necessarily the number of the last
+ iteration.
Example:
``i = ADD.get("IndexOfOptimum")[-1]``
.. index:: single: InitialDirection
InitialDirection
- This key indicates the vector direction used for the directional derivative
- around the nominal checking point. It has to be a vector. If not specified,
- this direction defaults to a random perturbation around zero of the same
- vector size than the checking point.
+ *Vector*. This key indicates the vector direction used for the directional
+ derivative around the nominal checking point. It has to be a vector of the
+ same vector size than the checking point. If not specified, this direction
+ defaults to a random perturbation around zero of the same vector size than
+ the checking point.
Example:
- ``{"InitialDirection":[0.1,0.1,100.,3}``
+ ``{"InitialDirection":[0.1,0.1,100.,3}`` for a state space of dimension 4
.. index:: single: LengthOfTabuList
LengthOfTabuList
- This key indicates the length of the tabu list, that is the maximum number of
- previously executed perturbations and kept for the record. The default is 50,
- and it is recommended to adapt it to the needs on real problems.
+ *Integer value*. This key indicates the length of the tabu list, that is the
+ maximum number of previously executed perturbations and kept for the record.
+ The default is 50, and it is recommended to adapt it to the needs on real
+ problems.
Example :
``{"LengthOfTabuList":50}``
.. index:: single: MaximumNumberOfFunctionEvaluations
MaximumNumberOfFunctionEvaluations
- This key indicates the maximum number of evaluation of the cost function to
- be optimized. The default is 15000, which is an arbitrary limit. It is then
- recommended to adapt this parameter to the needs on real problems. For some
- optimizers, the effective number of function evaluations can be slightly
- different of the limit due to algorithm internal control requirements.
+ *Integer value*. This key indicates the maximum number of evaluation of the
+ cost function to be optimized. The default is 15000, which is an arbitrary
+ limit. It is then recommended to adapt this parameter to the needs on real
+ problems. For some optimizers, the effective number of function evaluations
+ can be slightly different of the limit due to algorithm internal control
+ requirements.
Example:
``{"MaximumNumberOfFunctionEvaluations":50}``
.. index:: single: MaximumNumberOfSteps
MaximumNumberOfSteps
- This key indicates the maximum number of iterations allowed for iterative
- optimization. The default is 15000, which is very similar to no limit on
- iterations. It is then recommended to adapt this parameter to the needs on
- real problems. For some optimizers, the effective stopping step can be
- slightly different of the limit due to algorithm internal control
+ *Integer value*. This key indicates the maximum number of iterations allowed
+ for iterative optimization. The default is 15000, which is very similar to no
+ limit on iterations. It is then recommended to adapt this parameter to the
+ needs on real problems. For some optimizers, the effective stopping step can
+ be slightly different of the limit due to algorithm internal control
requirements.
Example:
.. index:: single: MaximumNumberOfSteps
MaximumNumberOfSteps
- This key indicates the maximum number of iterations allowed for iterative
- optimization. The default is 50, which is an arbitrary limit. It is then
- recommended to adapt this parameter to the needs on real problems.
+ *Integer value*. This key indicates the maximum number of iterations allowed
+ for iterative optimization. The default is 50, which is an arbitrary limit.
+ It is then recommended to adapt this parameter to the needs on real problems.
Example:
``{"MaximumNumberOfSteps":50}``
.. index:: single: Minimizer
Minimizer
- This key allows to choose the optimization strategy for the minimizer. The
- default choice is "BEST1BIN", and the possible ones, among the multiples
- crossover and mutation strategies, are
+ *Predefined name*. This key allows to choose the optimization strategy for
+ the minimizer. The default choice is "BEST1BIN", and the possible ones, among
+ the multiples crossover and mutation strategies, are
"BEST1BIN",
"BEST1EXP",
"RAND1EXP",
.. index:: single: Minimizer
Minimizer
- This key allows to choose the optimization minimizer. The default choice is
- "BOBYQA", and the possible ones are
+ *Predefined name*. This key allows to choose the optimization minimizer. The
+ default choice is "BOBYQA", and the possible ones are
"BOBYQA" (minimization with or without constraints by quadratic approximation [Powell09]_),
"COBYLA" (minimization with or without constraints by linear approximation [Powell94]_ [Powell98]_).
"NEWUOA" (minimization with or without constraints by iterative quadratic approximation [Powell04]_),
"SUBPLEX" (minimization with or without constraints using Nelder-Mead on a sequence of subspaces [Rowan90]_).
Remark: the "POWELL" method perform a dual outer/inner loops optimization,
leading then to less control on the cost function evaluation number because
- it is the outer loop limit than is controlled. If precise control on this
- cost function evaluation number is required, choose an another minimizer.
+ it is the outer loop limit than is controlled. If precise control on the
+ evaluation number is required, choose an another minimizer.
Example:
``{"Minimizer":"BOBYQA"}``
.. index:: single: MutationDifferentialWeight_F
MutationDifferentialWeight_F
- This key is used to define the differential weight in the mutation step.
- This variable is usually noted as ``F`` in the literature. It can be constant
- if it is in the form of a single value, or randomly variable in the two given
- bounds in the pair. The default value is (0.5, 1).
+ *Pair of real values*. This key is used to define the differential weight in
+ the mutation step. This variable is usually noted as ``F`` in the literature.
+ It can be constant if it is in the form of a single value, or randomly
+ variable in the two given bounds in the pair. The default value is (0.5, 1).
Example:
``{"MutationDifferentialWeight_F":(0.5, 1)}``
.. index:: single: NoiseAddingProbability
NoiseAddingProbability
- This key indicates the probability of perturbing a state component. It is a
- mandatory value between 0 and 1. The default is 1, and it is not recommended
- to change it.
+ *Real value*. This key indicates the probability of perturbing a state
+ component. It is a mandatory value between 0 and 1. The default is 1, and it
+ is not recommended to change it.
Example :
``{"NoiseAddingProbability":1.}``
.. index:: single: NoiseDistribution
NoiseDistribution
- This key indicates the type of the distribution used to generate the state
- perturbations. This distribution can be of "Uniform" or "Gaussian" type. The
- default is a distribution of "Uniform" type, and it is recommended to adapt
- it to the needs on real problems.
+ *Predefined name*. This key indicates the type of the distribution used to
+ generate the state perturbations. This distribution can be of "Uniform" or
+ "Gaussian" type. The default is a distribution of "Uniform" type, and it is
+ recommended to adapt it to the needs on real problems.
Example :
``{"NoiseDistribution":"Uniform"}``
.. index:: single: NoiseHalfRange
NoiseHalfRange
- This key indicates,, only in the case of a "Uniform" distribution type asked
- through the keyword "*NoiseDistribution*", the half-amplitude of the uniform
- state centred perturbations for each component of the state. The default is
- an empty list, this key must therefore be filled in in the case of a
- "Uniform" distribution. A simple way to do this is to give a list of the
- length of the desired state with identical half-amplitudes, as in the example
- below with half-amplitudes of 3%. It is recommended to take half-amplitudes
- of a few percent maximum.
+ *List of real values*. This key indicates,, only in the case of a "Uniform"
+ distribution type asked through the keyword "*NoiseDistribution*", the
+ half-amplitude of the uniform state centred perturbations for each component
+ of the state. The default is an empty list, this key must therefore be filled
+ in in the case of a "Uniform" distribution. A simple way to do this is to
+ give a list of the length of the desired state with identical
+ half-amplitudes, as in the example below with half-amplitudes of 3%. It is
+ recommended to take half-amplitudes of a few percent maximum.
Example :
- ``{"NoiseHalfRange":<longueur de l'état>*[0.03]}``
+ ``{"NoiseHalfRange":<state length>*[0.03]}``
.. index:: single: NumberOfElementaryPerturbations
NumberOfElementaryPerturbations
- This key indicates the number of elementary perturbations that will be
- performed to select a complete state perturbation. The default is 1, and it
- is recommended to adapt it carefully to the needs of real problems, without
- choosing too many elementary perturbations.
+ *Integer value*. This key indicates the number of elementary perturbations
+ that will be performed to select a complete state perturbation. The default
+ is 1, and it is recommended to adapt it carefully to the needs of real
+ problems, without choosing too many elementary perturbations.
Example :
``{"NumberOfElementaryPerturbations":1}``
.. index:: single: NumberOfMembers
NumberOfMembers
- This key indicates the number of members used to realize the ensemble method.
- The default is 100, and it is recommended to adapt it to the needs on real
- problems.
+ *Integer value*. This key indicates the number of members used to realize the
+ ensemble method. The default is 100, and it is recommended to adapt it to the
+ needs on real problems.
Example:
``{"NumberOfMembers":100}``
.. index:: single: NumberOfPrintedDigits
NumberOfPrintedDigits
- This key indicates the number of digits of precision for floating point
- printed output. The default is 5, with a minimum of 0.
+ *Integer value*. This key indicates the number of digits of precision for
+ floating point printed output. The default is 5, with a minimum of 0.
Example:
``{"NumberOfPrintedDigits":5}``
.. index:: single: NumberOfRepetition
NumberOfRepetition
- This key indicates the number of time to repeat the function evaluation. The
- default is 1.
+ *Integer value*. This key indicates the number of time to repeat the function
+ evaluation. The default is 1.
Example:
``{"NumberOfRepetition":3}``
.. index:: single: NumberOfSamplesForQuantiles
NumberOfSamplesForQuantiles
- This key indicates the number of simulation to be done in order to estimate
- the quantiles. This option is useful only if the supplementary calculation
- "SimulationQuantiles" has been chosen. The default is 100, which is often
- sufficient for correct estimation of common quantiles at 5%, 10%, 90% or
- 95%.
+ *Integer value*. This key indicates the number of simulation to be done in
+ order to estimate the quantiles. This option is useful only if the
+ supplementary calculation "SimulationQuantiles" has been chosen. The default
+ is 100, which is often sufficient for correct estimation of common quantiles
+ at 5%, 10%, 90% or 95%.
Example:
``{"NumberOfSamplesForQuantiles":100}``
.. index:: single: PopulationSize
PopulationSize
- This key is used to define the (approximate) size of the population at each
- generation. This size is slightly adjusted to take into account the number of
- state variables to be optimized. The default value is 100, and it is
- recommended to choose a population between 1 and about ten times the number
- of state variables, the size being smaller as the number of variables
- increases.
+ *Integer value*. This key is used to define the (approximate) size of the
+ population at each generation. This size is slightly adjusted to take into
+ account the number of state variables to be optimized. The default value is
+ 100, and it is recommended to choose a population between 1 and about ten
+ times the number of state variables, the size being smaller as the number of
+ variables increases.
Example:
``{"PopulationSize":100}``
.. index:: single: PrintAllValuesFor
PrintAllValuesFor
- This key indicates the list of vector names whose detailed values are to be
- printed, the default value being the empty list. If the named vector is not a
- supplied entry, the name is simply ignored. The possible names are in the
- following list: [
+ *List of predefined names*. This key indicates the list of vector names whose
+ detailed values are to be printed, the default value being the empty list. If
+ the named vector is not a supplied entry, the name is simply ignored. The
+ possible names are in the following list: [
"Background",
"CheckingPoint",
"Observation",
.. index:: single: ProjectedGradientTolerance
ProjectedGradientTolerance
- This key indicates a limit value, leading to stop successfully the iterative
- optimization process when all the components of the projected gradient are
- under this limit. It is only used for constrained optimizers. The default is
- -1, that is the internal default of each minimizer (generally 1.e-5), and it
- is not recommended to change it.
+ *Real value*. This key indicates a limit value, leading to stop successfully
+ the iterative optimization process when all the components of the projected
+ gradient are under this limit. It is only used for constrained optimizers.
+ The default is -1, that is the internal default of each minimizer (generally
+ 1.e-5), and it is not recommended to change it.
Example:
``{"ProjectedGradientTolerance":-1}``
.. index:: single: QualityCriterion
QualityCriterion
- This key indicates the quality criterion, minimized to find the optimal state
- estimate. The default is the usual data assimilation criterion named "DA",
- the augmented weighted least squares. The possible criteria has to be in the
- following list, where the equivalent names are indicated by the sign "<=>":
+ *Predefined name*. This key indicates the quality criterion, minimized to
+ find the optimal state estimate. The default is the usual data assimilation
+ criterion named "DA", the augmented weighted least squares. The possible
+ criteria has to be in the following list, where the equivalent names are
+ indicated by the sign "<=>":
["AugmentedWeightedLeastSquares"<=>"AWLS"<=>"DA",
"WeightedLeastSquares"<=>"WLS", "LeastSquares"<=>"LS"<=>"L2",
"AbsoluteValue"<=>"L1", "MaximumError"<=>"ME"].
.. index:: single: Quantile
Quantile
- This key allows to define the real value of the desired quantile, between
- 0 and 1. The default is 0.5, corresponding to the median.
+ *Real value*. This key allows to define the real value of the desired
+ quantile, between 0 and 1. The default is 0.5, corresponding to the median.
Example:
``{"Quantile":0.5}``
.. index:: single: Quantiles
Quantiles
- This list indicates the values of quantile, between 0 and 1, to be estimated
- by simulation around the optimal state. The sampling uses a multivariate
- Gaussian random sampling, directed by the *a posteriori* covariance matrix.
- This option is useful only if the supplementary calculation
- "SimulationQuantiles" has been chosen. The default is a void list.
+ *List of real values*. This list indicates the values of quantile, between 0
+ and 1, to be estimated by simulation around the optimal state. The sampling
+ uses a multivariate Gaussian random sampling, directed by the *a posteriori*
+ covariance matrix. This option is useful only if the supplementary
+ calculation "SimulationQuantiles" has been chosen. The default is a void
+ list.
Example:
``{"Quantiles":[0.1,0.9]}``
.. index:: single: SampleAsExplicitHyperCube
SampleAsExplicitHyperCube
- This key describes the calculations points as an hyper-cube, from a given
- list of explicit sampling of each variable as a list. That is then a list of
- lists, each of them being potentially of different size.
+ *List of list of real values*. This key describes the calculations points as
+ an hyper-cube, from a given list of explicit sampling of each variable as a
+ list. That is then a list of lists, each of them being potentially of
+ different size.
Example : ``{"SampleAsExplicitHyperCube":[[0.,0.25,0.5,0.75,1.], [-2,2,1]]}`` for a state space of dimension 2
.. index:: single: SampleAsIndependantRandomVariables
SampleAsIndependantRandomVariables
- This key describes the calculations points as an hyper-cube, for which the
- points on each axis come from a independent random sampling of the axis
- variable, under the specification of the distribution, its parameters and
- the number of points in the sample, as a list ``['distribution',
- [parameters], number]`` for each axis. The possible distributions are
- 'normal' of parameters (mean,std), 'lognormal' of parameters (mean,sigma),
- 'uniform' of parameters (low,high), or 'weibull' of parameter (shape). That
- is then a list of the same size than the one of the state.
+ *List of triplets [Name, Parameters, Number]*. This key describes the
+ calculations points as an hyper-cube, for which the points on each axis come
+ from a independent random sampling of the axis variable, under the
+ specification of the distribution, its parameters and the number of points in
+ the sample, as a list ``['distribution', [parameters], number]`` for each
+ axis. The possible distributions are 'normal' of parameters (mean,std),
+ 'lognormal' of parameters (mean,sigma), 'uniform' of parameters (low,high),
+ or 'weibull' of parameter (shape). That is then a list of the same size than
+ the one of the state.
Example :
``{"SampleAsIndependantRandomVariables":[ ['normal',[0.,1.],3], ['uniform',[-2,2],4]]`` for a state space of dimension 2
.. index:: single: SampleAsMinMaxStepHyperCube
SampleAsMinMaxStepHyperCube
- This key describes the calculations points as an hyper-cube, from a given
- list of implicit sampling of each variable by a triplet *[min,max,step]*.
- That is then a list of the same size than the one of the state. The bounds
- are included.
+ *List of triplets of real values*. This key describes the calculations points
+ as an hyper-cube, from a given list of implicit sampling of each variable by
+ a triplet *[min,max,step]*. That is then a list of the same size than the one
+ of the state. The bounds are included.
Example :
``{"SampleAsMinMaxStepHyperCube":[[0.,1.,0.25],[-1,3,1]]}`` for a state space of dimension 2
.. index:: single: SampleAsnUplet
SampleAsnUplet
- This key describes the calculations points as a list of n-uplets, each
- n-uplet being a state.
+ *List of states*. This key describes the calculations points as a list of
+ n-uplets, each n-uplet being a state.
Example :
``{"SampleAsnUplet":[[0,1,2,3],[4,3,2,1],[-2,3,-4,5]]}`` for 3 points in a state space of dimension 4
.. index:: single: SetDebug
SetDebug
- This key requires the activation, or not, of the debug mode during the
- function or operator evaluation. The default is "False", the choices are
- "True" or "False".
+ *Boolean value*. This key requires the activation, or not, of the debug mode
+ during the function or operator evaluation. The default is "False", the
+ choices are "True" or "False".
Example:
``{"SetDebug":False}``
.. index:: single: SetSeed
SetSeed
- This key allow to give an integer in order to fix the seed of the random
- generator used in the algorithm. A simple convenient value is for example
- 1000. By default, the seed is left uninitialized, and so use the default
- initialization from the computer, which then change at each study. To ensure
- the reproducibility of results involving random samples, it is strongly
- advised to initialize the seed.
+ *Integer value*. This key allow to give an integer in order to fix the seed
+ of the random generator used in the algorithm. A simple convenient value is
+ for example 1000. By default, the seed is left uninitialized, and so use the
+ default initialization from the computer, which then change at each study. To
+ ensure the reproducibility of results involving random samples, it is
+ strongly advised to initialize the seed.
Example:
``{"SetSeed":1000}``
.. index:: single: ShowInformationOnlyFor
ShowInformationOnlyFor
- This key indicates the list of vector names whose summarized information
- (size, min/max...) is to be printed, the default value being the set of
- vectors. If the named vector is not a provided entry, the name is simply
- ignored. This allows you to restrict summarized printing. The possible names
- are in the following list: [
+ *List of predefined names*. This key indicates the list of vector names whose
+ summarized information (size, min/max...) is to be printed, the default value
+ being the set of vectors. If the named vector is not a provided entry, the
+ name is simply ignored. This allows you to restrict summarized printing. The
+ possible names are in the following list: [
"Background",
"CheckingPoint",
"Observation",
.. index:: single: SimulationForQuantiles
SimulationForQuantiles
- This key indicates the type of simulation, linear (with the tangent
- observation operator applied to perturbation increments around the optimal
- state) or non-linear (with standard observation operator applied to
- perturbed states), one want to do for each perturbation. It changes mainly
- the time of each elementary calculation, usually longer in non-linear than
- in linear. This option is useful only if the supplementary calculation
- "SimulationQuantiles" has been chosen. The default value is "Linear", and
- the possible choices are "Linear" and "NonLinear".
+ *Predefined name*. This key indicates the type of simulation, linear (with
+ the tangent observation operator applied to perturbation increments around
+ the optimal state) or non-linear (with standard observation operator applied
+ to perturbed states), one want to do for each perturbation. It changes mainly
+ the time of each elementary calculation, usually longer in non-linear than in
+ linear. This option is useful only if the supplementary calculation
+ "SimulationQuantiles" has been chosen. The default value is "Linear", and the
+ possible choices are "Linear" and "NonLinear".
Example:
``{"SimulationForQuantiles":"Linear"}``
.. index:: single: StandardDeviation
StandardDeviation
- This key indicates, only in the case of a "Gaussian" distribution type asked
- through the keyword "*NoiseDistribution*", the standard deviation of the
- state Gaussian perturbations for each state component. The default is an
- empty list, this key must therefore be filled in in the case of a "Gaussian"
- distribution. A simple way to do this is to give a list of the length of the
- desired state with identical standard deviations, as in the example below
- with standard deviations of 5%. It is recommended to take standard deviations
- of a few percent maximum.
+ *List of real values*. This key indicates, only in the case of a "Gaussian"
+ distribution type asked through the keyword "*NoiseDistribution*", the
+ standard deviation of the state Gaussian perturbations for each state
+ component. The default is an empty list, this key must therefore be filled in
+ in the case of a "Gaussian" distribution. A simple way to do this is to give
+ a list of the length of the desired state with identical standard deviations,
+ as in the example below with standard deviations of 5%. It is recommended to
+ take standard deviations of a few percent maximum.
Example :
``{"StandardDeviation":<longueur de l'état>*[0.05]}``
.. index:: single: StateVariationTolerance
StateVariationTolerance
- This key indicates the maximum relative variation of the state for stopping
- by convergence on the state. The default is 1.e-4, and it is recommended to
- adapt it to the needs on real problems.
+ *Real value*. This key indicates the maximum relative variation of the state
+ for stopping by convergence on the state. The default is 1.e-4, and it is
+ recommended to adapt it to the needs on real problems.
Example:
``{"StateVariationTolerance":1.e-4}``
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"Residu",
"SimulatedObservationAtCurrentState",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"CurrentState",
"Innovation",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"SimulatedObservationAtCurrentState",
].
ResiduFormula
.. index:: single: ResiduFormula
- Cette clé indique la formule de résidu qui doit être utilisée pour le test.
- Le choix par défaut est "Taylor", et les choix possibles sont "Taylor"
- (résidu du développement de Taylor normalisé de l'opérateur, qui doit
- décroître comme le carré de la perturbation), "TaylorOnNorm" (résidu du
- développement de Taylor rapporté à la perturbation de l'opérateur, qui doit
- rester constant) et "Norm" (résidu obtenu en prenant la norme du
- développement de Taylor à l'ordre 0, qui approxime le gradient, et qui doit
- rester constant).
+ *Nom prédéfini*. Cette clé indique la formule de résidu qui doit être
+ utilisée pour le test. Le choix par défaut est "Taylor", et les choix
+ possibles sont "Taylor" (résidu du développement de Taylor normalisé de
+ l'opérateur, qui doit décroître comme le carré de la perturbation),
+ "TaylorOnNorm" (résidu du développement de Taylor rapporté à la perturbation
+ de l'opérateur, qui doit rester constant) et "Norm" (résidu obtenu en prenant
+ la norme du développement de Taylor à l'ordre 0, qui approxime le gradient,
+ et qui doit rester constant).
Exemple :
``{"ResiduFormula":"Taylor"}``
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"Residu",
"SimulatedObservationAtCurrentState",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"CostFunctionJ",
"CostFunctionJAtCurrentOptimum",
ResiduFormula
.. index:: single: ResiduFormula
- Cette clé indique la formule de résidu qui doit être utilisée pour le test.
- Le choix par défaut est "CenteredDL", et les choix possibles sont
- "CenteredDL" (résidu de la différence entre la fonction au point nominal et
- ses valeurs avec des incréments positif et négatif, qui doit rester très
- faible), "Taylor" (résidu du développement de Taylor de l'opérateur
- normalisé par sa valeur nominal, qui doit rester très faible),
+ *Nom prédéfini*. Cette clé indique la formule de résidu qui doit être
+ utilisée pour le test. Le choix par défaut est "CenteredDL", et les choix
+ possibles sont "CenteredDL" (résidu de la différence entre la fonction au
+ point nominal et ses valeurs avec des incréments positif et négatif, qui doit
+ rester très faible), "Taylor" (résidu du développement de Taylor de
+ l'opérateur normalisé par sa valeur nominal, qui doit rester très faible),
"NominalTaylor" (résidu de l'approximation à l'ordre 1 de l'opérateur,
normalisé au point nominal, qui doit rester proche de 1), et
"NominalTaylorRMS" (résidu de l'approximation à l'ordre 1 de l'opérateur,
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"Residu",
"SimulatedObservationAtCurrentState",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"JacobianMatrixAtCurrentState",
"SimulatedObservationAtCurrentState",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"SimulatedObservationAtCurrentState",
].
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CostFunctionJ",
"CostFunctionJb",
"CostFunctionJo",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"BMA",
"CostFunctionJ",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"CurrentState",
"Residu",
"SimulatedObservationAtCurrentState",
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
- Cette liste indique les noms des variables supplémentaires qui peuvent être
- disponibles à la fin de l'algorithme, si elles sont initialement demandées par
- l'utilisateur. Cela implique potentiellement des calculs ou du stockage
- coûteux. La valeur par défaut est une liste vide, aucune de ces variables
- n'étant calculée et stockée par défaut sauf les variables inconditionnelles.
- Les noms possibles sont dans la liste suivante : [
+ *Liste de noms*. Cette liste indique les noms des variables supplémentaires
+ qui peuvent être disponibles au cours du déroulement ou à la fin de
+ l'algorithme, si elles sont initialement demandées par l'utilisateur. Cela
+ implique potentiellement des calculs ou du stockage coûteux. La valeur par
+ défaut est une liste vide, aucune de ces variables n'étant calculée et
+ stockée par défaut sauf les variables inconditionnelles. Les noms possibles
+ sont dans la liste suivante : [
"Analysis",
"APosterioriCorrelations",
"APosterioriCovariance",
.. index:: single: Reconditioner
Alpha, Beta, Kappa, Reconditioner
- Ces clés sont des paramètres de mise à l'échelle interne. "Alpha" requiert
- une valeur comprise entre 1.e-4 et 1. "Beta" a une valeur optimale de 2 pour
- une distribution *a priori* gaussienne. "Kappa" requiert une valeur entière,
- dont la bonne valeur par défaut est obtenue en la mettant à 0.
- "Reconditioner" requiert une valeur comprise entre 1.e-3 et 10, son défaut
- étant 1.
+ *Valeurs réelles ou entières*. Ces clés sont des paramètres de mise à
+ l'échelle interne. "Alpha" requiert une valeur comprise entre 1.e-4 et 1.
+ "Beta" a une valeur optimale de 2 pour une distribution *a priori*
+ gaussienne. "Kappa" requiert une valeur entière, dont la bonne valeur par
+ défaut est obtenue en la mettant à 0. "Reconditioner" requiert une valeur
+ comprise entre 1.e-3 et 10, son défaut étant 1.
Exemple :
``{"Alpha":1,"Beta":2,"Kappa":0,"Reconditioner":1}``
.. index:: single: AmplitudeOfInitialDirection
AmplitudeOfInitialDirection
- Cette clé indique la mise à l'échelle de la perturbation initiale construite
- comme un vecteur utilisé pour la dérivée directionnelle autour du point
- nominal de vérification. La valeur par défaut est de 1, ce qui signifie qu'il
- n'y a aucune mise à l'échelle.
+ *Valeur réelle*. Cette clé indique la mise à l'échelle de la perturbation
+ initiale construite comme un vecteur utilisé pour la dérivée directionnelle
+ autour du point nominal de vérification. La valeur par défaut est de 1, ce
+ qui signifie qu'il n'y a aucune mise à l'échelle.
Exemple :
``{"AmplitudeOfInitialDirection":0.5}``
.. index:: single: Bounds
Bounds
- Cette clé permet de définir des bornes supérieure et inférieure pour chaque
- variable d'état optimisée. Les bornes doivent être données par une liste de
- liste de paires de bornes inférieure/supérieure pour chaque variable, avec
- une valeur extrême chaque fois qu'il n'y a pas de borne (``None`` n'est pas
- une valeur autorisée lorsqu'il n'y a pas de borne).
+ *Liste de paires de valeurs réelles*. Cette clé permet de définir des bornes
+ supérieure et inférieure pour chaque variable d'état optimisée. Les bornes
+ doivent être données par une liste de liste de paires de bornes
+ inférieure/supérieure pour chaque variable, avec une valeur extrême chaque
+ fois qu'il n'y a pas de borne (``None`` n'est pas une valeur autorisée
+ lorsqu'il n'y a pas de borne).
Exemple :
``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,1.e99],[-1.e99,1.e99]]}``
.. index:: single: Bounds
Bounds
- Cette clé permet de définir des bornes supérieure et inférieure pour chaque
- variable d'état optimisée. Les bornes doivent être données par une liste de
- liste de paires de bornes inférieure/supérieure pour chaque variable, avec
- une valeur ``None`` chaque fois qu'il n'y a pas de borne. Les bornes
- peuvent toujours être spécifiées, mais seuls les optimiseurs sous
- contraintes les prennent en compte.
+ *Liste de paires de valeurs réelles*. Cette clé permet de définir des bornes
+ supérieure et inférieure pour chaque variable d'état optimisée. Les bornes
+ doivent être données par une liste de liste de paires de bornes
+ inférieure/supérieure pour chaque variable, avec une valeur ``None`` chaque
+ fois qu'il n'y a pas de borne. Les bornes peuvent toujours être spécifiées,
+ mais seuls les optimiseurs sous contraintes les prennent en compte.
Exemple :
``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,None],[None,None]]}``
.. index:: single: ConstrainedBy
ConstrainedBy
- Cette clé permet d'indiquer la méthode de prise en compte des contraintes de
- bornes. La seule disponible est "EstimateProjection", qui projete
- l'estimation de l'état courant sur les contraintes de bornes.
+ *Nom prédéfini*. Cette clé permet d'indiquer la méthode de prise en compte
+ des contraintes de bornes. La seule disponible est "EstimateProjection", qui
+ projete l'estimation de l'état courant sur les contraintes de bornes.
Exemple :
``{"ConstrainedBy":"EstimateProjection"}``
.. index:: single: CostDecrementTolerance
CostDecrementTolerance
- Cette clé indique une valeur limite, conduisant à arrêter le processus
- itératif d'optimisation lorsque la fonction coût décroît moins que cette
- tolérance au dernier pas. Le défaut est de 1.e-7, et il est recommandé
+ *Valeur réelle*. Cette clé indique une valeur limite, conduisant à arrêter le
+ processus itératif d'optimisation lorsque la fonction coût décroît moins que
+ cette tolérance au dernier pas. Le défaut est de 1.e-7, et il est recommandé
de l'adapter aux besoins pour des problèmes réels.
Exemple :
.. index:: single: CostDecrementTolerance
CostDecrementTolerance
- Cette clé indique une valeur limite, conduisant à arrêter le processus
- itératif d'optimisation lorsque la fonction coût décroît moins que cette
- tolérance au dernier pas. Le défaut est de 1.e-6, et il est recommandé de
- l'adapter aux besoins pour des problèmes réels.
+ *Valeur réelle*. Cette clé indique une valeur limite, conduisant à arrêter le
+ processus itératif d'optimisation lorsque la fonction coût décroît moins que
+ cette tolérance au dernier pas. Le défaut est de 1.e-6, et il est recommandé
+ de l'adapter aux besoins pour des problèmes réels.
Exemple :
``{"CostDecrementTolerance":1.e-6}``
.. index:: single: CrossOverProbability_CR
CrossOverProbability_CR
- Cette clé permet de définir la probabilité de recombinaison ou de croisement
- lors de l'évolution différentielle. Cette variable est usuellement notée
- ``CR`` dans la littérature, et elle est obligatoirement comprise entre 0 et
- 1. La valeur par défaut est 0.7, et il est conseillé de la changer si
- nécessaire.
+ *Valeur réelle*. Cette clé permet de définir la probabilité de recombinaison
+ ou de croisement lors de l'évolution différentielle. Cette variable est
+ usuellement notée ``CR`` dans la littérature, et elle est obligatoirement
+ comprise entre 0 et 1. La valeur par défaut est 0.7, et il est conseillé de
+ la changer si nécessaire.
Exemple :
``{"CrossOverProbability_CR":0.7}``
CurrentOptimum
*Liste de vecteurs*. Chaque élément est le vecteur d'état optimal au pas de
- temps courant au cours du déroulement de l'algorithme d'optimisation. Ce
- n'est pas nécessairement le dernier état.
+ temps courant au cours du déroulement itératif de l'algorithme d'optimisation
+ utilisé. Ce n'est pas nécessairement le dernier état.
Exemple :
``Xo = ADD.get("CurrentOptimum")[:]``
.. index:: single: Dict
**Dict**
- Cela indique une variable qui doit être remplie comme un dictionnaire au
- sens Python ``{"clé":"valeur"...}``.
+ *Dictionnaire*. Cela indique une variable qui doit être remplie comme un
+ dictionnaire au sens Python ``{"clé":"valeur"...}``.
.. index:: single: Function
**Function**
- Cela indique une variable qui doit être donnée comme une fonction au sens
- Python. Les fonctions sont des entrées spéciales qui peuvent être décrites
- selon les :ref:`section_ref_operator_requirements`.
+ *Fonction*. Cela indique une variable qui doit être donnée comme une
+ fonction au sens Python. Les fonctions sont des entrées spéciales qui
+ peuvent être décrites selon les :ref:`section_ref_operator_requirements`.
.. index:: single: Matrix
**Matrix**
- Cela indique une variable qui doit être donnée comme une matrice. Les
- matrices sont des entrées spéciales qui peuvent être décrites selon les
- :ref:`section_ref_covariance_requirements`.
+ *Matrice*. Cela indique une variable qui doit être donnée comme une
+ matrice. Les matrices sont des entrées spéciales qui peuvent être décrites
+ selon les :ref:`section_ref_covariance_requirements`.
.. index:: single: Script
**Script**
- Cela indique un script donné comme un fichier externe. Il peut être désigné
- par un nom de fichier avec chemin complet ou seulement par un nom de
- fichier sans le chemin. Si le fichier est donné uniquement par un nom sans
- chemin, et si un répertoire d'étude est aussi indiqué, le fichier est
- recherché dans le répertoire d'étude donné.
+ *Nom de fichier*. Cela indique un script donné comme un fichier externe. Il
+ peut être désigné par un nom de fichier avec chemin complet ou seulement
+ par un nom de fichier sans le chemin. Si le fichier est donné uniquement
+ par un nom sans chemin, et si un répertoire d'étude est aussi indiqué, le
+ fichier est recherché dans le répertoire d'étude donné.
.. index:: single: String
**String**
- Cela indique une chaîne de caractères fournissant une représentation
- littérale d'une matrice, d'un vecteur ou d'une collection de vecteurs,
- comme par exemple "1 2 ; 3 4" ou "[[1,2],[3,4]]" pour une matrice carrée de
- taille 2x2.
+ *Chaîne de caractères*. Cela indique une chaîne de caractères fournissant
+ une représentation littérale d'une matrice, d'un vecteur ou d'une
+ collection de vecteurs, comme par exemple "1 2 ; 3 4" ou "[[1,2],[3,4]]"
+ pour une matrice carrée de taille 2x2.
.. index:: single: Vector
**Vector**
- Cela indique une variable qui doit être remplie comme un vecteur. C'est une
- simple collection ordonnée de nombres réels. Les vecteurs peuvent être
- décrits en version ligne ou colonne sans faire de différence.
+ *Liste de valeurs réelles*. Cela indique une variable qui doit être remplie
+ comme un vecteur. C'est une simple collection ordonnée de nombres réels.
+ Les vecteurs peuvent être décrits en version ligne ou colonne sans faire de
+ différence.
.. index:: single: VectorSerie
**VectorSerie**
- Cela indique une variable qui doit être remplie comme une liste de
- vecteurs. C'est une collection ordonnée de vecteurs.
+ *Liste de liste de valeurs réelles*. Cela indique une variable qui doit être remplie comme
+ une liste de vecteurs. C'est une collection ordonnée de vecteurs.
.. index:: single: EpsilonMinimumExponent
EpsilonMinimumExponent
- Cette clé indique la valeur de l'exposant minimal du coefficient en
- puissance de 10 qui doit être utilisé pour faire décroître le multiplicateur
- de l'incrément. La valeur par défaut est de -8, et elle doit être entre 0 et
- -20. Par exemple, la valeur par défaut conduit à calculer le résidu de la
- formule avec un incrément fixe multiplié par 1.e0 jusqu'à 1.e-8.
+ *Valeur entière*. Cette clé indique la valeur de l'exposant minimal du
+ coefficient en puissance de 10 qui doit être utilisé pour faire décroître le
+ multiplicateur de l'incrément. La valeur par défaut est de -8, et elle doit
+ être négative entre 0 et -20. Par exemple, la valeur par défaut conduit à
+ calculer le résidu de la formule avec un incrément fixe multiplié par 1.e0
+ jusqu'à 1.e-8.
Exemple :
``{"EpsilonMinimumExponent":-12}``
.. index:: single: EstimationOf
EstimationOf
- Cette clé permet de choisir le type d'estimation à réaliser. Cela peut être
- soit une estimation de l'état, avec la valeur "State", ou une estimation de
- paramètres, avec la valeur "Parameters". Le choix par défaut est "State".
+ *Nom prédéfini*. Cette clé permet de choisir le type d'estimation à réaliser.
+ Cela peut être soit une estimation de l'état, avec la valeur "State", ou une
+ estimation de paramètres, avec la valeur "Parameters". Le choix par défaut
+ est "State".
Exemple :
``{"EstimationOf":"Parameters"}``
.. index:: single: GradientNormTolerance
GradientNormTolerance
- Cette clé indique une valeur limite, conduisant à arrêter le processus
- itératif d'optimisation lorsque la norme du gradient est en dessous de cette
- limite. C'est utilisé uniquement par les optimiseurs sans contraintes. Le
- défaut est 1.e-5 et il n'est pas recommandé de le changer.
+ *Valeur réelle*. Cette clé indique une valeur limite, conduisant à arrêter le
+ processus itératif d'optimisation lorsque la norme du gradient est en dessous
+ de cette limite. C'est utilisé uniquement par les optimiseurs sans
+ contraintes. Le défaut est 1.e-5 et il n'est pas recommandé de le changer.
Exemple :
``{"GradientNormTolerance":1.e-5}``
.. index:: single: IndexOfOptimum
IndexOfOptimum
- *Liste d'entiers*. Chaque élément est l'index d'itération de l'optimum
- obtenu au cours du déroulement de l'algorithme d'optimisation. Ce n'est pas
- nécessairement le numéro de la dernière itération.
+ *Liste d'entiers*. Chaque élément est l'index d'itération de l'optimum obtenu
+ au cours du déroulement itératif de l'algorithme d'optimisation utilisé. Ce
+ n'est pas nécessairement le numéro de la dernière itération.
Exemple :
``i = ADD.get("IndexOfOptimum")[-1]``
.. index:: single: InitialDirection
InitialDirection
- Cette clé indique la direction vectorielle utilisée pour la dérivée
- directionnelle autour du point nominal de vérification. Cela doit être un
- vecteur. Si elle n'est pas spécifiée, la direction par défaut est une
- perturbation par défaut autour de zéro de la même taille vectorielle que le
- point de vérification.
+ *Vecteur*. Cette clé indique la direction vectorielle utilisée pour la
+ dérivée directionnelle autour du point nominal de vérification. Cela doit
+ être un vecteur de la même taille que celle du point de vérification. Si elle
+ n'est pas spécifiée, la direction par défaut est une perturbation vectorielle
+ autour de zéro de la même taille que le point de vérification.
Exemple :
- ``{"InitialDirection":[0.1,0.1,100.,3}``
+ ``{"InitialDirection":[0.1,0.1,100.,3}`` pour un espace d'état de dimension 4
.. index:: single: LengthOfTabuList
LengthOfTabuList
- Cette clé indique la longueur de la liste taboue, c'est-à-dire le nombre
- maximal de perturbations antérieurement réalisées et conservées pour mémoire.
- Le défaut est 50, et il est recommandé de l'adapter aux besoins pour des
- problèmes réels.
+ *Valeur entière*. Cette clé indique la longueur de la liste taboue,
+ c'est-à-dire le nombre maximal de perturbations antérieurement réalisées et
+ conservées pour mémoire. Le défaut est 50, et il est recommandé de l'adapter
+ aux besoins pour des problèmes réels.
Exemple :
``{"LengthOfTabuList":50}``
.. index:: single: MaximumNumberOfFunctionEvaluations
MaximumNumberOfFunctionEvaluations
- Cette clé indique le nombre maximum d'évaluations possibles de la
- fonctionnelle à optimiser. Le défaut est de 15000, qui est une limite
+ *Valeur entière*. Cette clé indique le nombre maximum d'évaluations possibles
+ de la fonctionnelle à optimiser. Le défaut est de 15000, qui est une limite
arbitraire. Il est ainsi recommandé d'adapter ce paramètre aux besoins pour
des problèmes réels. Pour certains optimiseurs, le nombre effectif
d'évaluations à l'arrêt peut être légèrement différent de la limite à cause
.. index:: single: MaximumNumberOfSteps
MaximumNumberOfSteps
- Cette clé indique le nombre maximum d'itérations possibles en optimisation
- itérative. Le défaut est 15000, qui est très similaire à une absence de
- limite sur les itérations. Il est ainsi recommandé d'adapter ce paramètre
- aux besoins pour des problèmes réels. Pour certains optimiseurs, le nombre
- de pas effectif d'arrêt peut être légèrement différent de la limite à cause
- d'exigences de contrôle interne de l'algorithme.
+ *Valeur entière*. Cette clé indique le nombre maximum d'itérations possibles
+ en optimisation itérative. Le défaut est 15000, qui est très similaire à une
+ absence de limite sur les itérations. Il est ainsi recommandé d'adapter ce
+ paramètre aux besoins pour des problèmes réels. Pour certains optimiseurs, le
+ nombre de pas effectif d'arrêt peut être légèrement différent de la limite à
+ cause d'exigences de contrôle interne de l'algorithme.
Exemple :
``{"MaximumNumberOfSteps":100}``
.. index:: single: MaximumNumberOfSteps
MaximumNumberOfSteps
- Cette clé indique le nombre maximum d'itérations possibles en optimisation
- itérative. Le défaut est 50, qui est une limite arbitraire. Il est ainsi
- recommandé d'adapter ce paramètre aux besoins pour des problèmes réels.
+ *Valeur entière*. Cette clé indique le nombre maximum d'itérations possibles
+ en optimisation itérative. Le défaut est 50, qui est une limite arbitraire.
+ Il est ainsi recommandé d'adapter ce paramètre aux besoins pour des problèmes
+ réels.
Exemple :
``{"MaximumNumberOfSteps":50}``
.. index:: single: Minimizer
Minimizer
- Cette clé permet de changer la stratégie de minimisation pour l'optimiseur.
- Le choix par défaut est "BEST1BIN", et les choix possibles sont les
- multiples variables pour les stratégies de croisement et mutation, décrites
- par les clés
+ *Nom prédéfini*. Cette clé permet de changer la stratégie de minimisation
+ pour l'optimiseur. Le choix par défaut est "BEST1BIN", et les choix possibles
+ sont les multiples variables pour les stratégies de croisement et mutation,
+ décrites par les clés
"BEST1BIN",
"BEST1EXP",
"RAND1EXP",
.. index:: single: Minimizer
Minimizer
- Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
- défaut est "BOBYQA", et les choix possibles sont
+ *Nom prédéfini*. Cette clé permet de changer le minimiseur pour l'optimiseur.
+ Le choix par défaut est "BOBYQA", et les choix possibles sont
"BOBYQA" (minimisation avec ou sans contraintes par approximation quadratique [Powell09]_),
"COBYLA" (minimisation avec ou sans contraintes par approximation linéaire [Powell94]_ [Powell98]_).
"NEWUOA" (minimisation avec ou sans contraintes par approximation quadratique itérative [Powell04]_),
"SIMPLEX" (minimisation avec ou sans contraintes de type simplexe ou Nelder-Mead, voir [Nelder65]_),
"SUBPLEX" (minimisation avec ou sans contraintes de type simplexe sur une suite de sous-espaces [Rowan90]_).
Remarque : la méthode "POWELL" effectue une optimisation par boucles
- imbriquées interne/externe, conduisant ainsi à un contrôle relaché du
- nombre d'évaluations de la fonctionnelle à optimiser. Si un contrôle précis
- du nombre d'évaluations de cette fonctionnelle est requis, il faut choisir
- un autre minimiseur.
+ imbriquées interne/externe, conduisant ainsi à un contrôle relaché du nombre
+ d'évaluations de la fonctionnelle à optimiser. Si un contrôle précis du
+ nombre d'évaluations est requis, il faut choisir un autre minimiseur.
Exemple :
``{"Minimizer":"BOBYQA"}``
.. index:: single: MutationDifferentialWeight_F
MutationDifferentialWeight_F
- Cette clé permet de définir le poids différentiel dans l'étape de mutation.
- Cette variable est usuellement notée ``F`` dans la littérature. Il peut être
- constant s'il est sous la forme d'une valeur unique, ou variable de manière
- aléatoire dans les deux bornes données dans la paire. La valeur par défaut
- est (0.5, 1).
+ *Paire de valeurs réelles*. Cette clé permet de définir le poids différentiel
+ dans l'étape de mutation. Cette variable est usuellement notée ``F`` dans la
+ littérature. Il peut être constant s'il est sous la forme d'une valeur
+ unique, ou variable de manière aléatoire dans les deux bornes données dans la
+ paire. La valeur par défaut est (0.5, 1).
Exemple :
``{"MutationDifferentialWeight_F":(0.5, 1)}``
.. index:: single: NoiseAddingProbability
NoiseAddingProbability
- Cette clé indique la probabilité de perturbation d'une composante de l'état.
- C'est une valeur obligatoirement comprise entre 0 et 1. La valeur par défaut
- est 1, et il n'est pas recommandé de la changer.
+ *Valeur réelle*. Cette clé indique la probabilité de perturbation d'une
+ composante de l'état. C'est une valeur obligatoirement comprise entre 0 et 1.
+ La valeur par défaut est 1, et il n'est pas recommandé de la changer.
Exemple :
``{"NoiseAddingProbability":1.}``
.. index:: single: NoiseDistribution
NoiseDistribution
- Cette clé indique le type de la distribution utilisée pour générer les
- perturbations d'état. Cette distribution peut être de type "Uniform" ou
- "Gaussian". Le défaut est une distribution de type "Uniform", et il est
- recommandé de l'adapter aux besoins pour des problèmes réels.
+ *Nom prédéfini*. Cette clé indique le type de la distribution utilisée pour
+ générer les perturbations d'état. Cette distribution peut être de type
+ "Uniform" ou "Gaussian". Le défaut est une distribution de type "Uniform", et
+ il est recommandé de l'adapter aux besoins pour des problèmes réels.
Exemple :
``{"NoiseDistribution":"Uniform"}``
.. index:: single: NoiseHalfRange
NoiseHalfRange
- Cette clé indique, uniquement dans le cas d'une distribution de type
- "Uniform" demandée par le mot-clé "*NoiseDistribution*", la demi-amplitude
- des perturbations uniformes centrées d'état pour chaque composante de l'état.
- Le défaut est une liste vide, cette clé doit donc obligatoirement être
- renseignée dans le cas d'une distribution "Uniform". Une manière simple de le
- faire est de donner une liste de la longueur de l'état recherché et de
- demi-amplitudes identiques, comme dans l'exemple ci-dessous avec des
- demi-amplitudes de 3%. Il est conseillé de prendre des demi-amplitudes de
- quelques pourcents au maximum.
+ *Liste de valeurs réelles*. Cette clé indique, uniquement dans le cas d'une
+ distribution de type "Uniform" demandée par le mot-clé "*NoiseDistribution*",
+ la demi-amplitude des perturbations uniformes centrées d'état pour chaque
+ composante de l'état. Le défaut est une liste vide, cette clé doit donc
+ obligatoirement être renseignée dans le cas d'une distribution "Uniform". Une
+ manière simple de le faire est de donner une liste de la longueur de l'état
+ recherché et de demi-amplitudes identiques, comme dans l'exemple ci-dessous
+ avec des demi-amplitudes de 3%. Il est conseillé de prendre des
+ demi-amplitudes de quelques pourcents au maximum.
Exemple :
``{"NoiseHalfRange":<longueur de l'état>*[0.03]}``
.. index:: single: NumberOfElementaryPerturbations
NumberOfElementaryPerturbations
- Cette clé indique le nombre de perturbations élémentaires qui seront
- réalisées pour choisir une perturbation complète d'état. Le défaut est de 1,
- et il est recommandé de l'adapter avec prudence aux besoins pour des
- problèmes réels, sans choisir un trop grand nombre de perturbations
+ *Valeur entière*. Cette clé indique le nombre de perturbations élémentaires
+ qui seront réalisées pour choisir une perturbation complète d'état. Le défaut
+ est de 1, et il est recommandé de l'adapter avec prudence aux besoins pour
+ des problèmes réels, sans choisir un trop grand nombre de perturbations
élémentaires.
Exemple :
.. index:: single: NumberOfMembers
NumberOfMembers
- Cette clé indique le nombre de membres utilisés pour réaliser la méthode
- d'ensemble. Le défaut est de 100, et il est recommandé de l'adapter aux
- besoins pour des problèmes réels.
+ *Valeur entière*. Cette clé indique le nombre de membres utilisés pour
+ réaliser la méthode d'ensemble. Le défaut est de 100, et il est recommandé de
+ l'adapter aux besoins pour des problèmes réels.
Exemple :
``{"NumberOfMembers":100}``
.. index:: single: NumberOfPrintedDigits
NumberOfPrintedDigits
- Cette clé indique le nombre de décimales de précision pour les affichages de
- valeurs réelles. La valeur par défaut est 5, avec un minimum de 0.
+ *Valeur entière*. Cette clé indique le nombre de décimales de précision pour
+ les affichages de valeurs réelles. La valeur par défaut est 5, avec un
+ minimum de 0.
Exemple :
``{"NumberOfPrintedDigits":5}``
.. index:: single: NumberOfRepetition
NumberOfRepetition
- Cette clé indique le nombre de fois où répéter l'évaluation de la fonction.
- La valeur par défaut est 1.
+ *Valeur entière*. Cette clé indique le nombre de fois où répéter l'évaluation
+ de la fonction. La valeur par défaut est 1.
Exemple :
``{"NumberOfRepetition":3}``
.. index:: single: NumberOfSamplesForQuantiles
NumberOfSamplesForQuantiles
- Cette clé indique le nombre de simulations effectuées pour estimer les
- quantiles. Cette option n'est utile que si le calcul supplémentaire
- "SimulationQuantiles" a été choisi. Le défaut est 100, ce qui suffit souvent
- pour une estimation correcte de quantiles courants à 5%, 10%, 90% ou 95%.
+ *Valeur entière*. Cette clé indique le nombre de simulations effectuées pour
+ estimer les quantiles. Cette option n'est utile que si le calcul
+ supplémentaire "SimulationQuantiles" a été choisi. Le défaut est 100, ce qui
+ suffit souvent pour une estimation correcte de quantiles courants à 5%, 10%,
+ 90% ou 95%.
Exemple :
``{"NumberOfSamplesForQuantiles":100}``
.. index:: single: PopulationSize
PopulationSize
- Cette clé permet de définir la taille (approximative) de la population à
- chaque génération. Cette taille est légèrement ajustée pour tenir compte du
- nombre de variables d'état à optimiser. La valeur par défaut est 100. Il est
- conseillé de choisir une population comprise entre 1 et une dizaine de fois
- le nombre de variables d'états, la taille étant d'autant plus petite que le
- nombre de variables augmente.
+ *Valeur entière*. Cette clé permet de définir la taille (approximative) de la
+ population à chaque génération. Cette taille est légèrement ajustée pour
+ tenir compte du nombre de variables d'état à optimiser. La valeur par défaut
+ est 100. Il est conseillé de choisir une population comprise entre 1 et une
+ dizaine de fois le nombre de variables d'états, la taille étant d'autant plus
+ petite que le nombre de variables augmente.
Exemple :
``{"PopulationSize":100}``
.. index:: single: PrintAllValuesFor
PrintAllValuesFor
- Cette clé indique la liste des noms de vecteurs dont les valeurs détaillées
- sont à imprimer, la valeur par défaut étant la liste vide. Si le vecteur
- nommé n'est pas une entrée fournie, le nom est simplement ignoré. Les noms
- possibles sont dans la liste suivante : [
+ *Liste de noms prédéfinis*. Cette clé indique la liste des noms de vecteurs
+ dont les valeurs détaillées sont à imprimer, la valeur par défaut étant la
+ liste vide. Si le vecteur nommé n'est pas une entrée fournie, le nom est
+ simplement ignoré. Les noms possibles sont dans la liste suivante : [
"Background",
"CheckingPoint",
"Observation",
.. index:: single: ProjectedGradientTolerance
ProjectedGradientTolerance
- Cette clé indique une valeur limite, conduisant à arrêter le processus
+ *Valeur réelle*. Cette clé indique une valeur limite, conduisant à arrêter le processus
itératif d'optimisation lorsque toutes les composantes du gradient projeté
sont en-dessous de cette limite. C'est utilisé uniquement par les
optimiseurs sous contraintes. Le défaut est -1, qui désigne le défaut
.. index:: single: QualityCriterion
QualityCriterion
- Cette clé indique le critère de qualité, qui est minimisé pour trouver
- l'estimation optimale de l'état. Le défaut est le critère usuel de
- l'assimilation de données nommé "DA", qui est le critère de moindres carrés
- pondérés augmentés. Les critères possibles sont dans la liste suivante, dans
- laquelle les noms équivalents sont indiqués par un signe "<=>" :
- ["AugmentedWeightedLeastSquares"<=>"AWLS"<=>"DA", "WeightedLeastSquares"<=>"WLS",
- "LeastSquares"<=>"LS"<=>"L2", "AbsoluteValue"<=>"L1", "MaximumError"<=>"ME"].
+ *Nom prédéfini*. Cette clé indique le critère de qualité, qui est minimisé
+ pour trouver l'estimation optimale de l'état. Le défaut est le critère usuel
+ de l'assimilation de données nommé "DA", qui est le critère de moindres
+ carrés pondérés augmentés. Les critères possibles sont dans la liste
+ suivante, dans laquelle les noms équivalents sont indiqués par un signe "<=>"
+ : ["AugmentedWeightedLeastSquares"<=>"AWLS"<=>"DA",
+ "WeightedLeastSquares"<=>"WLS", "LeastSquares"<=>"LS"<=>"L2",
+ "AbsoluteValue"<=>"L1", "MaximumError"<=>"ME"].
Exemple :
``{"QualityCriterion":"DA"}``
.. index:: single: Quantile
Quantile
- Cette clé permet de définir la valeur réelle du quantile recherché, entre 0
- et 1. La valeur par défaut est 0.5, correspondant à la médiane.
+ *Valeur réelle*. Cette clé permet de définir la valeur réelle du quantile
+ recherché, entre 0 et 1. La valeur par défaut est 0.5, correspondant à la
+ médiane.
Exemple :
``{"Quantile":0.5}``
.. index:: single: Quantiles
Quantiles
- Cette liste indique les valeurs de quantile, entre 0 et 1, à estimer par
- simulation autour de l'état optimal. L'échantillonnage utilise des tirages
- aléatoires gaussiens multivariés, dirigés par la matrice de covariance a
- posteriori. Cette option n'est utile que si le calcul supplémentaire
- "SimulationQuantiles" a été choisi. La valeur par défaut est une liste vide.
+ *Liste de valeurs réelles*. Cette liste indique les valeurs de quantile,
+ entre 0 et 1, à estimer par simulation autour de l'état optimal.
+ L'échantillonnage utilise des tirages aléatoires gaussiens multivariés,
+ dirigés par la matrice de covariance a posteriori. Cette option n'est utile
+ que si le calcul supplémentaire "SimulationQuantiles" a été choisi. La valeur
+ par défaut est une liste vide.
Exemple :
``{"Quantiles":[0.1,0.9]}``
.. index:: single: SampleAsExplicitHyperCube
SampleAsExplicitHyperCube
- Cette clé décrit les points de calcul sous la forme d'un hyper-cube, dont on
- donne la liste des échantillonnages explicites de chaque variable comme une
- liste. C'est donc une liste de listes, chacune étant de taille
- potentiellement différente.
+ *Liste de liste de valeurs réelles*. Cette clé décrit les points de calcul
+ sous la forme d'un hyper-cube, dont on donne la liste des échantillonnages
+ explicites de chaque variable comme une liste. C'est donc une liste de
+ listes, chacune étant de taille potentiellement différente.
Exemple : ``{"SampleAsExplicitHyperCube":[[0.,0.25,0.5,0.75,1.], [-2,2,1]]}`` pour un espace d'état de dimension 2
.. index:: single: SampleAsIndependantRandomVariables
SampleAsIndependantRandomVariables
- Cette clé décrit les points de calcul sous la forme d'un hyper-cube, dont les
- points sur chaque axe proviennent de l'échantillonnage aléatoire indépendant
- de la variable d'axe, selon la spécification de la distribution, de ses
- paramètres et du nombre de points de l'échantillon, sous la forme d'une liste
- ``['distribution', [parametres], nombre]`` pour chaque axe. Les distributions
- possibles sont 'normal' de paramètres (mean,std), 'lognormal' de paramètres
- (mean,sigma), 'uniform' de paramètres (low,high), ou 'weibull' de paramètre
- (shape). C'est donc une liste de la même taille que celle de l'état.
+ *Liste de triplets [Nom, Paramètres, Nombre]*. Cette clé décrit les points de
+ calcul sous la forme d'un hyper-cube, dont les points sur chaque axe
+ proviennent de l'échantillonnage aléatoire indépendant de la variable d'axe,
+ selon la spécification de la distribution, de ses paramètres et du nombre de
+ points de l'échantillon, sous la forme d'une liste ``['distribution',
+ [parametres], nombre]`` pour chaque axe. Les distributions possibles sont
+ 'normal' de paramètres (mean,std), 'lognormal' de paramètres (mean,sigma),
+ 'uniform' de paramètres (low,high), ou 'weibull' de paramètre (shape). C'est
+ donc une liste de la même taille que celle de l'état.
Exemple :
``{"SampleAsIndependantRandomVariables":[ ['normal',[0.,1.],3], ['uniform',[-2,2],4]]`` pour un espace d'état de dimension 2
.. index:: single: SampleAsMinMaxStepHyperCube
SampleAsMinMaxStepHyperCube
- Cette clé décrit les points de calcul sous la forme d'un hyper-cube, dont on
- donne la liste des échantillonnages implicites de chaque variable par un
- triplet *[min,max,step]*. C'est donc une liste de la même taille que celle
- de l'état. Les bornes sont incluses.
+ *Liste de triplets de valeurs réelles*. Cette clé décrit les points de calcul
+ sous la forme d'un hyper-cube, dont on donne la liste des échantillonnages
+ implicites de chaque variable par un triplet *[min,max,step]*. C'est donc une
+ liste de la même taille que celle de l'état. Les bornes sont incluses.
Exemple :
``{"SampleAsMinMaxStepHyperCube":[[0.,1.,0.25],[-1,3,1]]}`` pour un espace d'état de dimension 2
.. index:: single: SampleAsnUplet
SampleAsnUplet
- Cette clé décrit les points de calcul sous la forme d'une liste de n-uplets,
- chaque n-uplet étant un état.
+ *Liste d'états*. Cette clé décrit les points de calcul sous la forme d'une
+ liste de n-uplets, chaque n-uplet étant un état.
Exemple :
``{"SampleAsnUplet":[[0,1,2,3],[4,3,2,1],[-2,3,-4,5]]}`` pour 3 points dans un espace d'état de dimension 4
.. index:: single: SetDebug
SetDebug
- Cette clé requiert l'activation, ou pas, du mode de débogage durant
- l'évaluation de la fonction ou de l'opérateur. La valeur par défaut est
- "True", les choix sont "True" ou "False".
+ *Valeur booléenne*. Cette clé requiert l'activation, ou pas, du mode de
+ débogage durant l'évaluation de la fonction ou de l'opérateur. La valeur par
+ défaut est "True", les choix sont "True" ou "False".
Exemple :
``{"SetDebug":False}``
.. index:: single: SetSeed
SetSeed
- Cette clé permet de donner un nombre entier pour fixer la graine du
- générateur aléatoire utilisé dans l'algorithme. Une valeur simple est par
- exemple 1000. Par défaut, la graine est laissée non initialisée, et elle
- utilise ainsi l'initialisation par défaut de l'ordinateur, qui varie donc à
- chaque étude. Pour assurer la reproductibilité de résultats impliquant des
- tirages aléatoires, il est fortement conseiller d'initialiser la graine.
+ *Valeur entière*. Cette clé permet de donner un nombre entier pour fixer la
+ graine du générateur aléatoire utilisé dans l'algorithme. Une valeur simple
+ est par exemple 1000. Par défaut, la graine est laissée non initialisée, et
+ elle utilise ainsi l'initialisation par défaut de l'ordinateur, qui varie
+ donc à chaque étude. Pour assurer la reproductibilité de résultats impliquant
+ des tirages aléatoires, il est fortement conseiller d'initialiser la graine.
Exemple :
``{"SetSeed":1000}``
.. index:: single: ShowInformationOnlyFor
ShowInformationOnlyFor
- Cette clé indique la liste des noms de vecteurs dont les informations
- synthétiques (taille, min/max...) sont à imprimer, la valeur par défaut étant
- l'ensemble des vecteurs. Si le vecteur nommé n'est pas une entrée fournie, le
- nom est simplement ignoré. Cela permet de restreindre les impressions
- synthétiques. Les noms possibles sont dans la liste suivante : [
+ *Liste de noms prédéfinis*. Cette clé indique la liste des noms de vecteurs
+ dont les informations synthétiques (taille, min/max...) sont à imprimer, la
+ valeur par défaut étant l'ensemble des vecteurs. Si le vecteur nommé n'est
+ pas une entrée fournie, le nom est simplement ignoré. Cela permet de
+ restreindre les impressions synthétiques. Les noms possibles sont dans la
+ liste suivante : [
"Background",
"CheckingPoint",
"Observation",
.. index:: single: SimulationForQuantiles
SimulationForQuantiles
- Cette clé indique le type de simulation, linéaire (avec l'opérateur
- d'observation tangent appliqué sur des incréments de perturbations autour de
- l'état optimal) ou non-linéaire (avec l'opérateur d'observation standard
- appliqué aux états perturbés), que l'on veut faire pour chaque perturbation.
- Cela change essentiellement le temps de chaque simulation élémentaire,
- usuellement plus long en non-linéaire qu'en linéaire. Cette option n'est
- utile que si le calcul supplémentaire "SimulationQuantiles" a été choisi. La
- valeur par défaut est "Linear", et les choix possibles sont "Linear" et
- "NonLinear".
+ *Nom prédéfini*. Cette clé indique le type de simulation, linéaire (avec
+ l'opérateur d'observation tangent appliqué sur des incréments de
+ perturbations autour de l'état optimal) ou non-linéaire (avec l'opérateur
+ d'observation standard appliqué aux états perturbés), que l'on veut faire
+ pour chaque perturbation. Cela change essentiellement le temps de chaque
+ simulation élémentaire, usuellement plus long en non-linéaire qu'en linéaire.
+ Cette option n'est utile que si le calcul supplémentaire
+ "SimulationQuantiles" a été choisi. La valeur par défaut est "Linear", et les
+ choix possibles sont "Linear" et "NonLinear".
Exemple :
``{"SimulationForQuantiles":"Linear"}``
.. index:: single: StandardDeviation
StandardDeviation
- Cette clé indique, uniquement dans le cas d'une distribution de type
- "Gaussian" demandée par le mot-clé "*NoiseDistribution*", l'écart-type des
- perturbations gaussiennes d'état pour chaque composante de l'état. Le défaut
- est une liste vide, cette clé doit donc obligatoirement être renseignée dans
- le cas d'une distribution "Gaussian". Une manière simple de le faire est de
- donner une liste de la longueur de l'état recherché avec des écart-types
- identiques, comme dans l'exemple ci-dessous avec des demi-amplitudes de 5%.
- Il est conseillé de prendre des écart-types de quelques pourcents au maximum.
+ *Liste de valeurs réelles*. Cette clé indique, uniquement dans le cas d'une
+ distribution de type "Gaussian" demandée par le mot-clé
+ "*NoiseDistribution*", l'écart-type des perturbations gaussiennes d'état pour
+ chaque composante de l'état. Le défaut est une liste vide, cette clé doit
+ donc obligatoirement être renseignée dans le cas d'une distribution
+ "Gaussian". Une manière simple de le faire est de donner une liste de la
+ longueur de l'état recherché avec des écart-types identiques, comme dans
+ l'exemple ci-dessous avec des demi-amplitudes de 5%. Il est conseillé de
+ prendre des écart-types de quelques pourcents au maximum.
Exemple :
``{"StandardDeviation":<longueur de l'état>*[0.05]}``
.. index:: single: StateVariationTolerance
StateVariationTolerance
- Cette clé indique la variation relative maximale de l'état lors pour l'arrêt
- par convergence sur l'état. Le défaut est de 1.e-4, et il est recommandé
- de l'adapter aux besoins pour des problèmes réels.
+ *Valeur réelle*. Cette clé indique la variation relative maximale de l'état
+ lors de l'arrêt par convergence sur l'état. Le défaut est de 1.e-4, et il
+ est recommandé de l'adapter aux besoins pour des problèmes réels.
Exemple :
``{"StateVariationTolerance":1.e-4}``
