summaryrefslogtreecommitdiff
path: root/help/en_US/cummax.xml
diff options
context:
space:
mode:
authorttt2018-12-06 13:42:14 +0530
committerttt2018-12-06 13:42:14 +0530
commitd6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795 (patch)
treefdbe9d1a10e7c256e86d7efae276fa75615cd0ba /help/en_US/cummax.xml
parent3ffa5ac619587eadfdb4ffd3e2fee57fee385e21 (diff)
downloadFOSSEE-Signal-Processing-Toolbox-d6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795.tar.gz
FOSSEE-Signal-Processing-Toolbox-d6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795.tar.bz2
FOSSEE-Signal-Processing-Toolbox-d6e8cfd86be242d0a1a09a1ef7d8b7f3d12af795.zip
code by jitendra and added more test4.sce
Diffstat (limited to 'help/en_US/cummax.xml')
-rw-r--r--help/en_US/cummax.xml34
1 files changed, 14 insertions, 20 deletions
diff --git a/help/en_US/cummax.xml b/help/en_US/cummax.xml
index e385ac0..5d81b71 100644
--- a/help/en_US/cummax.xml
+++ b/help/en_US/cummax.xml
@@ -25,42 +25,32 @@
<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>
-
- <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
+1) 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]
+Expected output: [8 9 9 10 10 10 10 10 10 10]
]]></programlisting>
</refsection>
@@ -72,5 +62,9 @@ M = cummax(v)
</simplelist>
</refsection>
-
+<refsection>
+ <title>See also</title>
+ <simplelist type="inline">
+ </simplelist>
+</refsection>
</refentry>