1b3b96ac1d7bca81d1ac49e4a55d622ab4247a52
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / matrixoperations / cumsum.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) 2010 - Serge Steer - 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="cumsum" xml:lang="fr">
17     <refnamediv>
18         <refname>cumsum</refname>
19         <refpurpose>somme cumulative des éléments d'un tableau.</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Séquence d'appel</title>
23         <synopsis>y=cumsum(x)
24             y=cumsum(x,orientation)
25             y=cumsum(x,outtype)
26             y=cumsum(x,orientation,outtype)
27         </synopsis>
28     </refsynopsisdiv>
29
30     <refsection role="parameters">
31         <title>Paramètres</title>
32         <variablelist>
33             <varlistentry>
34                 <term>x</term>
35                 <listitem>
36                     <para>un tableau de réels, de complexes, de booléens, de
37                         polynômes ou de fractions rationnelles.
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>orientation</term>
43                 <listitem>
44                     <para>
45                         Cet argument peut être
46                     </para>
47                     <itemizedlist>
48                         <listitem>
49                             <para>ou une chaîne de caractères pouvant avoir comme
50                                 valeurs: <literal>"*"</literal>,
51                                 <literal>"r"</literal>, <literal>"c"</literal> ou
52                                 <literal>"m"</literal>
53                             </para>
54                         </listitem>
55                         <listitem>
56                             <para>ou bien un nombre à valeur positive entière</para>
57                         </listitem>
58                     </itemizedlist>
59                 </listitem>
60             </varlistentry>
61             <varlistentry>
62                 <term>outtype</term>
63                 <listitem>
64                     <para>
65                         une chaîne de caractères pouvant prendre les valeurs <literal>"native"</literal> ou <literal>"double"</literal>.
66                     </para>
67                 </listitem>
68             </varlistentry>
69             <varlistentry>
70                 <term>y</term>
71                 <listitem>
72                     <para> un scalaire ou un tableau</para>
73                 </listitem>
74             </varlistentry>
75         </variablelist>
76     </refsection>
77     <refsection>
78         <title>Description</title>
79         <para>
80             Renvoie la somme cumulée des éléments d'un tableau.
81             Pour un tableau <term>x</term>,
82             <literal>y=cumsum(x)</literal> renvoie une matrice <term>y</term>
83             de la même taille que <term>x</term>.
84             La valeur <literal>y(i)</literal> est la somme de tous les éléments de <literal>x(1:i)</literal>, <emphasis role="italic">i.e.</emphasis> :
85         </para>
86         <para>
87             <latex><![CDATA[ y(i) = \sum_{k=1}^i x(k)]]></latex>
88         </para>
89         <para>
90             <literal>y=cumsum(x,orientation)</literal> retourne dans
91             <term>y</term> la somme cumulée des éléments de
92             <term>x</term> le long de la dimension donnée par le
93             paramètre <term>orientation</term>:
94         </para>
95         <itemizedlist>
96             <listitem>
97                 <para>
98                     Si <term>orientation</term> est égal à 1 ou "r" alors :
99                 </para>
100                 <para>
101                     <latex><![CDATA[ y(\mathbf{l},j) = \sum_{\mathbf{i}=1}^l x(\mathbf{i},j)]]></latex>
102                 </para>
103                 <para>ou </para>
104                 <para>
105                     <latex><![CDATA[ y(\mathbf{l},j,k,\ldots) = \sum_{\mathbf{i}=1}^l x(\mathbf{i},j,k,\ldots)]]></latex>
106                 </para>
107             </listitem>
108             <listitem>
109                 <para>
110                     Si <term>orientation</term> est égal à 2 ou "c" alors :
111                 </para>
112                 <para>
113                     <latex><![CDATA[ y(i,\mathbf{l}) = \sum_{\mathbf{j}=1}^l x(i,{\mathbf{j})]]></latex>
114                 </para>
115                 <para> ou </para>
116                 <para>
117                     <latex><![CDATA[ y(i,\mathbf{l},k,\ldots) = \sum_{\mathbf{j}=1}^l x(i,\mathbf{j},k,\ldots)]]></latex>
118                 </para>
119             </listitem>
120             <listitem>
121                 <para>
122                     Si <term>orientation</term> est égal à n alors :
123                 </para>
124                 <para>
125                     <latex><![CDATA[ y(i_1,\ldots,i_{n-1},\mathbf{l},i_{n+1},\ldots) = \sum_{\mathbf{i_n}=1}^l x(i_1,\ldots,i_{n-1},\mathbf{i_n},i_{n+1},\ldots)]]></latex>
126                 </para>
127             </listitem>
128             <listitem>
129                 <para>
130                     <literal>y=cumsum(x,"*")</literal> est équivalent à <literal>y=cumsum(x)</literal>
131                 </para>
132             </listitem>
133             <listitem>
134                 <para>
135                     <literal>y=cumsum(x,"m")</literal> est équivalent à
136                     <literal>y=cumsum(x,orientation)</literal> où
137                     <term>orientation</term> est l'index de la première
138                     dimension de <term>x</term> qui est plus grande que
139                     1. Cette option est utilisé pour la compatibilité avec Matlab.
140                 </para>
141             </listitem>
142         </itemizedlist>
143         <para>
144             L'argument <term>outtype</term> gère la façon dont le produit est réalisé :
145         </para>
146         <itemizedlist>
147             <listitem>
148                 <para>Pour les matrices de doubles, de polynômes, de fractions rationnelles,
149                     l'évaluation est toujours effetuée sur des nombres à virgule flottante.
150                     Les options <literal>"double"</literal> ou <literal>"native"</literal> sont équivalentes
151                     (par défaut, <literal>outtype = "double"</literal>).
152                 </para>
153             </listitem>
154             <listitem>
155                 <para>Pour les tableaux d'entiers,</para>
156                 <para>
157                     si <literal>outtype="native"</literal>, le calcul est effectué sur des nombres entiers
158                     (modulo 2^b, où b est le nombre de bits utilisés).
159                 </para>
160                 <para>
161                     si <literal>outtype="double"</literal>, le calcul est effectué sur
162                     des nombres à virgule flottante.
163                 </para>
164                 <para>
165                     La valeur par défaut est <literal>outtype="native"</literal>
166                 </para>
167             </listitem>
168             <listitem>
169                 <para>Pour les tableaux de booléens,</para>
170                 <para>
171                     si <literal>outtype="native"</literal>, le calcul est effectué sur des booléens
172                     (* est remplacée par &amp;),
173                 </para>
174                 <para>
175                     si <literal>outtype="double"</literal>, le calcul est effectué sur des nombres
176                     à virgule flottante (%t est remplacé par 1 et %f par 0).
177                 </para>
178                 <para>
179                     La valeur par défaut est <literal>outtype="double"</literal>
180                 </para>
181             </listitem>
182         </itemizedlist>
183         <note>
184             Cette fonction s'applique avec les mêmes règles aux <link linkend="sparse">matrices creuses</link> et aux hypermatrices.
185         </note>
186     </refsection>
187     <refsection>
188         <title>Exemples</title>
189         <programlisting role="example"><![CDATA[
190 A=[1,2;3,4];
191 cumsum(A)
192 cumsum(A,1)
193
194 I=uint8([2 95 103;254 9 0])
195 cumsum(I) //native evaluation
196 cumsum(I,"double")
197 cumsum(I,2,"double")
198
199 s=poly(0,"s");
200 P=[s,%i+s;s^2,1];
201 cumsum(P),
202 cumsum(P,2)
203
204 B=[%t %t %f %f];
205 cumsum(B) //evaluation in float
206 cumsum(B,"native") //similar to or(B)
207
208  ]]></programlisting>
209     </refsection>
210     <refsection role="see also">
211         <title>Voir aussi</title>
212         <simplelist type="inline">
213             <member>
214                 <link linkend="cumprod">cumprod</link>
215             </member>
216             <member>
217                 <link linkend="sum">sum</link>
218             </member>
219         </simplelist>
220     </refsection>
221 </refentry>