[statistics] corrected %hm_stdev to fix all tests in statistics
[scilab.git] / scilab / modules / statistics / help / fr_FR / descriptive_statistics / stdev.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
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="stdev">
17     <refnamediv>
18         <refname>stdev</refname>
19         <refpurpose>écart-type des termes d'une matrice</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntaxe</title>
23         <synopsis>
24             y = stdev(x)
25             y = stdev(x, '*')
26             y = stdev(x, 'r')
27             y = stdev(x, 'c')
28             y = stdev(x, orien, m)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Paramètres</title>
33         <variablelist>
34             <varlistentry>
35                 <term>x</term>
36                 <listitem>
37                     <para>vecteur, matrice ou hypermatrice réelle
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>y</term>
43                 <listitem>
44                     <para>scalaire, vecteur ou matrice réelle
45                     </para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>orien</term>
50                 <listitem>
51                     <para>
52                         <literal>"*"</literal> (par défaut), <literal>"r"</literal> ou 1,
53                         <literal>"c"</literal> ou 2, ou un entier &lt;= ndims(x): direction selon
54                         laquelle l'écart-type est calculé.
55                     </para>
56                 </listitem>
57             </varlistentry>
58             <varlistentry>
59                 <term>m</term>
60                 <listitem>
61                     <para>réel : scalaire, vecteur ou hypermatrice, la moyenne a priori</para>
62                 </listitem>
63             </varlistentry>
64         </variablelist>
65     </refsection>
66     <refsection>
67         <title>Description</title>
68         <para>
69             stdev calcule l'estimateur sans biais de l'écart-type (normalisé par N-1, ou N est le nombre d'échantillons).
70             Si <varname>m</varname> est présent, alors <code>stdev</code> retourne l'écart quadratique moyen, normalisé par N,
71             en utilisant la moyenne a priori définie par <varname>m</varname>.
72         </para>
73         <para>
74             Pour un vecteur ou une matrice <literal>x</literal>, <literal>y=stdev(x)</literal> renvoie dans <literal>y</literal> l'écart-type des termes de <literal>x</literal>.
75         </para>
76         <para>
77             <literal>y=stdev(x,'r')</literal> (ou <literal>y=stdev(x,1)</literal>) est l'écart-type suivant l'indice de ligne. Chaque composante du vecteur ligne <literal>y</literal> contient l'écart-type de chaque colonne de <literal>x</literal>.
78         </para>
79         <para>
80         </para>
81         <para>
82             <literal>y=stdev(x,'c')</literal> (ou <literal>y=stdev(x,2)</literal>) est l'écart-type selon l'indice de colonne. Chaque composante du vecteur colonne <literal>y</literal> contient l'écart-type de chaque ligne de <literal>x</literal>.
83         </para>
84         <para>
85             Par extension, <literal>y=stdev(x,n)</literal> avec <literal>n</literal> un entier positif
86             retourne la déviation suivant la <literal>n</literal>-ème dimension.
87         </para>
88     </refsection>
89     <refsection>
90         <title>Exemples</title>
91         <programlisting role="example"><![CDATA[
92 A = [1 2 10; 7 7.1 7.01];
93 stdev(A)
94 stdev(A, 'r')
95 stdev(A, 'c')
96 stdev(A,  2 )
97
98 // Ecart-type par rapport à une moyenne théorique connue a priori (par construction) :
99 A = grand(10, 10, "nor", 7.5, 3);
100 stdev(A) / 3             // Moyenne inconnue => estimée d'après A avant d'y référer l'écart-type
101 stdev(A, '*', 7.5) / 3   // Utilisation de la moyenne consignée pour le tirage aléatoire avec grand()
102
103 // Avec une hypermatrice :
104 A = grand(3, 5, 30, "nor", 4.1, 1.5);
105 stdev(A) / 1.5
106 sd = stdev(A, 3, 4.1) / 1.5
107 mean(sd)
108
109  ]]></programlisting>
110     </refsection>
111     <refsection role="see also">
112         <title>Voir aussi</title>
113         <simplelist type="inline">
114             <member>
115                 <link linkend="nanstdev">nanstdev</link>
116             </member>
117             <member>
118                 <link linkend="stdevf">stdevf</link>
119             </member>
120             <member>
121                 <link linkend="sum">sum</link>
122             </member>
123             <member>
124                 <link linkend="median">median</link>
125             </member>
126             <member>
127                 <link linkend="mean">mean</link>
128             </member>
129         </simplelist>
130     </refsection>
131     <refsection>
132         <title>Historique</title>
133         <revhistory>
134             <revision>
135                 <revnumber>5.5.0</revnumber>
136                 <revdescription>
137                     Peut désormais calculer l'écart-type moyen quadratique en utilisant la moyenne a priori définie par <varname>m</varname>
138                 </revdescription>
139             </revision>
140             <revision>
141                 <revnumber>6.0</revnumber>
142                 <revdescription>
143                     stdev(x, orien>ndims(x)) ne donne plus zeros(x) mais produit une erreur.
144                 </revdescription>
145             </revision>
146         </revhistory>
147     </refsection>
148 </refentry>