[localization] fix wrong french translation of row
[scilab.git] / scilab / modules / statistics / help / fr_FR / 3_dispersion_widths / variance.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2013 - Samuel GOUGEON
5  * Copyright (C) 2000 - INRIA - Carlos Klimann
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="variance">
18     <refnamediv>
19         <refname>variance</refname>
20         <refpurpose>variance d'un vecteur, matrice (voire hypermatrice) de nombres réels ou complexes</refpurpose>
21     </refnamediv>
22     <refsynopsisdiv>
23         <title>Séquence d'appel</title>
24         <synopsis>
25             [s, [mc]] = variance(x [,orien [,m]])
26
27             [s, mc] = variance(x)
28             [s, mc] = variance(x, "r"|1 )
29             [s, mc] = variance(x, "c"|2 )
30             [s, mc] = variance(x, "*"  , %nan)
31             [s, mc] = variance(x, "r"|1, %nan)
32             [s, mc] = variance(x, "c"|2, %nan)
33             s = variance(x, "*", m)
34             s = variance(x, "r", m)
35             s = variance(x, "c", m)
36         </synopsis>
37     </refsynopsisdiv>
38     <refsection>
39         <title>Paramètres</title>
40         <variablelist>
41             <varlistentry>
42                 <term>x</term>
43                 <listitem>
44                     <para>
45                         vecteur ou matrice de nombres réels ou complexes. Une hypermatrice est acceptable uniquement sans les options "r" ou "c" : <literal>variance(x)</literal> or <literal>variance(x,"*",m)</literal>
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>orien</term>
51                 <listitem>
52                     <para>
53                         variance selon les lignes ou les colonnes de <varname>x</varname>. Les valeurs possibles sont
54                         <itemizedlist>
55                             <listitem>
56                                 1 or "r" : calcul par colonne. Le résultat est un vecteur ligne
57                             </listitem>
58                             <listitem>
59                                 2 or "c" : calcul par ligne. Le résultat est une <varname>c</varname>olonne
60                             </listitem>
61                             <listitem>
62                                 "*" : calcul tous les éléments de <varname>x</varname> confondus (mode utilisé par défaut); requis si le 3ème paramètre <varname>m</varname> doit être utilisé.
63                             </listitem>
64                         </itemizedlist>
65                     </para>
66                 </listitem>
67             </varlistentry>
68             <varlistentry>
69                 <term>m</term>
70                 <listitem>
71                     <para>
72                         Espérance mathématique de la loi de distribution de probabilité sous-jacente (supposée connue).
73                         <itemizedlist>
74                             <listitem>
75                                 mode "*" (par défaut) : <varname>m</varname> doit être scalaire
76                             </listitem>
77                             <listitem>
78                                 mode "r" or 1 : <varname>m</varname> un vecteur ligne à <literal>size(x,2)</literal> éléments. La variance des éléments de la colonne #j de <varname>x</varname> est calculée en utilisant <literal>m(j)</literal> comme moyenne pour la colonne. Si <varname>m</varname> est la même pour toutes les colonnes, sa valeur scalaire peut être fournie au lieu d'une ligne.
79                             </listitem>
80                             <listitem>
81                                 mode "c" ou 2 : <varname>m</varname> un vecteur colonne à <literal>size(x,1)</literal> éléments. La variance des éléments de la ligne #i de <varname>x</varname> est calculée en utilisant <literal>m(i)</literal> comme moyenne pour la ligne. Si <varname>m</varname> est la même pour toutes les lignes, sa valeur scalaire peut être fournie au lieu d'une colonne.
82                             </listitem>
83                         </itemizedlist>
84                     </para>
85                     <para>
86                         Lorsque <varname>m</varname> n'est pas indiquée, la <literal>variance</literal> est estimée en divisant par (n-1) (non n) la distance quadratique totale des n valeurs à la moyenne calculée <literal>mean(x)</literal>(ou <literal>mean(x,"c")</literal> ou <literal>mean(x,"r")</literal>) (n vaut length(x) ou size(x,1) ou size(x,2)). Si les éléments de <varname>x</varname> sont indépendants entre eux, l'estimation de la variance retournée est non biaisée.
87                     </para>
88                     <para>
89                         Sinon, la <literal>variance</literal> est estimée en divisant par <literal>n</literal> (au lieu de <literal>n-1</literal>) la distance quadratique totale des valeurs <literal>x(k)</literal> à <varname>m</varname> (<literal>n</literal> valant toujours <literal>length(x)</literal> ou <literal>size(x,1)</literal> ou <literal>size(x,2)</literal>). Alors :
90                         <itemizedlist>
91                             <listitem>
92                                 Si une véritable valeur <varname>m</varname> indépendante des éléments de x est fournie, elle est utilisée comme moyenne de référence dans le calcul de la variance. La valeur obtenue et retournée pour celle-ci est alors réputée non biaisée.
93                             </listitem>
94                             <listitem>
95                                 Si la valeur spéciale <literal>m=%nan</literal> est fournie, la variance est toujours "normalisée" par n (non n-1) mais est estimée en utilisant l'estimation "empirique"
96                                 <literal>m=mean(x)</literal> de la moyenne de référence (ou <literal>m = mean(x,"c")</literal> ou <literal>m = mean(x,"r")</literal>). Comme <varname>m=%nan</varname> n'apporte aucune information nouvelle à "l'équation", celle-ci retourne une estimation biaisée de la variance.
97                             </listitem>
98                         </itemizedlist>
99                     </para>
100                 </listitem>
101             </varlistentry>
102             <varlistentry>
103                 <term>s</term>
104                 <listitem>
105                     Estimation de la variance des valeurs de <varname>x</varname> (non pondérées). <varname>s</varname> est un scalaire ou un vecteur ligne ou colonne selon l'option <varname>orien</varname> utilisée.
106                 </listitem>
107             </varlistentry>
108             <varlistentry>
109                 <term>mc</term>
110                 <listitem>
111                     Moyenne calculée à partir de <varname>x</varname> (<literal>= mean(x,..)</literal>) et utilisée comme référence dans le calcul de la variance. Valeur scalaire ou en vecteur colonne ou ligne, selon l'option <varname>orien</varname> utilisée.
112                 </listitem>
113             </varlistentry>
114         </variablelist>
115     </refsection>
116     <refsection>
117         <title>Description</title>
118         <para>
119             Cette fonction calcule la variance d'un ensemble de nombres réels ou complexes d'un vecteur, d'une matrice (voire d'une hypermatrice) <literal>x</literal>. Pour <literal>x</literal> à valeurs complexes, <literal>variance(x,..) = variance(real(x),..) + variance(imag(x),..)</literal> est retournée.
120         </para>
121         <para>
122             Pour un vecteur, une matrice ou une hypermatrice <varname>x</varname>, <literal>s = variance(x)</literal> ou <literal>s = variance(x, "*")</literal>
123             retourne  dans le scalaire <varname>s</varname> la variance de tous les éléments de <varname>x</varname>.
124         </para>
125         <para>
126             <literal>s = variance(x,"c")</literal> (ou indifféremment <literal>s = variance(x, 2)</literal>) calcule la variance de chaque ligne.
127             Le vecteur colonne <varname>s</varname> est retourné, avec <literal>s(j) = variance(x(j,:),..)</literal>.
128         </para>
129         <para>
130             <literal>s = variance(x,"r")</literal> (ou indifféremment <literal>s = variance(x,1)</literal>) calcule la variance de chaque colonne.
131             Le vecteur ligne <varname>s</varname> est retourné, avec <literal>s(i) = variance(x(:,i),..)</literal>.
132         </para>
133         <para>
134             <warning>
135                 La syntaxe <literal>variance(x, "*"|"c"|"r", 1)</literal> utilisable uniquement en Scilab 5.4.1 doit être remplacée par
136                 <literal>variance(x,"*"|"c"|"r", %nan)</literal>. <literal>variance(x, "*"|"c"|"r", 1)</literal> émettra une alerte
137                 jusqu'en Scilab 6.0. En effet, <literal>1</literal> est désormais compris comme <literal>m=1</literal>.
138                 Si <literal>1</literal> est la valeur de l'espérance <varname>m</varname>à fournir, l'alerte peut être évitée
139                 en indiquant<literal>1+%eps</literal> au lieu de <literal>1</literal>.
140             </warning>
141         </para>
142     </refsection>
143     <refsection>
144         <title>Exemples</title>
145         <programlisting role="example"><![CDATA[
146 x = [ 0.2113249 0.0002211 0.6653811; 0.7560439 0.4453586 0.6283918 ]
147 s = variance(x)
148 s = variance(x, "r")
149 s = variance(x, "c")
150
151 // La loi de distribution de probabilité sous-jacente et son espérance (moyenne) sont connues :
152 x = grand(100,5,"unf",0,7);       // Distribution uniforme sur [0, 7]
153 // => espérance = (0+7)/2 = 3.5  et variance = (7-0)^2/12
154 (7-0)^2/12                              // Variance asymptotique vraie
155 s = variance(x)             // Estimation non biaisée (division par n-1).
156 s = variance(x, "*", 3.5)   // Estimation non biaisée (division par n). Toujours >= variance(x)
157 s = variance(x, "*", %nan)      // Estimation biaisée     (division par n). Toujours <= variance(x)
158 // A travers les colonnes (le long des lignes) => résultat en colonne :
159 s = variance(x, "c")
160 s = variance(x, "c", 3.5)
161 s = variance(x, "c", %nan)
162
163 // Nombres complexes uniformément distribués sur [0,1] + [0,1].i :
164 x = rand(4, 3) + rand(4, 3)*%i
165 s = variance(x)
166 s = variance(x, "*", 0.5 + 0.5*%i)
167 s = variance(x, "*", %nan)
168 s = variance(x, "r")
169 s = variance(x, "c")
170
171 // Nombres fournis en hypermatrice :
172 x = rand(3, 2, 2)       // Distribution uniforme sur [0, 1]
173 s = variance(x)
174 s = variance(x, "*", 0.5)
175 s = variance(x, "*", %nan)
176 // s = variance(x, "r")  //  Utilisation non admise pour une hypermatrice
177 // s = variance(x, "c")  //  Utilisation non admise pour une hypermatrice
178  ]]></programlisting>
179     </refsection>
180     <refsection role="see also">
181         <title>Voir aussi</title>
182         <simplelist type="inline">
183             <member>
184                 <link linkend="variancef">variancef</link>
185             </member>
186             <member>
187                 <link linkend="mtlb_var">mtlb_var</link>
188             </member>
189             <member>
190                 <link linkend="stdev">stdev</link>
191             </member>
192         </simplelist>
193     </refsection>
194     <refsection>
195         <title>Bibliographie</title>
196         <para>
197             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
198         </para>
199     </refsection>
200     <refsection>
201         <title>Historique</title>
202         <revhistory>
203             <revision>
204                 <revnumber>5.5.0</revnumber>
205                 <revdescription>
206                     <itemizedlist>
207                         <listitem>
208                             <para>variance(x, orien, 0|1) supprimée (utilisable uniquement avec Scilab 5.4.1)</para>
209                         </listitem>
210                         <listitem>
211                             <para>variance(x, orien, m) introduite : l'espérance mathématique m connue de la distribution de probabilité sous-jacente peut être spécifiée et utilisée</para>
212                         </listitem>
213                         <listitem>
214                             <para>variance(x, orien, %nan) introduite : mean(x,..) est utilisée, mais la distance quadratique totale est divisée par la taille n de l'échantillon (au lieu de n-1)</para>
215                         </listitem>
216                         <listitem>
217                             <para>[s, mc] = variance(x,..) introduite : la moyenne mc calculée sur l'échantillon x peut être obtenue en second résultat</para>
218                         </listitem>
219                     </itemizedlist>
220                 </revdescription>
221             </revision>
222             <revision>
223                 <revnumber>5.4.1</revnumber>
224                 <revdescription>
225                     <itemizedlist>
226                         <listitem>
227                             <para>variance(complexes) corrigée. variance(x, "*", 1) introduite. Vectorisation du calcul pour variance(x, "r"|"c"). Révision complète de la page d'aide</para>
228                         </listitem>
229                     </itemizedlist>
230                 </revdescription>
231             </revision>
232         </revhistory>
233     </refsection>
234 </refentry>