<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="unshiftdata" 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>unshiftdata</refname>
    <refpurpose>Inverts the effect of shiftdata</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Syntax</title>
   <synopsis>
   y=unshiftdata(x,perm,nshifts)
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
        <varlistentry>
            <term>x :</term>
            <listitem><para> A vector matrix or n-dimensional array</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>perm :</term>
            <listitem><para> Permutation applied by shiftdata to obtain x</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>nshifts :</term>
            <listitem><para> The number of shifts applied by shiftdata to obtain x</para></listitem>
        </varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
y=unshiftdata(x,perm,nshifts)
Applies the permutation perm or number of shifts nshifts on x to invert shiftdata
   </para>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
x=testmatrix('magi',3)
[y,perm,nshifts] = shiftdata(x,2) //Shifts dimension 2
z=unshiftdata(y,perm,nshifts)
[y,perm,nshifts] = shiftdata(x) //Shifts first non-singleton dimension
z=unshiftdata(y,perm,nshifts)

   ]]></programlisting>
</refsection>

<refsection role="see also">
   <title>See also</title>
   <simplelist type="inline">
   </simplelist>
</refsection>
</refentry>
