summaryrefslogtreecommitdiff
path: root/help/en_US/bitrevorder.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/bitrevorder.xml')
-rw-r--r--help/en_US/bitrevorder.xml20
1 files changed, 12 insertions, 8 deletions
diff --git a/help/en_US/bitrevorder.xml b/help/en_US/bitrevorder.xml
index 996ed26..35ca8f4 100644
--- a/help/en_US/bitrevorder.xml
+++ b/help/en_US/bitrevorder.xml
@@ -17,15 +17,18 @@
<refnamediv>
<refname>bitrevorder</refname>
- <refpurpose></refpurpose>
+ <refpurpose> Returns input data in bit-reversed order </refpurpose>
+ <para> </para>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
- [y,i]=bitrevorder(x)
+ [y,i] = bitrevorder(x)
+ y = bitrevorder(x)
</synopsis>
+ <para> </para>
</refsynopsisdiv>
<refsection>
@@ -33,13 +36,17 @@
<variablelist>
<varlistentry><term>x:</term>
<listitem><para> Vector of real or complex values</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 is an Octave function.
This function returns the input data after reversing the bits of the indices and reordering the elements of the input array.
</para>
</refsection>
@@ -47,11 +54,8 @@ This function returns the input data after reversing the bits of the indices and
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
-1. [y]=bitrevorder ([i,1,3,6i])
-y = [0 + 1i 3 + 0i 1 + 0i 0 + 6i]
-2. [y,i]=bitrevorder (['a','b','c','d'])
-y = acbd
-i = [1 3 2 4]
+x = [%i,1,3,6*%i] ;
+[y i]=bitrevorder(x)
]]></programlisting>
</refsection>
</refentry>