[localization] fix wrong french translation of row
[scilab.git] / scilab / modules / statistics / help / fr_FR / 3_dispersion_widths / variancef.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 - Scilab Enterprises - Paul Bignier
5  * Copyright (C) 2013 - Samuel Gougeon
6  * Copyright (C) 2000 - INRIA - Carlos Klimann
7  *
8  * Copyright (C) 2012 - 2016 - Scilab Enterprises
9  *
10  * This file is hereby licensed under the terms of the GNU GPL v2.0,
11  * pursuant to article 5.3.4 of the CeCILL v.2.1.
12  * This file was originally licensed under the terms of the CeCILL v2.1,
13  * and continues to be available under such terms.
14  * For more information, see the COPYING file which you should have received
15  * along with this program.
16  *
17  -->
18 <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="variancef">
19     <refnamediv>
20         <refname>variancef</refname>
21         <refpurpose>variance (et moyenne) d'un vecteur ou d'une matrice réelle ou complexe de nombres pondérés en fréquence</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Séquence d'appel</title>
25         <synopsis>
26             [s [,mc]] = variancef(x, fre [,orien [,m]])
27
28             [s, mc] = variancef(x)
29             [s, mc] = variancef(x, fre, "r"|1 )
30             [s, mc] = variancef(x, fre, "c"|2 )
31             [s, mc] = variancef(x, fre, "*"  , %nan)
32             [s, mc] = variancef(x, fre, "r"|1, %nan)
33             [s, mc] = variancef(x, fre, "c"|2, %nan)
34             s = variancef(x, fre, "*", m)
35             s = variancef(x, fre, "r", m)
36             s = variancef(x, fre, "c", m)
37         </synopsis>
38     </refsynopsisdiv>
39     <refsection>
40         <title>Paramètres</title>
41         <variablelist>
42             <varlistentry>
43                 <term>x</term>
44                 <listitem>
45                     <para>
46                         vecteur ou matrice réel(le) ou complexe
47                     </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>fre</term>
52                 <listitem>
53                     <para>
54                         vecteur ou matrice d'entiers positifs = fréquences: <code>fre(i,j)</code> est le nombre de fois que <code>x(i,j)</code> doit être compté.
55                         <varname>fre</varname> et <varname>x</varname> doivent être de même taille.
56                     </para>
57                 </listitem>
58             </varlistentry>
59             <varlistentry>
60                 <term>orien</term>
61                 <listitem>
62                     <para>l'orientation du calcul. Les valeurs acceptées sont:
63                         <itemizedlist>
64                             <listitem>1 ou "r" : le résultat est une ligne, après un calcul en colonne.</listitem>
65                             <listitem>2 ou "c" : le résultat est une colonne, après un calcul en ligne.</listitem>
66                             <listitem>
67                                 "*" : calcul tous les éléments de <varname>x</varname> confondus (mode utilisé par défaut); utile si le 3ème paramètre <varname>m</varname> doit par ailleurs être indiqué.
68                             </listitem>
69                         </itemizedlist>
70                     </para>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>m</term>
75                 <listitem>
76                     <para>
77                         Espérance mathématique de la loi de distribution de probabilité sous-jacente (supposée connue).
78                         <itemizedlist>
79                             <listitem>
80                                 "*" mode (par défaut): <varname>m</varname> doit être scalaire
81                             </listitem>
82                             <listitem>
83                                 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.
84                             </listitem>
85                             <listitem>
86                                 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.
87                             </listitem>
88                         </itemizedlist>
89                     </para>
90                     <para>
91                         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.
92                     </para>
93                     <para>
94                         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 :
95                         <itemizedlist>
96                             <listitem>
97                                 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 <literal>variance</literal>. La valeur obtenue et retournée pour celle-ci est alors réputée non biaisée.
98                             </listitem>
99                             <listitem>
100                                 Si la valeur spéciale <literal>m=%nan</literal> est fournie, la <literal>variance</literal> est toujours "normalisée" par n (non n-1) mais est estimée en utilisant l'estimation "empirique"
101                                 <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.
102                             </listitem>
103                         </itemizedlist>
104                     </para>
105                 </listitem>
106             </varlistentry>
107             <varlistentry>
108                 <term>s</term>
109                 <listitem>
110                     Estimation de la variance des valeurs de <varname>x</varname> (pondérées). <varname>s</varname> est un scalaire ou un vecteur ligne ou colonne selon l'option <varname>orien</varname> utilisée.
111                 </listitem>
112             </varlistentry>
113             <varlistentry>
114                 <term>mc</term>
115                 <listitem>
116                     Moyenne pondérée 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.
117                 </listitem>
118             </varlistentry>
119         </variablelist>
120     </refsection>
121     <refsection>
122         <title>Description</title>
123         <para>
124             Cette fonction calcule la variance des valeurs d'un vecteur ou une matrice
125             <varname>x</varname>, chacun des <literal>x(i,j)</literal> étant compté <literal>fre(i,j)</literal> fois.
126             If <varname>x</varname> est complexe, alors <literal>variancef(x, fre,..) = variancef(real(x), fre,..) + variancef(imag(x), fre,..)</literal> est retourné.
127         </para>
128         <para>
129             <literal>s = variancef(x,fre)</literal> (ou <literal>s=variancef(x,fre,"*")</literal>) retourne la variance scalaire calculée à partir de toutes les valeurs de <varname>x</varname>.
130         </para>
131         <para>
132             <literal>s = variancef(x,fre,"r")</literal>(ou <literal>s = variancef(x,fre,1)</literal>) retourne un vecteur ligne <varname>s</varname> tel que pour chaque j,
133             <literal>s(j) = variancef(x(:,j),fre(:,j),..)</literal>.
134         </para>
135         <para>
136             <literal>s = variancef(x,fre,"c")</literal>(ou <literal>s = variancef(x,fre,2)</literal>) retourne un vecteur colonne <varname>s</varname> tel que pour chaque i,
137             <literal>s(i) = variancef(x(i,:),fre(i,:),..)</literal>.
138         </para>
139         <para>
140             Quand la moyenne <varname>m</varname> est fournie, elle est utilisée comme référence dans le calcul de la variance au lieu d'être évaluée intérieurement à partir de <varname>x</varname> (à moins qu'elle ne soit égale à <code>%nan</code> : Voir la description de <varname>m</varname>). Ceci permet de calculer la variance d'un échantillon <varname>x</varname> en regard d'un modèle statistique donné (plutôt que d'extraire une dispersion empirique pour construire le modèle).
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.9546254 0.6283918]
147 fre = [1 2 3; 3 4 3]
148 [s, m] = variancef(x, fre)
149 [s, m] = variancef(x, fre, "r")
150 [s, m] = variancef(x, fre, "c")
151
152 // Exemple #2:
153 x0 = grand(20, 7, "uin", -9,10)+0.4
154 x = matrix((-9:10)+0.4, 5, 4)
155 fre = members(x, x0)        // Calcule les fréquences des éléments de x dans x0
156 [s, m] = variancef(x, fre)  // Doit être égal à variance(x0)
157 [s, m] = variance(x0)
158
159 // Exemple #2 (suite):
160 m = (-9+10)/2+0.4               // Moyenne asymptotique connue (si x0 avait un nombre infini d'éléments)
161 s = variancef(x, fre, "*", m)   // Variance "échantillon" en regard de la vraie moyenne
162 s0 = (10 - (-9))^2 /12          // Variance asymptotique connue
163 s2 = variancef(x, fre, "*", %nan)
164  ]]></programlisting>
165     </refsection>
166     <refsection role="see also">
167         <title>Voir aussi</title>
168         <simplelist type="inline">
169             <member>
170                 <link linkend="variance">variance</link>
171             </member>
172             <member>
173                 <link linkend="mtlb_var">mtlb_var</link>
174             </member>
175             <member>
176                 <link linkend="stdevf">stdevf</link>
177             </member>
178         </simplelist>
179     </refsection>
180     <refsection>
181         <title>Bibliographie</title>
182         <para>
183             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
184         </para>
185     </refsection>
186     <refsection>
187         <title>Historique</title>
188         <revhistory>
189             <revision>
190                 <revnumber>5.5.0</revnumber>
191                 <revdescription>
192                     <itemizedlist>
193                         <listitem>
194                             <para>variancef() peut être appelée avec des nombres complexes.</para>
195                         </listitem>
196                         <listitem>
197                             <para>variancef(x, fre, orien, m) introduit: la vraie moyenne m de la loi de distribution de probabilité sous-jacente peut être utilisée.</para>
198                         </listitem>
199                         <listitem>
200                             <para>variancef(x, fre, orien, %nan) introduit: mean(x, fre,..) est utilisé mais divisé par n valeurs (à la place de n-1)</para>
201                         </listitem>
202                         <listitem>
203                             <para>[s, mc] = variancef(x,fre,..) introduit : la moyenne mc évaluée à partir de x et fre est maintenant retournée</para>
204                         </listitem>
205                     </itemizedlist>
206                 </revdescription>
207             </revision>
208         </revhistory>
209     </refsection>
210 </refentry>