summaryrefslogtreecommitdiff
path: root/help/en_US/shiftdata.xml
blob: 84bdb7945aa5264c5472776319da8fb06efc78dc (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="shiftdata" 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>shiftdata</refname>
    <refpurpose>Shifts data by rearranging dimensions</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   </synopsis>
</refsynopsisdiv>

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

<refsection>
   <title>Description</title>
   <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
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
//When dim is specified:
x=testmatrix('magi',3)
x  =

8.    1.    6.
3.    5.    7.
4.    9.    2.
[y,perm,nshifts] = shiftdata(x,2)
nshifts  =

[]
perm  =

2.    1.
y  =

8.    3.    4.
1.    5.    9.
6.    7.    2.
//When dim is not specified:
x=1:5
x  =

1.    2.    3.    4.    5.
[y,perm,nshifts] = shiftdata(x)
nshifts  =

1.
perm  =

[]
y  =

1.
2.
3.
4.
5.
   ]]></programlisting>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="permute">permute</link></member>
   <member><link linkend="unshiftdata">unshiftdata</link></member>
   <member><link linkend="Author">Author</link></member>
   <member><link linkend="Ankur">Mallick</link></member>
   </simplelist>
</refsection>
</refentry>