* variance is now vectorized and allows the syntax variance(x,"*",w).
[scilab.git] / scilab / modules / statistics / help / fr_FR / descriptive_statistics / 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) 2000 - INRIA - Carlos Klimann
5  * Copyright (C) 2013 - Samuel GOUGEON
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <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">
15     <refnamediv>
16         <refname>variance</refname>
17         <refpurpose>variance des éléments d'un vecteur, matrice (voire hypermatrice) réel ou complexe</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Séquence d'appel</title>
21         <synopsis>s = variance(x [,orien [,w]])
22             s = variance(x,'r') or s = variance(x,1)
23             s = variance(x,'c') or s = variance(x,2)
24             s = variance(x,'*',1)
25             s = variance(x,'r',1)
26             s = variance(x,'c',1)
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Paramètres</title>
31         <variablelist>
32             <varlistentry>
33                 <term>x</term>
34                 <listitem>
35                     <para>
36                         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,"*",1)</literal>
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>orien</term>
42                 <listitem>
43                     <para>
44                         variance selon les lignes ou les colonnes de <literal>x</literal>. Les valeurs possibles sont
45                         <itemizedlist>
46                             <listitem>
47                                 1 or "r" : calcul par colonne. Le résultat est un vecteur <literal>r</literal>angée (ligne)
48                             </listitem>
49                             <listitem>
50                                 2 or "c" : calcul par ligne. Le résultat est une <literal>c</literal>olonne
51                             </listitem>
52                             <listitem>
53                                 "*" : calcul tous éléments de <literal>x</literal> confondus (mode utilisé a priori); utile si le 3ème paramètre <literal>w</literal> doit par ailleurs être indiqué.
54                             </listitem>
55                         </itemizedlist>
56                     </para>
57                 </listitem>
58             </varlistentry>
59             <varlistentry>
60                 <term>w</term>
61                 <listitem>
62                     <para>w : indique le type de normalisation de la variance : 
63                         <itemizedlist>
64                             <listitem>
65                                 0 : la somme des écarts quadratiques est divisée par (nE-1), où nE est le nombre d'écarts sommés (mode de calcul utilisé a priori). La variance ainsi estimée est non biaisée (l'espérance de la variable aléatoire n'est pas connue a priori ; elle est estimée par la moyenne des valeurs de x). nE est le nombre nR de lignes de <literal>x</literal> si "r" est utilisée ; ou le nombre nC de colonnes si "c" est utilisée ; ou le nombre total nR*nC d'éléments, sinon.
66                             </listitem>
67                             <listitem>1 : la somme des écarts quadratiques est divisée par nE. La variance résultante est non biaisée uniquement si l'espérance de la variable aléatoire est connue (Scilab ne permet actuellement pas de l'indiquer en paramètre).
68                             </listitem>
69                         </itemizedlist>
70                     </para>
71                 </listitem>
72             </varlistentry>
73         </variablelist>
74     </refsection>
75     <refsection>
76         <title>Description</title>
77         <para>
78             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.
79         </para>
80         <para>
81             Pour un vecteur, une matrice ou une hypermatrice <literal>x</literal>, <literal>s = variance(x)</literal> ou <literal>s = variance(x, "*", 1)</literal>
82             retourne  dans le scalaire <literal>s</literal> la variance de tous les éléments de <literal>x</literal>.
83         </para>
84         <para>
85             <literal>s = variance(x,'c')</literal> (ou indifféremment <literal>s = variance(x, 2)</literal>) calcule la variance de chaque ligne. 
86             Le vecteur colonne <literal>s</literal> est retourné, avec <literal>s(j) = variance(x(j,:),..)</literal>.
87         </para>
88         <para>
89             <literal>s = variance(x,'r')</literal> (ou indifféremment <literal>s = variance(x,1)</literal>) calcule la variance de chaque colonne. 
90             Le vecteur ligne <literal>s</literal> est retourné, avec <literal>s(i) = variance(x(:,i),..)</literal>.
91         </para>
92     </refsection>
93     <refsection>
94         <title>Exemples</title>
95         <programlisting role="example"><![CDATA[ 
96 x = [ 0.2113249 0.0002211 0.6653811;0.7560439 0.4453586 0.6283918 ]
97 s = variance(x)
98 s = variance(x, "r")
99 s = variance(x, "c")
100
101 // with complex numbers
102 x = rand(4,3) + rand(4,3)*%i
103 s = variance(x)
104 s = variance(x, "*", 1) // doit être inférieure à la précédente valeur
105 s = variance(x, "r")
106 s = variance(x, "r", 1)
107 s = variance(x, "c")
108
109 // with an hypermatrix
110 x = rand(3,2,2)
111 s = variance(x)
112 s = variance(x, "*", 1) // doit être inférieure à la précédente valeur
113 // s = variance(x, "r")  // utilisation non admise pour une hypermatrice
114 // s = variance(x, "c")  // utilisation non admise pour une hypermatrice
115  ]]></programlisting>
116     </refsection>
117     <refsection role="see also">
118         <title>Voir aussi</title>
119         <simplelist type="inline">
120             <member>
121                 <link linkend="mtlb_var">mtlb_var</link>
122             </member>
123         </simplelist>
124     </refsection>
125     <refsection>
126         <title>Bibliographie</title>
127         <para>
128             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
129         </para>
130     </refsection>
131     <refsection>
132         <title>Historique</title>
133         <revhistory>
134             <revision>
135                 <revnumber>5.4.1</revnumber>
136                 <revdescription>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</revdescription>
137             </revision>
138         </revhistory>
139     </refsection>
140     
141 </refentry>