summaryrefslogtreecommitdiff
path: root/help/en_US/digitrevorder.xml
diff options
context:
space:
mode:
authorSunil Shetye2018-07-25 16:27:51 +0530
committerSunil Shetye2018-07-26 23:50:17 +0530
commit9ca7882cee16ad48b18df989e8300c697010e55a (patch)
tree59e0c6116b835ae3e5e3208bc9609ed2828069ed /help/en_US/digitrevorder.xml
parent6bbb00d0f0128381ee95194cf7d008fb6504de7d (diff)
downloadFOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.tar.gz
FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.tar.bz2
FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.zip
code changes by Sonu Sharma during FOSSEE Fellowship 2018
Diffstat (limited to 'help/en_US/digitrevorder.xml')
-rw-r--r--help/en_US/digitrevorder.xml63
1 files changed, 63 insertions, 0 deletions
diff --git a/help/en_US/digitrevorder.xml b/help/en_US/digitrevorder.xml
new file mode 100644
index 0000000..988f372
--- /dev/null
+++ b/help/en_US/digitrevorder.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from digitrevorder.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="digitrevorder" 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>digitrevorder</refname>
+ <refpurpose></refpurpose>
+ </refnamediv>
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ [y,i] = digitrevorder(x,r)
+ y = digitrevorder(x,r)
+ </synopsis>
+ <para> </para>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>x:</term>
+ <listitem><para> Vector of real or complex values</para></listitem></varlistentry>
+ <varlistentry><term>r:</term>
+ <listitem><para> radix / base </para></listitem></varlistentry>
+ <varlistentry><term>y:</term>
+ <listitem><para> input vector in bit reverse order</para></listitem></varlistentry>
+ <varlistentry><term>i:</term>
+ <listitem><para> indices after bit reversing </para></listitem></varlistentry>
+ <para> </para>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function returns the input data after reversing the digits of the indices and reordering the elements of the input array.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+x = [%i,1,3,6*%i] ;
+r = 2 ;
+[y i]=digitrevorder(x, r)
+ ]]></programlisting>
+</refsection>
+
+</refentry>