blob: e385ac0d195c2790bfe74175d5e9e0d58d722b4a (
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
71
72
73
74
75
76
|
<?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)
M = cummax(A,dim)
M = cummax(_,direction)
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry><term>A:</term>
<listitem><para> positive integer value<para></para>For complex elements, cummax compares the magnitude of elements. If the magnitude are same, phase angles are compared.</para></listitem></varlistentry>
<varlistentry><term>dim:</term>
<listitem><para> Dimension to operate along<para></para>If no dimension is specified, then the default value is the first array dimension whose value is greater than 1 </para></listitem></varlistentry>
<varlistentry><term>direction:</term>
<listitem><para>Direction of cumulation<para></para>If the direction is forward, cummax works from 1 to end of the active dimension. Otherwise, it works in the opposite sense</para></listitem></varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
The function returns the cumulative maximum elements of the input vector/array.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
Cumulative maximum values in a vector
v = [8 9 1 10 6 1 3 6 10 10]
M = cummax(v)
//Expected output: [8 9 9 10 10 10 10 10 10 10]
]]></programlisting>
</refsection>
<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Ayush Baid</member>
</simplelist>
</refsection>
</refentry>
|
