diff options
Diffstat (limited to 'Drivers/CMSIS/docs/DSP/html/group__RealFFT.html')
| -rw-r--r-- | Drivers/CMSIS/docs/DSP/html/group__RealFFT.html | 423 |
1 files changed, 347 insertions, 76 deletions
diff --git a/Drivers/CMSIS/docs/DSP/html/group__RealFFT.html b/Drivers/CMSIS/docs/DSP/html/group__RealFFT.html index 3f28e0d73..d57ec402b 100644 --- a/Drivers/CMSIS/docs/DSP/html/group__RealFFT.html +++ b/Drivers/CMSIS/docs/DSP/html/group__RealFFT.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-DSP -  <span id="projectnumber">Version 1.5.2</span> +  <span id="projectnumber">Version 1.7.0</span> </div> <div id="projectbrief">CMSIS DSP Software Library</div> </td> @@ -128,10 +128,35 @@ Functions</h2></td></tr> <tr class="memitem:ga180d8b764d59cbb85d37a2d5f7cd9799"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga180d8b764d59cbb85d37a2d5f7cd9799">arm_rfft_fast_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *p, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pOut, uint8_t <a class="el" href="arm__fft__bin__example__f32_8c.html#a379ccb99013d369a41b49619083c16ef">ifftFlag</a>)</td></tr> <tr class="memdesc:ga180d8b764d59cbb85d37a2d5f7cd9799"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the floating-point real FFT. <a href="#ga180d8b764d59cbb85d37a2d5f7cd9799">More...</a><br/></td></tr> <tr class="separator:ga180d8b764d59cbb85d37a2d5f7cd9799"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga153c8faa97b7ab8b1aef75fe6ac1b3a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga153c8faa97b7ab8b1aef75fe6ac1b3a2">arm_rfft_32_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:ga153c8faa97b7ab8b1aef75fe6ac1b3a2"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 32pt floating-point real FFT. <a href="#ga153c8faa97b7ab8b1aef75fe6ac1b3a2">More...</a><br/></td></tr> +<tr class="separator:ga153c8faa97b7ab8b1aef75fe6ac1b3a2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0f67de6a0e5d87011f35426112d2d91b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga0f67de6a0e5d87011f35426112d2d91b">arm_rfft_64_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:ga0f67de6a0e5d87011f35426112d2d91b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 64pt floating-point real FFT. <a href="#ga0f67de6a0e5d87011f35426112d2d91b">More...</a><br/></td></tr> +<tr class="separator:ga0f67de6a0e5d87011f35426112d2d91b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gade8432f9318953234761e8e0f2c9e1d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#gade8432f9318953234761e8e0f2c9e1d2">arm_rfft_128_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:gade8432f9318953234761e8e0f2c9e1d2"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 128pt floating-point real FFT. <a href="#gade8432f9318953234761e8e0f2c9e1d2">More...</a><br/></td></tr> +<tr class="separator:gade8432f9318953234761e8e0f2c9e1d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga678afbb042d942c3dd5a33877ef66492"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga678afbb042d942c3dd5a33877ef66492">arm_rfft_256_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:ga678afbb042d942c3dd5a33877ef66492"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 256pt floating-point real FFT. <a href="#ga678afbb042d942c3dd5a33877ef66492">More...</a><br/></td></tr> +<tr class="separator:ga678afbb042d942c3dd5a33877ef66492"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9a0e72918318f9d1c03973eab379e580"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga9a0e72918318f9d1c03973eab379e580">arm_rfft_512_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:ga9a0e72918318f9d1c03973eab379e580"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 512pt floating-point real FFT. <a href="#ga9a0e72918318f9d1c03973eab379e580">More...</a><br/></td></tr> +<tr class="separator:ga9a0e72918318f9d1c03973eab379e580"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga71547c601079d55c2525204aa00ef9c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga71547c601079d55c2525204aa00ef9c2">arm_rfft_1024_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:ga71547c601079d55c2525204aa00ef9c2"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 1024pt floating-point real FFT. <a href="#ga71547c601079d55c2525204aa00ef9c2">More...</a><br/></td></tr> +<tr class="separator:ga71547c601079d55c2525204aa00ef9c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga33724310a8360ac289d5a835282f778c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga33724310a8360ac289d5a835282f778c">arm_rfft_2048_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:ga33724310a8360ac289d5a835282f778c"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 2048pt floating-point real FFT. <a href="#ga33724310a8360ac289d5a835282f778c">More...</a><br/></td></tr> +<tr class="separator:ga33724310a8360ac289d5a835282f778c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaad50a08bb8191e1a138b5f72a268727a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#gaad50a08bb8191e1a138b5f72a268727a">arm_rfft_4096_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S)</td></tr> +<tr class="memdesc:gaad50a08bb8191e1a138b5f72a268727a"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the 4096pt floating-point real FFT. <a href="#gaad50a08bb8191e1a138b5f72a268727a">More...</a><br/></td></tr> +<tr class="separator:gaad50a08bb8191e1a138b5f72a268727a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac5fceb172551e7c11eb4d0e17ef15aa3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#gac5fceb172551e7c11eb4d0e17ef15aa3">arm_rfft_fast_init_f32</a> (<a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> *S, uint16_t fftLen)</td></tr> <tr class="memdesc:gac5fceb172551e7c11eb4d0e17ef15aa3"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the floating-point real FFT. <a href="#gac5fceb172551e7c11eb4d0e17ef15aa3">More...</a><br/></td></tr> <tr class="separator:gac5fceb172551e7c11eb4d0e17ef15aa3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga10717ee326bf50832ef1c25b85a23068"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga10717ee326bf50832ef1c25b85a23068">arm_rfft_init_f32</a> (<a class="el" href="structarm__rfft__instance__f32.html">arm_rfft_instance_f32</a> *S, <a class="el" href="structarm__cfft__radix4__instance__f32.html">arm_cfft_radix4_instance_f32</a> *S_CFFT, uint32_t fftLenReal, uint32_t ifftFlagR, uint32_t bitReverseFlag)</td></tr> +<tr class="memdesc:ga10717ee326bf50832ef1c25b85a23068"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the floating-point RFFT/RIFFT. <a href="#ga10717ee326bf50832ef1c25b85a23068">More...</a><br/></td></tr> <tr class="separator:ga10717ee326bf50832ef1c25b85a23068"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga053450cc600a55410ba5b5605e96245d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RealFFT.html#ga053450cc600a55410ba5b5605e96245d">arm_rfft_init_q15</a> (<a class="el" href="structarm__rfft__instance__q15.html">arm_rfft_instance_q15</a> *S, uint32_t fftLenReal, uint32_t ifftFlagR, uint32_t bitReverseFlag)</td></tr> <tr class="memdesc:ga053450cc600a55410ba5b5605e96245d"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the Q15 RFFT/RIFFT. <a href="#ga053450cc600a55410ba5b5605e96245d">More...</a><br/></td></tr> @@ -154,16 +179,16 @@ Functions</h2></td></tr> <img src="RFFT.gif" alt="RFFT.gif"/> <div class="caption"> Real Fast Fourier Transform</div></div> - </dd></dl> +</dd></dl> <dl class="section user"><dt></dt><dd>The real sequence is initially treated as if it were complex to perform a CFFT. Later, a processing stage reshapes the data to obtain half of the frequency spectrum in complex format. Except the first complex number that contains the two real numbers X[0] and X[N/2] all the data is complex. In other words, the first complex sample contains two real values packed. </dd></dl> <dl class="section user"><dt></dt><dd>The input for the inverse RFFT should keep the same format as the output of the forward RFFT. A first processing stage pre-process the data to later perform an inverse CFFT. </dd></dl> <dl class="section user"><dt></dt><dd><div class="image"> <img src="RIFFT.gif" alt="RIFFT.gif"/> <div class="caption"> Real Inverse Fast Fourier Transform</div></div> - </dd></dl> +</dd></dl> <dl class="section user"><dt></dt><dd>The algorithms for floating-point, Q15, and Q31 data are slightly different and we describe each algorithm in turn. </dd></dl> -<dl class="section user"><dt>Floating-point</dt><dd>The main functions are <a class="el" href="group__RealFFT.html#ga180d8b764d59cbb85d37a2d5f7cd9799" title="Processing function for the floating-point real FFT. ">arm_rfft_fast_f32()</a> and <a class="el" href="group__RealFFT.html#gac5fceb172551e7c11eb4d0e17ef15aa3" title="Initialization function for the floating-point real FFT. ">arm_rfft_fast_init_f32()</a>. The older functions <a class="el" href="group__RealFFT.html#ga3df1766d230532bc068fc4ed69d0fcdc" title="Processing function for the floating-point RFFT/RIFFT. ">arm_rfft_f32()</a> and <a class="el" href="group__RealFFT.html#ga10717ee326bf50832ef1c25b85a23068">arm_rfft_init_f32()</a> have been deprecated but are still documented. </dd></dl> +<dl class="section user"><dt>Floating-point</dt><dd>The main functions are <a class="el" href="group__RealFFT.html#ga180d8b764d59cbb85d37a2d5f7cd9799">arm_rfft_fast_f32()</a> and <a class="el" href="group__RealFFT.html#gac5fceb172551e7c11eb4d0e17ef15aa3">arm_rfft_fast_init_f32()</a>. The older functions <a class="el" href="group__RealFFT.html#ga3df1766d230532bc068fc4ed69d0fcdc">arm_rfft_f32()</a> and <a class="el" href="group__RealFFT.html#ga10717ee326bf50832ef1c25b85a23068">arm_rfft_init_f32()</a> have been deprecated but are still documented. </dd></dl> <dl class="section user"><dt></dt><dd>The FFT of a real N-point sequence has even symmetry in the frequency domain. The second half of the data equals the conjugate of the first half flipped in frequency. Looking at the data, we see that we can uniquely represent the FFT using only N/2 complex numbers. These are packed into the output array in alternating real and imaginary components: </dd></dl> <dl class="section user"><dt></dt><dd>X = { real[0], imag[0], real[1], imag[1], real[2], imag[2] ... real[(N/2)-1], imag[(N/2)-1 } </dd></dl> <dl class="section user"><dt></dt><dd>It happens that the first complex number (real[0], imag[0]) is actually all real. real[0] represents the DC offset, and imag[0] should be 0. (real[1], imag[1]) is the fundamental frequency, (real[2], imag[2]) is the first harmonic and so on. </dd></dl> @@ -178,11 +203,226 @@ Real Inverse Fast Fourier Transform</div></div> </ul> </dd></dl> <dl class="section user"><dt></dt><dd>Use of the initialization function is optional. However, if the initialization function is used, then the instance structure cannot be placed into a const data section. To place an instance structure into a const data section, the instance structure should be manually initialized as follows: <pre> -<a class="el" href="structarm__rfft__instance__q31.html" title="Instance structure for the Q31 RFFT/RIFFT function. ">arm_rfft_instance_q31</a> S = {fftLenReal, fftLenBy2, ifftFlagR, bitReverseFlagR, twidCoefRModifier, pTwiddleAReal, pTwiddleBReal, pCfft}; -<a class="el" href="structarm__rfft__instance__q15.html" title="Instance structure for the Q15 RFFT/RIFFT function. ">arm_rfft_instance_q15</a> S = {fftLenReal, fftLenBy2, ifftFlagR, bitReverseFlagR, twidCoefRModifier, pTwiddleAReal, pTwiddleBReal, pCfft}; - </pre> where <code>fftLenReal</code> is the length of the real transform; <code>fftLenBy2</code> length of the internal complex transform. <code>ifftFlagR</code> Selects forward (=0) or inverse (=1) transform. <code>bitReverseFlagR</code> Selects bit reversed output (=0) or normal order output (=1). <code>twidCoefRModifier</code> stride modifier for the twiddle factor table. The value is based on the FFT length; <code>pTwiddleAReal</code>points to the A array of twiddle coefficients; <code>pTwiddleBReal</code>points to the B array of twiddle coefficients; <code>pCfft</code> points to the CFFT Instance structure. The CFFT structure must also be initialized. Refer to <a class="el" href="group__ComplexFFT.html#ga521f670cd9c571bc61aff9bec89f4c26" title="Processing function for the floating-point Radix-4 CFFT/CIFFT. ">arm_cfft_radix4_f32()</a> for details regarding static initialization of the complex FFT instance structure.</dd></dl> -<p>end of RealFFT_Table group </p> + <a class="el" href="structarm__rfft__instance__q31.html" title="Instance structure for the Q31 RFFT/RIFFT function. ">arm_rfft_instance_q31</a> S = {fftLenReal, fftLenBy2, ifftFlagR, bitReverseFlagR, twidCoefRModifier, pTwiddleAReal, pTwiddleBReal, pCfft}; + <a class="el" href="structarm__rfft__instance__q15.html" title="Instance structure for the Q15 RFFT/RIFFT function. ">arm_rfft_instance_q15</a> S = {fftLenReal, fftLenBy2, ifftFlagR, bitReverseFlagR, twidCoefRModifier, pTwiddleAReal, pTwiddleBReal, pCfft}; +</pre> where <code>fftLenReal</code> is the length of the real transform; <code>fftLenBy2</code> length of the internal complex transform. <code>ifftFlagR</code> Selects forward (=0) or inverse (=1) transform. <code>bitReverseFlagR</code> Selects bit reversed output (=0) or normal order output (=1). <code>twidCoefRModifier</code> stride modifier for the twiddle factor table. The value is based on the FFT length; <code>pTwiddleAReal</code>points to the A array of twiddle coefficients; <code>pTwiddleBReal</code>points to the B array of twiddle coefficients; <code>pCfft</code> points to the CFFT Instance structure. The CFFT structure must also be initialized. Refer to <a class="el" href="group__ComplexFFT.html#ga521f670cd9c571bc61aff9bec89f4c26" title="Processing function for the floating-point Radix-4 CFFT/CIFFT. ">arm_cfft_radix4_f32()</a> for details regarding static initialization of the complex FFT instance structure. </dd></dl> <h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga71547c601079d55c2525204aa00ef9c2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_1024_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="gade8432f9318953234761e8e0f2c9e1d2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_128_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="ga33724310a8360ac289d5a835282f778c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_2048_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="ga678afbb042d942c3dd5a33877ef66492"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_256_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="ga153c8faa97b7ab8b1aef75fe6ac1b3a2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_32_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="gaad50a08bb8191e1a138b5f72a268727a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_4096_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="ga9a0e72918318f9d1c03973eab379e580"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_512_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="ga0f67de6a0e5d87011f35426112d2d91b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_rfft_64_fast_init_f32 </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structarm__rfft__fast__instance__f32.html">arm_rfft_fast_instance_f32</a> * </td> + <td class="paramname"><em>S</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected </li> +</ul> +</dd></dl> + +</div> +</div> <a class="anchor" id="ga3df1766d230532bc068fc4ed69d0fcdc"></a> <div class="memitem"> <div class="memproto"> @@ -212,19 +452,17 @@ Real Inverse Fast Fourier Transform</div></div> </tr> </table> </div><div class="memdoc"> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="group__RealFFT.html#ga180d8b764d59cbb85d37a2d5f7cd9799">arm_rfft_fast_f32</a> and will be removed in the future. <dl class="params"><dt>Parameters</dt><dd> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="group__RealFFT.html#ga180d8b764d59cbb85d37a2d5f7cd9799">arm_rfft_fast_f32</a> and will be removed in the future. <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the floating-point RFFT/RIFFT structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input buffer. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the floating-point RFFT/RIFFT structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the output buffer </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </dd></dl> -<p>References <a class="el" href="arm__rfft__f32_8c.html#a3d4062fdfa6aaa3f51f41cab868e508b">arm_bitreversal_f32()</a>, <a class="el" href="arm__rfft__f32_8c.html#ae239ddf995d1607115f9e84d5c069b9c">arm_radix4_butterfly_f32()</a>, <a class="el" href="arm__rfft__f32_8c.html#a2a78df6e4bbf080624f2b6349224ec93">arm_radix4_butterfly_inverse_f32()</a>, <a class="el" href="arm__rfft__f32_8c.html#a6cfdb6bdc66b13732ef2351caf98fdbb">arm_split_rfft_f32()</a>, <a class="el" href="arm__rfft__f32_8c.html#a585bef78c103d150a116241a4feb6442">arm_split_rifft_f32()</a>, <a class="el" href="structarm__rfft__instance__f32.html#ac342f3248157cbbd2f04a3c8ec9fc9eb">arm_rfft_instance_f32::bitReverseFlagR</a>, <a class="el" href="structarm__cfft__radix4__instance__f32.html#acc8cb18a8b901b8321ab9d86491e41a3">arm_cfft_radix4_instance_f32::bitRevFactor</a>, <a class="el" href="structarm__cfft__radix4__instance__f32.html#a7e6a6d290ce158ce9a15a45e364b021a">arm_cfft_radix4_instance_f32::fftLen</a>, <a class="el" href="structarm__rfft__instance__f32.html#a075076e07ebb8521d8e3b49a31db6c57">arm_rfft_instance_f32::fftLenBy2</a>, <a class="el" href="structarm__rfft__instance__f32.html#a5ee6d10a934ab4b666e0bb286c3d633f">arm_rfft_instance_f32::ifftFlagR</a>, <a class="el" href="structarm__cfft__radix4__instance__f32.html#ab9eed39e40b8d7c16381fbccf84467cd">arm_cfft_radix4_instance_f32::onebyfftLen</a>, <a class="el" href="structarm__cfft__radix4__instance__f32.html#a8da0d2ca69749fde8cbb95caeac6fe6a">arm_cfft_radix4_instance_f32::pBitRevTable</a>, <a class="el" href="structarm__rfft__instance__f32.html#a9f47ba9f50c81e4445ae3827b981bc05">arm_rfft_instance_f32::pCfft</a>, <a class="el" href="structarm__cfft__radix4__instance__f32.html#a14860c7544911702ca1fa0bf78204ef3">arm_cfft_radix4_instance_f32::pTwiddle</a>, <a class="el" href="structarm__rfft__instance__f32.html#a534cc7e6e9b3e3dd022fad611c762142">arm_rfft_instance_f32::pTwiddleAReal</a>, <a class="el" href="structarm__rfft__instance__f32.html#a23543ecfd027fea2477fe1eea23c3c4d">arm_rfft_instance_f32::pTwiddleBReal</a>, <a class="el" href="structarm__cfft__radix4__instance__f32.html#abe31ea2157dfa233e389cdfd3b9993ee">arm_cfft_radix4_instance_f32::twidCoefModifier</a>, and <a class="el" href="structarm__rfft__instance__f32.html#aede85350fb5ae6baa1b3e8bfa15b18d6">arm_rfft_instance_f32::twidCoefRModifier</a>.</p> - </div> </div> <a class="anchor" id="ga180d8b764d59cbb85d37a2d5f7cd9799"></a> @@ -264,16 +502,18 @@ Real Inverse Fast Fourier Transform</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*p</td><td>points to the input buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pOut</td><td>points to the output buffer. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlag</td><td>RFFT if flag is 0, RIFFT if flag is 1 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>points to input buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pOut</td><td>points to output buffer </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlag</td><td><ul> +<li>value = 0: RFFT</li> +<li>value = 1: RIFFT </li> +</ul> +</td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> - -<p>References <a class="el" href="group__ComplexFFT.html#gade0f9c4ff157b6b9c72a1eafd86ebf80">arm_cfft_f32()</a>, <a class="el" href="structarm__cfft__instance__f32.html#acd8f9e9540e3dd348212726e5d6aaa95">arm_cfft_instance_f32::fftLen</a>, <a class="el" href="structarm__rfft__fast__instance__f32.html#aef06ab665041ec36f5b25d464f0cab14">arm_rfft_fast_instance_f32::fftLenRFFT</a>, <a class="el" href="arm__rfft__fast__f32_8c.html#a93258bc1e64a939a8ebd086367e459af">merge_rfft_f32()</a>, <a class="el" href="structarm__rfft__fast__instance__f32.html#a37419ababdfb3151b1891ae6bcd21012">arm_rfft_fast_instance_f32::Sint</a>, and <a class="el" href="arm__rfft__fast__f32_8c.html#a47157c5a53c8aac5e80fda31acf1f9cc">stage_rfft_f32()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> @@ -302,18 +542,19 @@ Real Inverse Fast Fourier Transform</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in,out]</td><td class="paramname">*S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the Real Sequence. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an <a class="el" href="structarm__rfft__fast__instance__f32.html" title="Instance structure for the floating-point RFFT/RIFFT function. ">arm_rfft_fast_instance_f32</a> structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>length of the Real Sequence </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization is successful or ARM_MATH_ARGUMENT_ERROR if <code>fftLen</code> is not a supported value.</dd></dl> -<dl class="section user"><dt>Description:</dt><dd></dd></dl> -<dl class="section user"><dt></dt><dd>The parameter <code>fftLen</code> Specifies length of RFFT/CIFFT process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : <code>fftLen</code> is not a supported length</li> +</ul> +</dd></dl> +<dl class="section user"><dt>Description</dt><dd>The parameter <code>fftLen</code> specifies the length of RFFT/CIFFT process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096. </dd></dl> <dl class="section user"><dt></dt><dd>This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. </dd></dl> -<p>References <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="arm__common__tables_8h.html#a08dd0b98fa4cc50cad0f48ce752f8149">armBitRevIndexTable1024</a>, <a class="el" href="arm__common__tables_8h.html#a04711bbb245f2ac7202db666eaaf10f2">armBitRevIndexTable128</a>, <a class="el" href="arm__common__tables_8h.html#a1d4574fdfbfd5698054602b26ad97575">armBitRevIndexTable16</a>, <a class="el" href="arm__common__tables_8h.html#adaa1b91f1cb7be2c5e236a3c3352caa0">armBitRevIndexTable2048</a>, <a class="el" href="arm__common__tables_8h.html#a77b17c8e7539af315c57de27610d8407">armBitRevIndexTable256</a>, <a class="el" href="arm__common__tables_8h.html#a5eee9bb0fadbf7753c02cfcff1226185">armBitRevIndexTable32</a>, <a class="el" href="arm__common__tables_8h.html#a297a311183fb6d17d7ee0152ad1e43f3">armBitRevIndexTable512</a>, <a class="el" href="arm__common__tables_8h.html#a07798450c81fc35b0e1b79359ee06ea1">armBitRevIndexTable64</a>, <a class="el" href="arm__common__tables_8h.html#a5f6f615f438c5134a9b7e746139705df">ARMBITREVINDEXTABLE_1024_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#abb73376f7efda869394aab2acef4291c">ARMBITREVINDEXTABLE_128_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#ae238c932ca2cc11cc8aebdfc953adb63">ARMBITREVINDEXTABLE_16_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#a3c561d85c5fc37cf2e111123d32353c3">ARMBITREVINDEXTABLE_2048_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#aa7dc18c3b4f8d76f5a29f7b182007934">ARMBITREVINDEXTABLE_256_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#a53e4f11ab8b72fd91e9654efe1154ca5">ARMBITREVINDEXTABLE_32_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#ab21231782baf177ef3edad11aeba5a4f">ARMBITREVINDEXTABLE_512_TABLE_LENGTH</a>, <a class="el" href="arm__common__tables_8h.html#aa4cbc689396d844f626d942ef28eb4ba">ARMBITREVINDEXTABLE_64_TABLE_LENGTH</a>, <a class="el" href="structarm__cfft__instance__f32.html#a3ba329ed153d182746376208e773d648">arm_cfft_instance_f32::bitRevLength</a>, <a class="el" href="structarm__cfft__instance__f32.html#acd8f9e9540e3dd348212726e5d6aaa95">arm_cfft_instance_f32::fftLen</a>, <a class="el" href="structarm__rfft__fast__instance__f32.html#aef06ab665041ec36f5b25d464f0cab14">arm_rfft_fast_instance_f32::fftLenRFFT</a>, <a class="el" href="structarm__cfft__instance__f32.html#a21ceaf59a1bb8440af57c28d2dd9bbab">arm_cfft_instance_f32::pBitRevTable</a>, <a class="el" href="structarm__cfft__instance__f32.html#a59cc6f753f1498716e1444ac054c06de">arm_cfft_instance_f32::pTwiddle</a>, <a class="el" href="structarm__rfft__fast__instance__f32.html#a9f30b04f163fabc1b24421d3c323d5fc">arm_rfft_fast_instance_f32::pTwiddleRFFT</a>, <a class="el" href="structarm__rfft__fast__instance__f32.html#a37419ababdfb3151b1891ae6bcd21012">arm_rfft_fast_instance_f32::Sint</a>, <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>, <a class="el" href="group__CFFT__CIFFT.html#ga27c056eb130a4333d1cc5dd43ec738b1">twiddleCoef_1024</a>, <a class="el" href="group__CFFT__CIFFT.html#ga948433536dafaac1381decfccf4e2d9c">twiddleCoef_128</a>, <a class="el" href="group__CFFT__CIFFT.html#gae75e243ec61706427314270f222e0c8e">twiddleCoef_16</a>, <a class="el" href="group__CFFT__CIFFT.html#ga23e7f30421a7905b21c2015429779633">twiddleCoef_2048</a>, <a class="el" href="group__CFFT__CIFFT.html#gafe813758a03a798e972359a092315be4">twiddleCoef_256</a>, <a class="el" href="group__CFFT__CIFFT.html#ga78a72c85d88185de98050c930cfc76e3">twiddleCoef_32</a>, <a class="el" href="group__CFFT__CIFFT.html#gad8830f0c068ab2cc19f2f87d220fa148">twiddleCoef_512</a>, <a class="el" href="group__CFFT__CIFFT.html#ga4f3c6d98c7e66393b4ef3ac63746e43d">twiddleCoef_64</a>, <a class="el" href="arm__common__tables_8h.html#aa7d8d3aa9898d557385748a13c959a4c">twiddleCoef_rfft_1024</a>, <a class="el" href="arm__common__tables_8h.html#af089dd2fe1a543d40a3325982bf45e7c">twiddleCoef_rfft_128</a>, <a class="el" href="arm__common__tables_8h.html#a749a5995ebd433a163f7adc474dabcaa">twiddleCoef_rfft_2048</a>, <a class="el" href="arm__common__tables_8h.html#a5c5c161dd469d8e6806664956dae31f9">twiddleCoef_rfft_256</a>, <a class="el" href="arm__common__tables_8h.html#a5992afe8574289cd71921651b80bd57d">twiddleCoef_rfft_32</a>, <a class="el" href="arm__common__tables_8h.html#a8013d68dd2476c86b77173bb98b87b29">twiddleCoef_rfft_4096</a>, <a class="el" href="arm__common__tables_8h.html#a94bd2fc98798f87003fef5cd0c04d1f5">twiddleCoef_rfft_512</a>, and <a class="el" href="arm__common__tables_8h.html#a2759d8789e1e6ae2ba7fb8d7f5e9c2ab">twiddleCoef_rfft_64</a>.</p> - </div> </div> <a class="anchor" id="ga10717ee326bf50832ef1c25b85a23068"></a> @@ -357,10 +598,34 @@ Real Inverse Fast Fourier Transform</div></div> </tr> </table> </div><div class="memdoc"> - -<p>References <a class="el" href="group__ComplexFFT.html#gaf336459f684f0b17bfae539ef1b1b78a">arm_cfft_radix4_init_f32()</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__rfft__instance__f32.html#ac342f3248157cbbd2f04a3c8ec9fc9eb">arm_rfft_instance_f32::bitReverseFlagR</a>, <a class="el" href="structarm__rfft__instance__f32.html#a075076e07ebb8521d8e3b49a31db6c57">arm_rfft_instance_f32::fftLenBy2</a>, <a class="el" href="structarm__rfft__instance__f32.html#a4219d4669699e4efdcb150ed7a0d9a57">arm_rfft_instance_f32::fftLenReal</a>, <a class="el" href="structarm__rfft__instance__f32.html#a5ee6d10a934ab4b666e0bb286c3d633f">arm_rfft_instance_f32::ifftFlagR</a>, <a class="el" href="structarm__rfft__instance__f32.html#a9f47ba9f50c81e4445ae3827b981bc05">arm_rfft_instance_f32::pCfft</a>, <a class="el" href="structarm__rfft__instance__f32.html#a534cc7e6e9b3e3dd022fad611c762142">arm_rfft_instance_f32::pTwiddleAReal</a>, <a class="el" href="structarm__rfft__instance__f32.html#a23543ecfd027fea2477fe1eea23c3c4d">arm_rfft_instance_f32::pTwiddleBReal</a>, <a class="el" href="group__RealFFT__Table.html#ga8b1ad947c470596674fa3364e16045c6">realCoefA</a>, <a class="el" href="group__RealFFT__Table.html#gac52f98b52a1f03bfac8b57a67ba07397">realCoefB</a>, <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>, and <a class="el" href="structarm__rfft__instance__f32.html#aede85350fb5ae6baa1b3e8bfa15b18d6">arm_rfft_instance_f32::twidCoefRModifier</a>.</p> - -<p>Referenced by <a class="el" href="group__DCT4__IDCT4.html#gab094ad3bc6fa1b84e8b12a24e1850a06">arm_dct4_init_f32()</a>.</p> +<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Do not use this function. It has been superceded by <a class="el" href="group__RealFFT.html#gac5fceb172551e7c11eb4d0e17ef15aa3">arm_rfft_fast_init_f32</a> and will be removed in the future. <dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the floating-point RFFT/RIFFT structure </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S_CFFT</td><td>points to an instance of the floating-point CFFT/CIFFT structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fftLenReal</td><td>length of the FFT. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlagR</td><td>flag that selects transform direction<ul> +<li>value = 0: forward transform</li> +<li>value = 1: inverse transform </li> +</ul> +</td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">bitReverseFlag</td><td>flag that enables / disables bit reversal of output<ul> +<li>value = 0: disables bit reversal of output</li> +<li>value = 1: enables bit reversal of output </li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : <code>fftLenReal</code> is not a supported length</li> +</ul> +</dd></dl> +</dd></dl> +<dl class="section user"><dt>Description</dt><dd>The parameter <code>fftLenReal</code>specifies length of RFFT/RIFFT Process. Supported FFT Lengths are 128, 512, 2048. </dd></dl> +<dl class="section user"><dt></dt><dd>The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed. Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated. </dd></dl> +<dl class="section user"><dt></dt><dd>The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order. Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order. </dd></dl> +<dl class="section user"><dt></dt><dd>This function also initializes Twiddle factor table. </dd></dl> </div> </div> @@ -401,24 +666,31 @@ Real Inverse Fast Fourier Transform</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in,out]</td><td class="paramname">*S</td><td>points to an instance of the Q15 RFFT/RIFFT structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">fftLenReal</td><td>length of the FFT. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlagR</td><td>flag that selects forward (ifftFlagR=0) or inverse (ifftFlagR=1) transform. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">bitReverseFlag</td><td>flag that enables (bitReverseFlag=1) or disables (bitReverseFlag=0) bit reversal of output. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the Q15 RFFT/RIFFT structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fftLenReal</td><td>length of the FFT </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlagR</td><td>flag that selects transform direction<ul> +<li>value = 0: forward transform</li> +<li>value = 1: inverse transform </li> +</ul> +</td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">bitReverseFlag</td><td>flag that enables / disables bit reversal of output<ul> +<li>value = 0: disables bit reversal of output</li> +<li>value = 1: enables bit reversal of output </li> +</ul> +</td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization is successful or ARM_MATH_ARGUMENT_ERROR if <code>fftLenReal</code> is not a supported value.</dd></dl> -<dl class="section user"><dt>Description:</dt><dd></dd></dl> -<dl class="section user"><dt></dt><dd>The parameter <code>fftLenReal</code> Specifies length of RFFT/RIFFT Process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : <code>fftLenReal</code> is not a supported length</li> +</ul> +</dd></dl> +<dl class="section user"><dt>Details</dt><dd>The parameter <code>fftLenReal</code> specifies length of RFFT/RIFFT Process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192. </dd></dl> <dl class="section user"><dt></dt><dd>The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed. Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated. </dd></dl> <dl class="section user"><dt></dt><dd>The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order. Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order. </dd></dl> <dl class="section user"><dt></dt><dd>This function also initializes Twiddle factor table. </dd></dl> -<p>References <a class="el" href="arm__const__structs_8h.html#ad343fb2e4cba826f092f9d72c4adc831">arm_cfft_sR_q15_len1024</a>, <a class="el" href="arm__const__structs_8h.html#a736a97efd37c6386dab8db730904f69b">arm_cfft_sR_q15_len128</a>, <a class="el" href="arm__const__structs_8h.html#a7ed661717c58b18f3e557daa72f2b91b">arm_cfft_sR_q15_len16</a>, <a class="el" href="arm__const__structs_8h.html#a92c94dc79c66ec66c95f793aedb964b9">arm_cfft_sR_q15_len2048</a>, <a class="el" href="arm__const__structs_8h.html#ad80be0db1ea40c66b079404c48d2dcf4">arm_cfft_sR_q15_len256</a>, <a class="el" href="arm__const__structs_8h.html#a8d5426a822a6017235b5e10119606a90">arm_cfft_sR_q15_len32</a>, <a class="el" href="arm__const__structs_8h.html#ab57c118edaa3260f7f16686152845b18">arm_cfft_sR_q15_len4096</a>, <a class="el" href="arm__const__structs_8h.html#a273b91ec86bb2bd8ac14e69252d487fb">arm_cfft_sR_q15_len512</a>, <a class="el" href="arm__const__structs_8h.html#a95c216e7dcfd59a8d40ef55ac223a749">arm_cfft_sR_q15_len64</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__rfft__instance__q15.html#a4c65cd40e0098ec2f5c0dc31488b9bc6">arm_rfft_instance_q15::bitReverseFlagR</a>, <a class="el" href="structarm__rfft__instance__q15.html#aac5cf9e825917cbb14f439e56bb86ab3">arm_rfft_instance_q15::fftLenReal</a>, <a class="el" href="structarm__rfft__instance__q15.html#a8051ffe268c147e431e1bea7bb4c4258">arm_rfft_instance_q15::ifftFlagR</a>, <a class="el" href="structarm__rfft__instance__q15.html#a4329c15b056444746d37ff082a24d31a">arm_rfft_instance_q15::pCfft</a>, <a class="el" href="structarm__rfft__instance__q15.html#affbf2de522ac029432d98e8373c0ec53">arm_rfft_instance_q15::pTwiddleAReal</a>, <a class="el" href="structarm__rfft__instance__q15.html#a937d815022adc557b435ba8c6cd58b0d">arm_rfft_instance_q15::pTwiddleBReal</a>, <a class="el" href="group__RealFFT__Table.html#ga11e84d0ee257a547f749b37dd0078d36">realCoefAQ15</a>, <a class="el" href="group__RealFFT__Table.html#gac871666f018b70938b2b98017628cb97">realCoefBQ15</a>, <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>, and <a class="el" href="structarm__rfft__instance__q15.html#afd444d05858c5f419980e94e8240d5c3">arm_rfft_instance_q15::twidCoefRModifier</a>.</p> - -<p>Referenced by <a class="el" href="group__DCT4__IDCT4.html#ga966fd1b66a80873964533703ab5dc054">arm_dct4_init_q15()</a>.</p> - </div> </div> <a class="anchor" id="ga5abde938abbe72e95c5bab080eb33c45"></a> @@ -458,23 +730,30 @@ Real Inverse Fast Fourier Transform</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in,out]</td><td class="paramname">*S</td><td>points to an instance of the Q31 RFFT/RIFFT structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">fftLenReal</td><td>length of the FFT. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlagR</td><td>flag that selects forward (ifftFlagR=0) or inverse (ifftFlagR=1) transform. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">bitReverseFlag</td><td>flag that enables (bitReverseFlag=1) or disables (bitReverseFlag=0) bit reversal of output. </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the Q31 RFFT/RIFFT structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fftLenReal</td><td>length of the FFT </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ifftFlagR</td><td>flag that selects transform direction<ul> +<li>value = 0: forward transform</li> +<li>value = 1: inverse transform </li> +</ul> +</td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">bitReverseFlag</td><td>flag that enables / disables bit reversal of output<ul> +<li>value = 0: disables bit reversal of output</li> +<li>value = 1: enables bit reversal of output </li> +</ul> +</td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if initialization is successful or ARM_MATH_ARGUMENT_ERROR if <code>fftLenReal</code> is not a supported value.</dd></dl> -<dl class="section user"><dt>Description:</dt><dd></dd></dl> -<dl class="section user"><dt></dt><dd>The parameter <code>fftLenReal</code> Specifies length of RFFT/RIFFT Process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>execution status<ul> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li> +<li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : <code>fftLenReal</code> is not a supported length</li> +</ul> +</dd></dl> +<dl class="section user"><dt>Details</dt><dd>The parameter <code>fftLenReal</code> specifies length of RFFT/RIFFT Process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192. </dd></dl> <dl class="section user"><dt></dt><dd>The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed. Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated. </dd></dl> <dl class="section user"><dt></dt><dd>The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order. Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order. </dd></dl> -<dl class="section user"><dt>7</dt><dd>This function also initializes Twiddle factor table. </dd></dl> - -<p>References <a class="el" href="arm__const__structs_8h.html#ada9813a027999f3cff066c9f7b5df51b">arm_cfft_sR_q31_len1024</a>, <a class="el" href="arm__const__structs_8h.html#a9a2fcdb54300f75ef1fafe02954e9a61">arm_cfft_sR_q31_len128</a>, <a class="el" href="arm__const__structs_8h.html#a1336431c4d2a88d32c42308cfe2defa1">arm_cfft_sR_q31_len16</a>, <a class="el" href="arm__const__structs_8h.html#a420622d75b277070784083ddd44b95fb">arm_cfft_sR_q31_len2048</a>, <a class="el" href="arm__const__structs_8h.html#a3f2de67938bd228918e40f60f18dd6b5">arm_cfft_sR_q31_len256</a>, <a class="el" href="arm__const__structs_8h.html#a4c083c013ef17920cf8f28dc6f139a39">arm_cfft_sR_q31_len32</a>, <a class="el" href="arm__const__structs_8h.html#abfc9595f40a1c7aaba85e1328d824b1c">arm_cfft_sR_q31_len4096</a>, <a class="el" href="arm__const__structs_8h.html#aa337272cf78aaf6075e7e19d0a097d6f">arm_cfft_sR_q31_len512</a>, <a class="el" href="arm__const__structs_8h.html#ad11668a5662334e0bc6a2811c9cb1047">arm_cfft_sR_q31_len64</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a>, <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>, <a class="el" href="structarm__rfft__instance__q31.html#a3cb90cdc928a88b0203917dcb3dc1b71">arm_rfft_instance_q31::bitReverseFlagR</a>, <a class="el" href="structarm__rfft__instance__q31.html#af777b0cadd5abaf064323692c2e6693b">arm_rfft_instance_q31::fftLenReal</a>, <a class="el" href="structarm__rfft__instance__q31.html#af5c2615e6cde15524df38fa57ea32d94">arm_rfft_instance_q31::ifftFlagR</a>, <a class="el" href="structarm__rfft__instance__q31.html#a8fe10d425b59e096c23aa4bb5caa1974">arm_rfft_instance_q31::pCfft</a>, <a class="el" href="structarm__rfft__instance__q31.html#a2a0c944e66bab92fcbe19d1c29153250">arm_rfft_instance_q31::pTwiddleAReal</a>, <a class="el" href="structarm__rfft__instance__q31.html#ae5070be4c2e0327e618f5e1f4c5b9d80">arm_rfft_instance_q31::pTwiddleBReal</a>, <a class="el" href="group__RealFFT__Table.html#gaf1592a6cf0504675205074a43c3728a2">realCoefAQ31</a>, <a class="el" href="group__RealFFT__Table.html#ga1eb5745728a61c3715755f5d69a4a960">realCoefBQ31</a>, <a class="el" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>, and <a class="el" href="structarm__rfft__instance__q31.html#a6fc90252b579f7c29e01bd279334fc43">arm_rfft_instance_q31::twidCoefRModifier</a>.</p> - -<p>Referenced by <a class="el" href="group__DCT4__IDCT4.html#ga631bb59c7c97c814ff7147ecba6a716a">arm_dct4_init_q31()</a>.</p> +<dl class="section user"><dt></dt><dd>This function also initializes Twiddle factor table. </dd></dl> </div> </div> @@ -509,15 +788,14 @@ Real Inverse Fast Fourier Transform</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the Q15 RFFT/RIFFT structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input buffer. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q15 RFFT/RIFFT structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to input buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to output buffer </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<dl class="section user"><dt>Input an output formats:</dt><dd></dd></dl> -<dl class="section user"><dt></dt><dd>Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. Hence the output format is different for different RFFT sizes. The input and output formats for different RFFT sizes and number of bits to upscale are mentioned in the tables below for RFFT and RIFFT: </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Input an output formats</dt><dd>Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. Hence the output format is different for different RFFT sizes. The input and output formats for different RFFT sizes and number of bits to upscale are mentioned in the tables below for RFFT and RIFFT: </dd></dl> <dl class="section user"><dt></dt><dd><div class="image"> <img src="RFFTQ15.gif" alt="RFFTQ15.gif"/> <div class="caption"> @@ -529,8 +807,6 @@ Input and Output Formats for Q15 RFFT</div></div> Input and Output Formats for Q15 RIFFT</div></div> </dd></dl> -<p>References <a class="el" href="group__ComplexFFT.html#ga68cdacd2267a2967955e40e6b7ec1229">arm_cfft_q15()</a>, <a class="el" href="arm__rfft__q15_8c.html#a7c2a21793586f9a69c42140665550e09">arm_split_rfft_q15()</a>, <a class="el" href="arm__rfft__q15_8c.html#aa72a531dd15a53570dddaf01b62158f4">arm_split_rifft_q15()</a>, <a class="el" href="structarm__rfft__instance__q15.html#a4c65cd40e0098ec2f5c0dc31488b9bc6">arm_rfft_instance_q15::bitReverseFlagR</a>, <a class="el" href="structarm__rfft__instance__q15.html#aac5cf9e825917cbb14f439e56bb86ab3">arm_rfft_instance_q15::fftLenReal</a>, <a class="el" href="structarm__rfft__instance__q15.html#a8051ffe268c147e431e1bea7bb4c4258">arm_rfft_instance_q15::ifftFlagR</a>, <a class="el" href="structarm__rfft__instance__q15.html#a4329c15b056444746d37ff082a24d31a">arm_rfft_instance_q15::pCfft</a>, <a class="el" href="structarm__rfft__instance__q15.html#affbf2de522ac029432d98e8373c0ec53">arm_rfft_instance_q15::pTwiddleAReal</a>, <a class="el" href="structarm__rfft__instance__q15.html#a937d815022adc557b435ba8c6cd58b0d">arm_rfft_instance_q15::pTwiddleBReal</a>, and <a class="el" href="structarm__rfft__instance__q15.html#afd444d05858c5f419980e94e8240d5c3">arm_rfft_instance_q15::twidCoefRModifier</a>.</p> - </div> </div> <a class="anchor" id="gabaeab5646aeea9844e6d42ca8c73fe3a"></a> @@ -564,30 +840,25 @@ Input and Output Formats for Q15 RIFFT</div></div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*S</td><td>points to an instance of the Q31 RFFT/RIFFT structure. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input buffer. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the output buffer. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the Q31 RFFT/RIFFT structure </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to input buffer </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to output buffer </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl> -<dl class="section user"><dt>Input an output formats:</dt><dd></dd></dl> -<dl class="section user"><dt></dt><dd>Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. Hence the output format is different for different RFFT sizes. The input and output formats for different RFFT sizes and number of bits to upscale are mentioned in the tables below for RFFT and RIFFT: </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Input an output formats</dt><dd>Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. Hence the output format is different for different RFFT sizes. The input and output formats for different RFFT sizes and number of bits to upscale are mentioned in the tables below for RFFT and RIFFT: </dd></dl> <dl class="section user"><dt></dt><dd><div class="image"> <img src="RFFTQ31.gif" alt="RFFTQ31.gif"/> <div class="caption"> Input and Output Formats for Q31 RFFT</div></div> - </dd></dl> +</dd></dl> <dl class="section user"><dt></dt><dd><div class="image"> <img src="RIFFTQ31.gif" alt="RIFFTQ31.gif"/> <div class="caption"> Input and Output Formats for Q31 RIFFT</div></div> </dd></dl> -<p>References <a class="el" href="group__ComplexFFT.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31()</a>, <a class="el" href="arm__rfft__q31_8c.html#a520e1c358d44fcd2724cb19d46eb5dfa">arm_split_rfft_q31()</a>, <a class="el" href="arm__rfft__q31_8c.html#acc62dd39a59091c4d6a80d4e55adeb13">arm_split_rifft_q31()</a>, <a class="el" href="structarm__rfft__instance__q31.html#a3cb90cdc928a88b0203917dcb3dc1b71">arm_rfft_instance_q31::bitReverseFlagR</a>, <a class="el" href="structarm__rfft__instance__q31.html#af777b0cadd5abaf064323692c2e6693b">arm_rfft_instance_q31::fftLenReal</a>, <a class="el" href="structarm__rfft__instance__q31.html#af5c2615e6cde15524df38fa57ea32d94">arm_rfft_instance_q31::ifftFlagR</a>, <a class="el" href="structarm__rfft__instance__q31.html#a8fe10d425b59e096c23aa4bb5caa1974">arm_rfft_instance_q31::pCfft</a>, <a class="el" href="structarm__rfft__instance__q31.html#a2a0c944e66bab92fcbe19d1c29153250">arm_rfft_instance_q31::pTwiddleAReal</a>, <a class="el" href="structarm__rfft__instance__q31.html#ae5070be4c2e0327e618f5e1f4c5b9d80">arm_rfft_instance_q31::pTwiddleBReal</a>, and <a class="el" href="structarm__rfft__instance__q31.html#a6fc90252b579f7c29e01bd279334fc43">arm_rfft_instance_q31::twidCoefRModifier</a>.</p> - -<p>Referenced by <a class="el" href="group__DCT4__IDCT4.html#gad04d0baab6ed081d8e8afe02538eb80b">arm_dct4_q31()</a>.</p> - </div> </div> </div><!-- contents --> @@ -595,7 +866,7 @@ Input and Output Formats for Q31 RIFFT</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:22 for CMSIS-DSP by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:20:40 for CMSIS-DSP Version 1.7.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 |