summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/cummin.html
blob: bda90dc2c8f1631038a61c60cd347112afeab2d1 (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
77
78
79
80
81
82
83
84
85
86
87
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>cummin</title>
    <style type="text/css" media="all">
      @import url("scilab_code.css");
      @import url("xml_code.css");
      @import url("c_code.css");
      @import url("style.css");
    </style>
  </head>
  <body>
    <div class="manualnavbar">
    <table width="100%"><tr>
      <td width="30%">
    	<span class="previous"><a href="cummax.html">&lt;&lt; cummax</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="czt.html">czt &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>



    <span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> &gt;&gt; <a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a> &gt; cummin</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">cummin</h1>
    <p class="refpurpose">Cumulative minimum</p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre><span class="default">M</span><span class="default"> = </span><span class="functionid">cummin</span><span class="default">(</span><span class="default">A</span><span class="default">)</span>
<span class="default">returns</span> <span class="default">the</span> <span class="default">cumulative</span> <span class="default">minimum</span> <span class="default">of</span> <span class="default">the</span> <span class="default">arguments</span> <span class="default">of</span> <span class="default">A</span><span class="default">. </span><span class="default">The</span> <span class="default">dimension</span>
<span class="default">of</span> <span class="default">M</span> <span class="default">is</span> <span class="default">same</span> <span class="default">as</span> <span class="default">the</span> <span class="default">dimension</span> <span class="default">of</span> <span class="default">A</span><span class="default">. </span><span class="default">If</span> <span class="default">A</span> <span class="default">is</span> <span class="default">a</span><span class="default"> 2</span><span class="default">D</span> <span class="default">matrix</span><span class="default">, </span><span class="default">the</span> <span class="default">operation</span>
<span class="default">is</span> <span class="default">performed</span> <span class="default">along</span> <span class="default">the</span> <span class="default">columns</span><span class="default">. </span><span class="default">For</span> <span class="default">a</span> <span class="default">hypermatrix</span><span class="default">, </span><span class="default">the</span> <span class="default">operation</span> <span class="default">is</span>
<span class="default">performed</span> <span class="default">along</span> <span class="default">the</span> <span class="default">first</span> <span class="default">non</span><span class="default">-</span><span class="default">zero</span> <span class="default">dimension</span>
<span class="default">M</span><span class="default"> = </span><span class="functionid">cummin</span><span class="default">(</span><span class="default">A</span><span class="default">,</span><span class="default">dim</span><span class="default">)</span>
<span class="default">The</span> <span class="default">operation</span> <span class="default">is</span> <span class="default">performed</span> <span class="default">along</span> <span class="default">the</span> <span class="default">dimension</span> <span class="default">specified</span> <span class="default">by</span> <span class="default">dim</span>
<span class="default">M</span><span class="default"> = </span><span class="functionid">cummin</span><span class="default">(</span><span class="default">_</span><span class="default">,</span><span class="default">direction</span><span class="default">)</span>
<span class="default">direction</span> <span class="default">specifies</span> <span class="default">as</span> <span class="default">the</span> <span class="default">direction</span> <span class="default">of</span> <span class="default">operation</span></pre></div></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl></dl></div>

<div class="refsection"><h3 class="title">Examples</h3>
   <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabnumber">1</span><span class="scilabopenclose">)</span> <span class="scilabid">Cumulative</span> <span class="scilabid">minimum</span> <span class="scilabid">values</span> <span class="scilabid">in</span> <span class="scilabid">a</span> <span class="scilabid">vector</span>
<span class="scilabid">v</span> <span class="scilaboperator">=</span> <span class="scilabopenclose">[</span><span class="scilabnumber">8</span> <span class="scilabnumber">9</span> <span class="scilabnumber">1</span> <span class="scilabnumber">10</span> <span class="scilabnumber">6</span> <span class="scilabnumber">1</span> <span class="scilabnumber">3</span> <span class="scilabnumber">6</span> <span class="scilabnumber">10</span> <span class="scilabnumber">10</span><span class="scilabopenclose">]</span>
<span class="scilabid">M</span> <span class="scilaboperator">=</span> <span class="scilabid">cummin</span><span class="scilabopenclose">(</span><span class="scilabid">v</span><span class="scilabopenclose">)</span>

<span class="scilabid">Expected</span> <span class="scilabid">output</span><span class="scilabspecial">:</span> <span class="scilabopenclose">[</span><span class="scilabnumber">8</span> <span class="scilabnumber">8</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span> <span class="scilabnumber">1</span><span class="scilabopenclose">]</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>

<div class="refsection"><h3 class="title">Authors</h3>
   <ul class="itemizedlist"><li class="member">Ayush Baid</li></ul></div>

<div class="refsection"><h3 class="title">See also</h3>
   <ul class="itemizedlist"></ul></div>
    <br />

    <div class="manualnavbar">
    <table width="100%">
    <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
      <td width="30%">
    	<span class="previous"><a href="cummax.html">&lt;&lt; cummax</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="czt.html">czt &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>
  </body>
</html>