1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2008 - INRIA
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
*
-->
<refentry version="5.0-subset Scilab" xml:id="cumsum" xml:lang="en"
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">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>cumsum</refname>
<refpurpose>cumulative sum</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>y=cumsum(x)
y=cumsum(x,'r') or y=cumsum(x,1)
y=cumsum(x,'c') or y=cumsum(x,2)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>x</term>
<listitem>
<para>vector or matrix (real or complex)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>y</term>
<listitem>
<para>vector or matrix (real or complex)</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>For a vector or a matrix <literal>x</literal>,
<literal>y=cumsum(x)</literal> returns in <literal>y</literal> the
cumulative sum of all the entries of <literal>x</literal> taken
columnwise.</para>
<para><literal>y=cumsum(x,'c')</literal> (or, equivalently,
<literal>y=cumsum(x,2)</literal>) returns in <literal>y</literal> the
cumulative sum of the columns of <literal>x</literal>: <literal>
y(i,:)=cumsum(x(i,:))</literal></para>
<para><literal>y=cumsum(x,'r')</literal> (or, equivalently,
<literal>y=cumsum(x,1)</literal>) returns in <literal>y</literal> the
cumulative sum of the rows of <literal>x</literal>: <literal>
y(:,i)=cumsum(x(:,i))</literal></para>
<para><literal>y=cumsum(x,'m')</literal> is the cumulative sum along the
first non singleton dimension of <literal>x</literal> (for compatibility
with Matlab).</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
A=[1,2;3,4];
cumsum(A)
cumsum(A,'r')
cumsum(A,'c')
a=rand(3,4)+%i;
[m,n]=size(a);
w=zeros(a);
w(1,:)=a(1,:);
for k=2:m;
w(k,:)=w(k-1,:)+a(k,:);
end;
w-cumsum(a,'r')
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member><link linkend="cumprod">cumprod</link></member>
<member><link linkend="sum">sum</link></member>
</simplelist>
</refsection>
</refentry>
|
