You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
554 lines
35 KiB
HTML
554 lines
35 KiB
HTML
<!-- HTML header for doxygen 1.9.2-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CMSIS-DSP: Complex FFT Q31</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="footer.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
|
<link href="$extra_stylesheet" rel="stylesheet" type="text/css" />
|
|
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
|
|
<link href="version.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../version.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 55px;">
|
|
<td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
|
|
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
|
|
<div id="projectname">CMSIS-DSP
|
|
 <span id="projectnumber"><script type="text/javascript">
|
|
<!--
|
|
writeHeader.call(this);
|
|
writeVersionDropdown(this);
|
|
//-->
|
|
</script>
|
|
</span>
|
|
</div>
|
|
<div id="projectbrief">CMSIS DSP Software Library</div>
|
|
</td>
|
|
<!--END !PROJECT_NAME-->
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Usage and Description</span></a></li>
|
|
<li class="current"><a href="modules.html"><span> API Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.svg"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__ComplexFFTQ31.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Complex FFT Q31<div class="ingroups"><a class="el" href="group__groupTransforms.html">Transform Functions</a> » <a class="el" href="group__ComplexFFT.html">Complex FFT Functions</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga56469f2da7e5cb59f012575546fc3595"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga56469f2da7e5cb59f012575546fc3595">arm_cfft_init_4096_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:ga56469f2da7e5cb59f012575546fc3595"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 4096 samples. <a href="group__ComplexFFTQ31.html#ga56469f2da7e5cb59f012575546fc3595">More...</a><br /></td></tr>
|
|
<tr class="separator:ga56469f2da7e5cb59f012575546fc3595"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1a596ee7e887434fa6083ed0882ed453"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga1a596ee7e887434fa6083ed0882ed453">arm_cfft_init_2048_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:ga1a596ee7e887434fa6083ed0882ed453"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 2048 samples. <a href="group__ComplexFFTQ31.html#ga1a596ee7e887434fa6083ed0882ed453">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1a596ee7e887434fa6083ed0882ed453"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga613fe2ec32698b5d8f27dad9cac42704"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga613fe2ec32698b5d8f27dad9cac42704">arm_cfft_init_1024_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:ga613fe2ec32698b5d8f27dad9cac42704"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 1024 samples. <a href="group__ComplexFFTQ31.html#ga613fe2ec32698b5d8f27dad9cac42704">More...</a><br /></td></tr>
|
|
<tr class="separator:ga613fe2ec32698b5d8f27dad9cac42704"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa7142f240c982739017be80f65c86ebb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#gaa7142f240c982739017be80f65c86ebb">arm_cfft_init_512_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:gaa7142f240c982739017be80f65c86ebb"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 512 samples. <a href="group__ComplexFFTQ31.html#gaa7142f240c982739017be80f65c86ebb">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa7142f240c982739017be80f65c86ebb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gada1e3d2da12c63d793b3c470b09b2d03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#gada1e3d2da12c63d793b3c470b09b2d03">arm_cfft_init_256_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:gada1e3d2da12c63d793b3c470b09b2d03"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 256 samples. <a href="group__ComplexFFTQ31.html#gada1e3d2da12c63d793b3c470b09b2d03">More...</a><br /></td></tr>
|
|
<tr class="separator:gada1e3d2da12c63d793b3c470b09b2d03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga773a056eeb7ae6359a6cce7ac78b597f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga773a056eeb7ae6359a6cce7ac78b597f">arm_cfft_init_128_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:ga773a056eeb7ae6359a6cce7ac78b597f"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 128 samples. <a href="group__ComplexFFTQ31.html#ga773a056eeb7ae6359a6cce7ac78b597f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga773a056eeb7ae6359a6cce7ac78b597f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5c88c65ad09319307dd81e03ea5c8886"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga5c88c65ad09319307dd81e03ea5c8886">arm_cfft_init_64_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:ga5c88c65ad09319307dd81e03ea5c8886"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 64 samples. <a href="group__ComplexFFTQ31.html#ga5c88c65ad09319307dd81e03ea5c8886">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5c88c65ad09319307dd81e03ea5c8886"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae1ee7e944572d8066f6963ce5c3e05c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#gae1ee7e944572d8066f6963ce5c3e05c6">arm_cfft_init_32_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:gae1ee7e944572d8066f6963ce5c3e05c6"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 32 samples. <a href="group__ComplexFFTQ31.html#gae1ee7e944572d8066f6963ce5c3e05c6">More...</a><br /></td></tr>
|
|
<tr class="separator:gae1ee7e944572d8066f6963ce5c3e05c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8000eed7f4bbe305c6d96d41839c9ec2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga8000eed7f4bbe305c6d96d41839c9ec2">arm_cfft_init_16_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S)</td></tr>
|
|
<tr class="memdesc:ga8000eed7f4bbe305c6d96d41839c9ec2"><td class="mdescLeft"> </td><td class="mdescRight">Initialization function for the cfft q31 function for 16 samples. <a href="group__ComplexFFTQ31.html#ga8000eed7f4bbe305c6d96d41839c9ec2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8000eed7f4bbe305c6d96d41839c9ec2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga196bb4e5466c74650b6cc76bb2efdfe2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga196bb4e5466c74650b6cc76bb2efdfe2">arm_cfft_init_q31</a> (<a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S, uint16_t fftLen)</td></tr>
|
|
<tr class="memdesc:ga196bb4e5466c74650b6cc76bb2efdfe2"><td class="mdescLeft"> </td><td class="mdescRight">Generic initialization function for the cfft q31 function. <a href="group__ComplexFFTQ31.html#ga196bb4e5466c74650b6cc76bb2efdfe2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga196bb4e5466c74650b6cc76bb2efdfe2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5a0008bd997ab6e2e299ef2fb272fb4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ComplexFFTQ31.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">arm_cfft_q31</a> (const <a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> *S, <a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *p1, uint8_t <a class="el" href="arm__fft__bin__example__f32_8c.html#a379ccb99013d369a41b49619083c16ef">ifftFlag</a>, uint8_t bitReverseFlag)</td></tr>
|
|
<tr class="memdesc:ga5a0008bd997ab6e2e299ef2fb272fb4b"><td class="mdescLeft"> </td><td class="mdescRight">Processing function for the Q31 complex FFT. <a href="group__ComplexFFTQ31.html#ga5a0008bd997ab6e2e299ef2fb272fb4b">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5a0008bd997ab6e2e299ef2fb272fb4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga613fe2ec32698b5d8f27dad9cac42704" name="ga613fe2ec32698b5d8f27dad9cac42704"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga613fe2ec32698b5d8f27dad9cac42704">◆ </a></span>arm_cfft_init_1024_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_1024_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga773a056eeb7ae6359a6cce7ac78b597f" name="ga773a056eeb7ae6359a6cce7ac78b597f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga773a056eeb7ae6359a6cce7ac78b597f">◆ </a></span>arm_cfft_init_128_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_128_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8000eed7f4bbe305c6d96d41839c9ec2" name="ga8000eed7f4bbe305c6d96d41839c9ec2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8000eed7f4bbe305c6d96d41839c9ec2">◆ </a></span>arm_cfft_init_16_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_16_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1a596ee7e887434fa6083ed0882ed453" name="ga1a596ee7e887434fa6083ed0882ed453"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1a596ee7e887434fa6083ed0882ed453">◆ </a></span>arm_cfft_init_2048_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_2048_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gada1e3d2da12c63d793b3c470b09b2d03" name="gada1e3d2da12c63d793b3c470b09b2d03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gada1e3d2da12c63d793b3c470b09b2d03">◆ </a></span>arm_cfft_init_256_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_256_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae1ee7e944572d8066f6963ce5c3e05c6" name="gae1ee7e944572d8066f6963ce5c3e05c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae1ee7e944572d8066f6963ce5c3e05c6">◆ </a></span>arm_cfft_init_32_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_32_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga56469f2da7e5cb59f012575546fc3595" name="ga56469f2da7e5cb59f012575546fc3595"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga56469f2da7e5cb59f012575546fc3595">◆ </a></span>arm_cfft_init_4096_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_4096_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa7142f240c982739017be80f65c86ebb" name="gaa7142f240c982739017be80f65c86ebb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa7142f240c982739017be80f65c86ebb">◆ </a></span>arm_cfft_init_512_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_512_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5c88c65ad09319307dd81e03ea5c8886" name="ga5c88c65ad09319307dd81e03ea5c8886"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5c88c65ad09319307dd81e03ea5c8886">◆ </a></span>arm_cfft_init_64_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_64_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</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 instance of the floating-point CFFT structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga196bb4e5466c74650b6cc76bb2efdfe2" name="ga196bb4e5466c74650b6cc76bb2efdfe2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga196bb4e5466c74650b6cc76bb2efdfe2">◆ </a></span>arm_cfft_init_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_cfft_init_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> * </td>
|
|
<td class="paramname"><em>S</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>fftLen</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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 instance of the floating-point CFFT structure </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">fftLen</td><td>fft length (number of complex samples) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>execution status<ul>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : Operation successful</li>
|
|
<li><a class="el" href="arm__math__types_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : an error is detected</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Use of this function is mandatory only for the MVE version of the FFT.</dt><dd>Other versions can still initialize directly the data structure using variables declared in <a class="el" href="arm__const__structs_8h.html">arm_const_structs.h</a></dd></dl>
|
|
<dl class="section user"><dt></dt><dd>This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd>If you use CMSIS-DSP as a static library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5a0008bd997ab6e2e299ef2fb272fb4b" name="ga5a0008bd997ab6e2e299ef2fb272fb4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5a0008bd997ab6e2e299ef2fb272fb4b">◆ </a></span>arm_cfft_q31()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void arm_cfft_q31 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structarm__cfft__instance__q31.html">arm_cfft_instance_q31</a> * </td>
|
|
<td class="paramname"><em>S</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td>
|
|
<td class="paramname"><em>p1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>ifftFlag</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>bitReverseFlag</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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]</td><td class="paramname">S</td><td>points to an instance of the fixed-point CFFT structure </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">p1</td><td>points to the complex data buffer of size <code>2*fftLen</code>. Processing occurs in-place </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ifftFlag</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>none </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">
|
|
<script type="text/javascript">
|
|
<!--
|
|
writeFooter.call(this);
|
|
//-->
|
|
</script>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|