summaryrefslogtreecommitdiff
path: root/help/en_US/cummax.xml
blob: 76c863a87c9c3cdda76aa1dc6a0d93db86ad0c3d (plain)
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
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from cummax.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="cummax" 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:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>cummax</refname>
    <refpurpose>Cumulative maximum</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   M = cummax(A)
   returns the cumulative maximum of the arguments of A. The dimension
   of M is same as the dimension of A. If A is a 2D matrix, the operation
   is performed along the columns. For a hypermatrix, the operation is
   performed along the first non-zero dimension
   M = cummax(A,dim)
   The operation is performed along the dimension specified by dim
   M = cummax(_,direction)
   direction specifies as the direction of operation
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   </variablelist>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
1) Cumulative maximum values in a vector
v = [8 9 1 10 6 1 3 6 10 10]
M = cummax(v)

Expected output: [8 8 1 1 1 1 1 1 1 1]

   ]]></programlisting>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Ayush Baid</member>
   </simplelist>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   </simplelist>
</refsection>
</refentry>