summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/shiftdata.html
blob: 22d0ac0ec751f51667f3e1ac8eeefb544e67619c (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
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>shiftdata</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="shanwavf.html">&lt;&lt; shanwavf</a></span>

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

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

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



<<<<<<< HEAD
    <span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> &gt;&gt; <a href="section_5118e822ecc2888aa80042108de4932e.html">FOSSEE Signal Processing Toolbox</a> &gt; shiftdata</span>
=======
    <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; shiftdata</span>
>>>>>>> 3f916032cc0b2efdeafb838dd10e1141ead2cb27

    <br /><br />
    <div class="refnamediv"><h1 class="refname">shiftdata</h1>
    <p class="refpurpose">Shifts data by rearranging dimensions</p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre></pre></div></div>

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

<div class="refsection"><h3 class="title">Description</h3>
   <p class="para">[y,perm,nshifts]=shiftdata(x,dim)
Shifts the entries along dimension dim in x to the first column and returns the permutation vector in perm
[y,perm,nshifts]=shiftdata(x)
Shifts the entries along dimension dim in x to the first column and returns the number of shifts in nshifts</p></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="scilabcomment">//When dim is specified:</span>
<span class="scilabid">x</span><span class="scilaboperator">=</span><a class="scilabcommand" href="scilab://testmatrix">testmatrix</a><span class="scilabopenclose">(</span><span class="scilabstring">&#0039;</span><span class="scilabstring">magi</span><span class="scilabstring">&#0039;</span><span class="scilabdefault">,</span><span class="scilabnumber">3</span><span class="scilabopenclose">)</span>
<span class="scilabid">x</span>  <span class="scilaboperator">=</span>

<span class="scilabnumber">8.</span>    <span class="scilabnumber">1.</span>    <span class="scilabnumber">6.</span>
<span class="scilabnumber">3.</span>    <span class="scilabnumber">5.</span>    <span class="scilabnumber">7.</span>
<span class="scilabnumber">4.</span>    <span class="scilabnumber">9.</span>    <span class="scilabnumber">2.</span>
<span class="scilabopenclose">[</span><span class="scilabid">y</span><span class="scilabdefault">,</span><span class="scilabid">perm</span><span class="scilabdefault">,</span><span class="scilabid">nshifts</span><span class="scilabopenclose">]</span> <span class="scilaboperator">=</span> <span class="scilabid">shiftdata</span><span class="scilabopenclose">(</span><span class="scilabid">x</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabopenclose">)</span>
<span class="scilabid">nshifts</span>  <span class="scilaboperator">=</span>

<span class="scilabopenclose">[</span><span class="scilabopenclose">]</span>
<span class="scilabid">perm</span>  <span class="scilaboperator">=</span>

<span class="scilabnumber">2.</span>    <span class="scilabnumber">1.</span>
<span class="scilabid">y</span>  <span class="scilaboperator">=</span>

<span class="scilabnumber">8.</span>    <span class="scilabnumber">3.</span>    <span class="scilabnumber">4.</span>
<span class="scilabnumber">1.</span>    <span class="scilabnumber">5.</span>    <span class="scilabnumber">9.</span>
<span class="scilabnumber">6.</span>    <span class="scilabnumber">7.</span>    <span class="scilabnumber">2.</span>
<span class="scilabcomment">//When dim is not specified:</span>
<span class="scilabid">x</span><span class="scilaboperator">=</span><span class="scilabnumber">1</span><span class="scilabspecial">:</span><span class="scilabnumber">5</span>
<span class="scilabid">x</span>  <span class="scilaboperator">=</span>

<span class="scilabnumber">1.</span>    <span class="scilabnumber">2.</span>    <span class="scilabnumber">3.</span>    <span class="scilabnumber">4.</span>    <span class="scilabnumber">5.</span>
<span class="scilabopenclose">[</span><span class="scilabid">y</span><span class="scilabdefault">,</span><span class="scilabid">perm</span><span class="scilabdefault">,</span><span class="scilabid">nshifts</span><span class="scilabopenclose">]</span> <span class="scilaboperator">=</span> <span class="scilabid">shiftdata</span><span class="scilabopenclose">(</span><span class="scilabid">x</span><span class="scilabopenclose">)</span>
<span class="scilabid">nshifts</span>  <span class="scilaboperator">=</span>

<span class="scilabnumber">1.</span>
<span class="scilabid">perm</span>  <span class="scilaboperator">=</span>

<span class="scilabopenclose">[</span><span class="scilabopenclose">]</span>
<span class="scilabid">y</span>  <span class="scilaboperator">=</span>

<span class="scilabnumber">1.</span>
<span class="scilabnumber">2.</span>
<span class="scilabnumber">3.</span>
<span class="scilabnumber">4.</span>
<span class="scilabnumber">5.</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">See also</h3>
   <ul class="itemizedlist"><li class="member"><a href="scilab://permute" class="link">permute</a></li>
   <li class="member"><a href="unshiftdata.html" class="link">unshiftdata</a></li>
   <li class="member"><a href="scilab://Author" class="link">Author</a></li>
   <li class="member"><a href="scilab://Ankur" class="link">Mallick</a></li></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="shanwavf.html">&lt;&lt; shanwavf</a></span>

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

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

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