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

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

<refentry version="5.0-subset Scilab" xml:id="udecode" 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>udecode</refname>
    <refpurpose>Decodes the input uniformly quantized values</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Syntax</title>
   <synopsis>
   y=uencode(u,n,v,'saturatemode')
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
        <varlistentry>
            <term>u :</term>
            <listitem><para> A vector, matrix or n-dimensional array of integers</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>n :</term>
            <listitem><para> An integer between 2 and 32</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>v :</term>
            <listitem><para> A positive real scalar</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>saturatemode :</term>
            <listitem><para> A string which can take only 2 values 'saturate' or 'wrap'</para></listitem>
        </varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
Uniformly decodes the input vector or n-dimensional array of integers u with peak values +/- v
If u has only positive values, the range of integers is assumed to be [0,2^n-1]
If u has positive and negative values the range of integers is assumed to be [-2^(n-1),2^(n-1)-1]
If v is not specified, its default value is 1
If saturatemode='wrap' the output is wrapped using modulo arithmetic if overflow occurs
If saturatemode='saturate' the output is saturated if overflow accors
   </para>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
u = int8([-1 1 2 -5])
ysat = udecode(u,3)

   ]]></programlisting>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Ankur Mallick</member>
   <member>Biblography</member>
   <member>[1] International Telecommunication Union. General Aspects of Digital Transmission Systems: Vocabulary of Digital Transmission and Multiplexing, and Pulse Code Modulation (PCM) Terms. ITU-T Recommendation G.701. March, 1993.</member>
   </simplelist>
</refsection>

<refsection role="see also">
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="uencode">uencode</link></member>
   <member><link linkend="floor">floor</link></member>
   </simplelist>
</refsection>
</refentry>
