Added all the F4 libraries to the project
[fw/stlink] / exampleF4 / CMSIS / Documentation / DSP_Lib / html / arm__cfft__radix4__q31_8c.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>CMSIS DSP Software Library: arm_cfft_radix4_q31.c File Reference</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javaScript" src="search/search.js"></script>
9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 </head>
11 <body onload='searchBox.OnSelectItem(0);'>
12 <!-- Generated by Doxygen 1.7.2 -->
13 <script type="text/javascript"><!--
14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
15 --></script>
16 <div class="navigation" id="top">
17   <div class="tabs">
18     <ul class="tablist">
19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
20       <li><a href="modules.html"><span>Modules</span></a></li>
21       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
22       <li class="current"><a href="files.html"><span>Files</span></a></li>
23       <li><a href="examples.html"><span>Examples</span></a></li>
24       <li id="searchli">
25         <div id="MSearchBox" class="MSearchBoxInactive">
26         <span class="left">
27           <img id="MSearchSelect" src="search/mag_sel.png"
28                onmouseover="return searchBox.OnSearchSelectShow()"
29                onmouseout="return searchBox.OnSearchSelectHide()"
30                alt=""/>
31           <input type="text" id="MSearchField" value="Search" accesskey="S"
32                onfocus="searchBox.OnSearchFieldFocus(true)" 
33                onblur="searchBox.OnSearchFieldFocus(false)" 
34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
35           </span><span class="right">
36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
37           </span>
38         </div>
39       </li>
40     </ul>
41   </div>
42   <div class="tabs2">
43     <ul class="tablist">
44       <li><a href="files.html"><span>File&#160;List</span></a></li>
45       <li><a href="globals.html"><span>Globals</span></a></li>
46     </ul>
47   </div>
48 </div>
49 <div class="header">
50   <div class="summary">
51 <a href="#func-members">Functions</a>  </div>
52   <div class="headertitle">
53 <h1>arm_cfft_radix4_q31.c File Reference</h1>  </div>
54 </div>
55 <div class="contents">
56 <code>#include &quot;<a class="el" href="arm__math_8h_source.html">arm_math.h</a>&quot;</code><br/>
57
58 <p><a href="arm__cfft__radix4__q31_8c_source.html">Go to the source code of this file.</a></p>
59 <table class="memberdecls">
60 <tr><td colspan="2"><h2><a name="func-members"></a>
61 Functions</h2></td></tr>
62 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_f_f_t___c_i_f_f_t.html#gafde3ee1f58cf393b45a9073174fff548">arm_cfft_radix4_q31</a> (const <a class="el" href="structarm__cfft__radix4__instance__q31.html">arm_cfft_radix4_instance_q31</a> *S, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc)</td></tr>
63 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__radix4__q31_8c.html#ac12f1e7f159d5741358cdc36830a0395">arm_radix4_butterfly_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
64 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__radix4__q31_8c.html#ac9c7c553114c1201a3a987a11b8a6d01">arm_radix4_butterfly_inverse_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pCoef, uint32_t twidCoefModifier)</td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arm__cfft__radix4__q31_8c.html#a27618705158b5c42db5fb0a381f8efc1">arm_bitreversal_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t fftLen, uint16_t bitRevFactor, uint16_t *pBitRevTable)</td></tr>
66 </table>
67 <hr/><h2>Function Documentation</h2>
68 <a class="anchor" id="ac12f1e7f159d5741358cdc36830a0395"></a><!-- doxytag: member="arm_cfft_radix4_q31.c::arm_radix4_butterfly_q31" ref="ac12f1e7f159d5741358cdc36830a0395" args="(q31_t *pSrc, uint32_t fftLen, q31_t *pCoef, uint32_t twidCoefModifier)" -->
69 <div class="memitem">
70 <div class="memproto">
71       <table class="memname">
72         <tr>
73           <td class="memname">void arm_radix4_butterfly_q31 </td>
74           <td>(</td>
75           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
76           <td class="paramname"> <em>pSrc</em>, </td>
77         </tr>
78         <tr>
79           <td class="paramkey"></td>
80           <td></td>
81           <td class="paramtype">uint32_t&#160;</td>
82           <td class="paramname"> <em>fftLen</em>, </td>
83         </tr>
84         <tr>
85           <td class="paramkey"></td>
86           <td></td>
87           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
88           <td class="paramname"> <em>pCoef</em>, </td>
89         </tr>
90         <tr>
91           <td class="paramkey"></td>
92           <td></td>
93           <td class="paramtype">uint32_t&#160;</td>
94           <td class="paramname"> <em>twidCoefModifier</em>&#160;</td>
95         </tr>
96         <tr>
97           <td></td>
98           <td>)</td>
99           <td></td><td></td>
100         </tr>
101       </table>
102 </div>
103 <div class="memdoc">
104
105 <p>Core function for the Q31 CFFT butterfly process. </p>
106 <p>end of CFFT_CIFFT group </p>
107 <dl><dt><b>Parameters:</b></dt><dd>
108   <table class="params">
109     <tr><td class="paramdir">[in,out]</td><td class="paramname">*pSrc</td><td>points to the in-place buffer of Q31 data type. </td></tr>
110     <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT. </td></tr>
111     <tr><td class="paramdir">[in]</td><td class="paramname">*pCoef</td><td>points to twiddle coefficient buffer. </td></tr>
112     <tr><td class="paramdir">[in]</td><td class="paramname">twidCoefModifier</td><td>twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. </td></tr>
113   </table>
114   </dd>
115 </dl>
116 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
117
118 <p>Definition at line <a class="el" href="arm__cfft__radix4__q31_8c_source.html#l00139">139</a> of file <a class="el" href="arm__cfft__radix4__q31_8c_source.html">arm_cfft_radix4_q31.c</a>.</p>
119
120 </div>
121 </div>
122 <a class="anchor" id="ac9c7c553114c1201a3a987a11b8a6d01"></a><!-- doxytag: member="arm_cfft_radix4_q31.c::arm_radix4_butterfly_inverse_q31" ref="ac9c7c553114c1201a3a987a11b8a6d01" args="(q31_t *pSrc, uint32_t fftLen, q31_t *pCoef, uint32_t twidCoefModifier)" -->
123 <div class="memitem">
124 <div class="memproto">
125       <table class="memname">
126         <tr>
127           <td class="memname">void arm_radix4_butterfly_inverse_q31 </td>
128           <td>(</td>
129           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
130           <td class="paramname"> <em>pSrc</em>, </td>
131         </tr>
132         <tr>
133           <td class="paramkey"></td>
134           <td></td>
135           <td class="paramtype">uint32_t&#160;</td>
136           <td class="paramname"> <em>fftLen</em>, </td>
137         </tr>
138         <tr>
139           <td class="paramkey"></td>
140           <td></td>
141           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
142           <td class="paramname"> <em>pCoef</em>, </td>
143         </tr>
144         <tr>
145           <td class="paramkey"></td>
146           <td></td>
147           <td class="paramtype">uint32_t&#160;</td>
148           <td class="paramname"> <em>twidCoefModifier</em>&#160;</td>
149         </tr>
150         <tr>
151           <td></td>
152           <td>)</td>
153           <td></td><td></td>
154         </tr>
155       </table>
156 </div>
157 <div class="memdoc">
158
159 <p>Core function for the Q31 CIFFT butterfly process. </p>
160 <dl><dt><b>Parameters:</b></dt><dd>
161   <table class="params">
162     <tr><td class="paramdir">[in,out]</td><td class="paramname">*pSrc</td><td>points to the in-place buffer of Q31 data type. </td></tr>
163     <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT. </td></tr>
164     <tr><td class="paramdir">[in]</td><td class="paramname">*pCoef</td><td>points to twiddle coefficient buffer. </td></tr>
165     <tr><td class="paramdir">[in]</td><td class="paramname">twidCoefModifier</td><td>twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. </td></tr>
166   </table>
167   </dd>
168 </dl>
169 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
170
171 <p>Definition at line <a class="el" href="arm__cfft__radix4__q31_8c_source.html#l00517">517</a> of file <a class="el" href="arm__cfft__radix4__q31_8c_source.html">arm_cfft_radix4_q31.c</a>.</p>
172
173 </div>
174 </div>
175 <a class="anchor" id="a27618705158b5c42db5fb0a381f8efc1"></a><!-- doxytag: member="arm_cfft_radix4_q31.c::arm_bitreversal_q31" ref="a27618705158b5c42db5fb0a381f8efc1" args="(q31_t *pSrc, uint32_t fftLen, uint16_t bitRevFactor, uint16_t *pBitRevTable)" -->
176 <div class="memitem">
177 <div class="memproto">
178       <table class="memname">
179         <tr>
180           <td class="memname">void arm_bitreversal_q31 </td>
181           <td>(</td>
182           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
183           <td class="paramname"> <em>pSrc</em>, </td>
184         </tr>
185         <tr>
186           <td class="paramkey"></td>
187           <td></td>
188           <td class="paramtype">uint32_t&#160;</td>
189           <td class="paramname"> <em>fftLen</em>, </td>
190         </tr>
191         <tr>
192           <td class="paramkey"></td>
193           <td></td>
194           <td class="paramtype">uint16_t&#160;</td>
195           <td class="paramname"> <em>bitRevFactor</em>, </td>
196         </tr>
197         <tr>
198           <td class="paramkey"></td>
199           <td></td>
200           <td class="paramtype">uint16_t *&#160;</td>
201           <td class="paramname"> <em>pBitRevTab</em>&#160;</td>
202         </tr>
203         <tr>
204           <td></td>
205           <td>)</td>
206           <td></td><td></td>
207         </tr>
208       </table>
209 </div>
210 <div class="memdoc">
211
212 <p>In-place bit reversal function. </p>
213 <dl><dt><b>Parameters:</b></dt><dd>
214   <table class="params">
215     <tr><td class="paramdir">[in,out]</td><td class="paramname">*pSrc</td><td>points to the in-place buffer of Q31 data type. </td></tr>
216     <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the FFT. </td></tr>
217     <tr><td class="paramdir">[in]</td><td class="paramname">bitRevFactor</td><td>bit reversal modifier that supports different size FFTs with the same bit reversal table </td></tr>
218     <tr><td class="paramdir">[in]</td><td class="paramname">*pBitRevTab</td><td>points to bit reversal table. </td></tr>
219   </table>
220   </dd>
221 </dl>
222 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
223
224 <p>Definition at line <a class="el" href="arm__cfft__radix4__q31_8c_source.html#l00848">848</a> of file <a class="el" href="arm__cfft__radix4__q31_8c_source.html">arm_cfft_radix4_q31.c</a>.</p>
225
226 </div>
227 </div>
228 </div>
229 <!--- window showing the filter options -->
230 <div id="MSearchSelectWindow"
231      onmouseover="return searchBox.OnSearchSelectShow()"
232      onmouseout="return searchBox.OnSearchSelectHide()"
233      onkeydown="return searchBox.OnSearchSelectKey(event)">
234 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
235
236 <!-- iframe showing the search results (closed by default) -->
237 <div id="MSearchResultsWindow">
238 <iframe src="" frameborder="0" 
239         name="MSearchResults" id="MSearchResults">
240 </iframe>
241 </div>
242
243 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:17 for CMSIS DSP Software Library by&#160;
244 <a href="http://www.doxygen.org/index.html">
245 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
246 </body>
247 </html>