[doc] misc fix & improvements
[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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:id="cumsum" xml:lang="fr">
20     <refnamediv>
21         <refname>cumsum</refname>
22         <refpurpose>sommes partielles cumulatives des éléments d'un tableau.</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Séquence d'appel</title>
26         <synopsis>
27             y = cumsum(x)
28             y = cumsum(x, outtype)
29             y = cumsum(x, orientation)
30             y = cumsum(x, orientation, outtype)
31         </synopsis>
32     </refsynopsisdiv>
33
34     <refsection role="parameters">
35         <title>Arguments</title>
36         <variablelist>
37             <varlistentry>
38                 <term>x</term>
39                 <listitem>
40                     <para>
41                         tableau de booléens, de nombres entiers, réels, ou complexes, de
42                         polynômes, ou de fractions rationnelles. Les hypermatrices ou les matrices
43                         booléennes ou numériques creuses sont acceptées.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>orientation</term>
49                 <listitem>
50                     <para>
51                         direction selon laquelle les sommes partielles cumulatives sont calculées :
52                         Cet argument peut être
53                     </para>
54                     <itemizedlist>
55                         <listitem>
56                             <para>le caractère <literal>"*"</literal>,
57                                 <literal>"r"</literal>, <literal>"c"</literal> ou
58                                 <literal>"m"</literal>.
59                             </para>
60                         </listitem>
61                         <listitem>
62                             <para>
63                               un nombre entier 1 ≤ orientation ≤ ndims(x) : n° de la dimension
64                               selon laquelle les sommes partielles cumulatives directionnelles doivent
65                               être calculées. 1 et "r", ou 2 et "c", sont equivalents.
66                             </para>
67                         </listitem>
68                     </itemizedlist>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>outtype</term>
73                 <listitem>
74                     <para>
75                         mot <literal>"native"</literal> ou <literal>"double"</literal>.
76                         <literal>"double"</literal> convertit préalablement en nombres décimaux
77                         les booléens ou les entiers fournis.
78                     </para>
79                 </listitem>
80             </varlistentry>
81             <varlistentry>
82                 <term>y</term>
83                 <listitem>
84                     <para>tableau de tailles identiques à celles de <varname>x</varname>.</para>
85                 </listitem>
86             </varlistentry>
87         </variablelist>
88     </refsection>
89     <refsection>
90         <title>Description</title>
91         <para>
92             <emphasis role="bold">y = cumsum(x)</emphasis> calcule et fournit les sommes partielles
93             cumulatives <literal>y(i)=sum(x(1:i))</literal>,
94             <emphasis role="italic">i.e.</emphasis> :
95         </para>
96         <para>
97             <latex alt="y(i) = ∑u=1→i x(u)"><![CDATA[ y(i) = \sum_{u=1}^i x(u)]]></latex>
98         </para>
99         <para>
100             <emphasis role="bold">y = cumsum(x, orientation)</emphasis> calcule et fournit dans
101             <term>y</term> les sommes partielles cumulatives des éléments de
102             <term>x</term> selon la direction spécifiée par <term>orientation</term> :
103         </para>
104         <itemizedlist>
105             <listitem>
106                 <para>
107                     Si <term>orientation</term> est égal à 1 ou "r" alors :
108                 </para>
109                 <para>
110                     <latex alt="y(i,j) = ∑u=1→i x(u,j)"><![CDATA[
111                         y(\mathbf{i},j) = \sum_{u=1}^{\mathbf{i}} x(\mathbf{u},j)   ]]>
112                     </latex>, ou pour un tableau N-Dimensionnel :
113                 </para>
114                 <para>
115                     <latex alt="y(i,j,k,…) = ∑u=1→i x(u,j,k,…)"><![CDATA[
116                         y(\mathbf{i},j,k,\ldots) = \sum_{u=1}^{\mathbf{i}} x(\mathbf{u},j,k,\ldots)  ]]>
117                     </latex>
118                 </para>
119             </listitem>
120             <listitem>
121                 <para>
122                     Si <term>orientation</term> est égal à 2 ou "c" alors :
123                 </para>
124                 <para>
125                     <latex alt="y(i,j) = ∑u=1→j x(i,u)"><![CDATA[
126                         y(i,\mathbf{j}) = \sum_{u=1}^{\mathbf{j}} x(i,{\mathbf{u})  ]]>
127                     </latex>, ou pour un tableau N-Dimensionnel :
128                 </para>
129                 <para>
130                     <latex alt="y(i,j,k,…) = ∑u=1→j x(i,u,k,…)"><![CDATA[
131                         y(i,\mathbf{j},k,\ldots) = \sum_{u=1}^{\mathbf{j}} x(i,\mathbf{u},k,\ldots) ]]>
132                     </latex>
133                 </para>
134             </listitem>
135             <listitem>
136                 <para>
137                     Si <term>orientation</term> est égal à n alors :
138                 </para>
139                 <para>
140                     <latex alt="y(i₁,…,iₙ₋₁, iₙ,iₙ₊₁,…) = ∑u=1…iₙ  x(i₁,…,iₙ₋₁, u,iₙ₊₁,…)"><![CDATA[
141                         y(i_1,\ldots,i_{n-1},\mathbf{i_{n}},i_{n+1},\ldots) =
142                         \sum_{u=1}^{\mathbf{i_n}} x(i_1,\ldots,i_{n-1},\mathbf{u},i_{n+1},\ldots) ]]>
143                     </latex>
144                 </para>
145             </listitem>
146             <listitem>
147                 <para>
148                     <emphasis role="bold">y = cumsum(x,"*")</emphasis> est équivalent à
149                     <literal>y = cumsum(x)</literal>
150                 </para>
151             </listitem>
152             <listitem>
153                 <para>
154                     <emphasis role="bold">y = cumsum(x, "m")</emphasis> est équivalent à
155                     <literal>y = cumsum(x, orientation)</literal>, où
156                     <term>orientation</term> est le n° de la première dimension de <term>x</term>
157                     plus grande que 1. Cette option est utilisé pour compatibilité avec Matlab.
158                 </para>
159             </listitem>
160         </itemizedlist>
161         <para>
162             L'argument <term>outtype</term> gère la façon dont le produit est réalisé :
163         </para>
164         <itemizedlist>
165             <listitem>
166                 <para>
167                     Pour les matrices de nombres décimaux ou complexes, de polynômes, ou de
168                     fractions rationnelles, les calculs sont effectués en virgule flottante.
169                     Les options <literal>"double"</literal> ou <literal>"native"</literal>
170                     sont équivalentes.
171                 </para>
172             </listitem>
173             <listitem>
174                 <para>Pour les tableaux d'entiers,</para>
175                 <para>
176                     Par défaut ou si <literal>outtype="native"</literal>, les calculs sont
177                     effectués en arithmétique entière (modulo 2^b, où b est le nombre de bits utilisés).
178                 </para>
179                 <para>
180                     Si <literal>outtype="double"</literal>, les calculs sont effectués après
181                     conversion en nombres décimaux, et les résultats sont fournis en entiers
182                     décimaux.
183                 </para>
184             </listitem>
185             <listitem>
186                 <para>Pour les tableaux de booléens,</para>
187                 <para>
188                     si <literal>outtype="native"</literal>, le calcul est effectué sur des booléens
189                     (* est remplacée par &amp;),
190                 </para>
191                 <para>
192                     si <literal>outtype="double"</literal>, le calcul est effectué sur des nombres
193                     à virgule flottante (%t est remplacé par 1 et %f par 0).
194                 </para>
195                 <para>
196                     La valeur par défaut est <literal>outtype="double"</literal>
197                 </para>
198             </listitem>
199         </itemizedlist>
200         <warning>
201             Lorsque <varname>x</varname> est une matrice creuse, garder à l'esprit que la densité
202             de la matrice <varname>y</varname> résultante sera presque toujours proche de 100%.
203         </warning>
204     </refsection>
205     <refsection>
206         <title>Exemples</title>
207         <programlisting role="example"><![CDATA[
208 A = [1 , 2 ; 3 , 4];
209 cumsum(A)
210 cumsum(A,1)
211
212 I = uint8([2 95 103;254 9 0])
213 cumsum(I) //native evaluation
214 cumsum(I,"double")
215 cumsum(I,2,"double")
216
217 s = poly(0,"s");
218 P = [s, %i+s ; s^2, 1];
219 cumsum(P),
220 cumsum(P,2)
221
222 B = [%t %t %f %f];
223 cumsum(B) //evaluation in float
224 cumsum(B, "native") //similar to or(B)
225  ]]></programlisting>
226     </refsection>
227     <refsection role="see also">
228         <title>Voir aussi</title>
229         <simplelist type="inline">
230             <member>
231                 <link linkend="cumprod">cumprod</link>
232             </member>
233             <member>
234                 <link linkend="sum">sum</link>
235             </member>
236         </simplelist>
237     </refsection>
238 </refentry>