From: Jean-Philippe ARGAUD Date: Fri, 16 Oct 2020 06:42:08 +0000 (+0200) Subject: Minor documentation improvements X-Git-Tag: V9_6_0b1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=89be6910631865c10c7836693fb9b1097f40ffd6;p=modules%2Fadao.git Minor documentation improvements --- diff --git a/doc/en/snippets/APosterioriCorrelations.rst b/doc/en/snippets/APosterioriCorrelations.rst index 9a56396..82e57dd 100644 --- a/doc/en/snippets/APosterioriCorrelations.rst +++ b/doc/en/snippets/APosterioriCorrelations.rst @@ -3,7 +3,8 @@ APosterioriCorrelations *List of matrices*. Each element is an *a posteriori* error correlations matrix of the optimal state, coming from the :math:`\mathbf{A}*` covariance - matrix. + matrix. In order to get them, this *a posteriori* error covariances + calculation has to be requested at the same time. Example: ``C = ADD.get("APosterioriCorrelations")[-1]`` diff --git a/doc/en/snippets/APosterioriStandardDeviations.rst b/doc/en/snippets/APosterioriStandardDeviations.rst index 8d8684b..a95ca4a 100644 --- a/doc/en/snippets/APosterioriStandardDeviations.rst +++ b/doc/en/snippets/APosterioriStandardDeviations.rst @@ -1,9 +1,10 @@ .. index:: single: APosterioriStandardDeviations APosterioriStandardDeviations - *List of matrices*. Each element is an *a posteriori* error standard - errors diagonal matrix of the optimal state, coming from the - :math:`\mathbf{A}*` covariance matrix. + *List of matrices*. Each element is an *a posteriori* error standard errors + diagonal matrix of the optimal state, coming from the :math:`\mathbf{A}*` + covariance matrix. In order to get them, this *a posteriori* error + covariances calculation has to be requested at the same time. Example: ``S = ADD.get("APosterioriStandardDeviations")[-1]`` diff --git a/doc/en/snippets/APosterioriVariances.rst b/doc/en/snippets/APosterioriVariances.rst index 0105d05..89e6b1f 100644 --- a/doc/en/snippets/APosterioriVariances.rst +++ b/doc/en/snippets/APosterioriVariances.rst @@ -1,9 +1,10 @@ .. index:: single: APosterioriVariances APosterioriVariances - *List of matrices*. Each element is an *a posteriori* error variance - errors diagonal matrix of the optimal state, coming from the - :math:`\mathbf{A}*` covariance matrix. + *List of matrices*. Each element is an *a posteriori* error variance errors + diagonal matrix of the optimal state, coming from the :math:`\mathbf{A}*` + covariance matrix. In order to get them, this *a posteriori* error + covariances calculation has to be requested at the same time. Example: ``V = ADD.get("APosterioriVariances")[-1]`` diff --git a/doc/fr/snippets/APosterioriCorrelations.rst b/doc/fr/snippets/APosterioriCorrelations.rst index feaf81d..d99d4c5 100644 --- a/doc/fr/snippets/APosterioriCorrelations.rst +++ b/doc/fr/snippets/APosterioriCorrelations.rst @@ -3,7 +3,8 @@ APosterioriCorrelations *Liste de matrices*. Chaque élément est une matrice de corrélations des erreurs *a posteriori* de l'état optimal, issue de la matrice - :math:`\mathbf{A}` des covariances. + :math:`\mathbf{A}` des covariances. Pour en disposer, il faut avoir en même + temps demandé le calcul de ces covariances d'erreurs *a posteriori*. Exemple : ``C = ADD.get("APosterioriCorrelations")[-1]`` diff --git a/doc/fr/snippets/APosterioriStandardDeviations.rst b/doc/fr/snippets/APosterioriStandardDeviations.rst index ecceee5..0d9ab40 100644 --- a/doc/fr/snippets/APosterioriStandardDeviations.rst +++ b/doc/fr/snippets/APosterioriStandardDeviations.rst @@ -3,7 +3,8 @@ APosterioriStandardDeviations *Liste de matrices*. Chaque élément est une matrice diagonale d'écarts-types des erreurs *a posteriori* de l'état optimal, issue de la matrice - :math:`\mathbf{A}` des covariances. + :math:`\mathbf{A}` des covariances. Pour en disposer, il faut avoir en même + temps demandé le calcul de ces covariances d'erreurs *a posteriori*. Exemple : ``S = ADD.get("APosterioriStandardDeviations")[-1]`` diff --git a/doc/fr/snippets/APosterioriVariances.rst b/doc/fr/snippets/APosterioriVariances.rst index 1db0cac..b8a5db4 100644 --- a/doc/fr/snippets/APosterioriVariances.rst +++ b/doc/fr/snippets/APosterioriVariances.rst @@ -3,7 +3,8 @@ APosterioriVariances *Liste de matrices*. Chaque élément est une matrice diagonale de variances des erreurs *a posteriori* de l'état optimal, issue de la matrice - :math:`\mathbf{A}` des covariances. + :math:`\mathbf{A}` des covariances. Pour en disposer, il faut avoir en même + temps demandé le calcul de ces covariances d'erreurs *a posteriori*. Exemple : ``V = ADD.get("APosterioriVariances")[-1]``