structarm__fir__sparse__instance__q31.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>CMSIS-DSP: arm_fir_sparse_instance_q31 Struct Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. </script>
  17. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <script type="text/javascript">
  20. $(document).ready(function() { searchBox.OnSelectItem(0); });
  21. </script>
  22. <link href="stylsheetf" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 46px;">
  30. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  31. <td style="padding-left: 0.5em;">
  32. <div id="projectname">CMSIS-DSP
  33. &#160;<span id="projectnumber">Version 1.4.4</span>
  34. </div>
  35. <div id="projectbrief">CMSIS DSP Software Library</div>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. <!-- end header part -->
  42. <div id="CMSISnav" class="tabs1">
  43. <ul class="tablist">
  44. <li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
  45. <li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
  46. <li><a href="../../Driver/html/index.html"><span>Driver</span></a></li>
  47. <li class="current"><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
  48. <li><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
  49. <li><a href="../../Pack/html/index.html"><span>Pack</span></a></li>
  50. <li><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.2 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. <div id="navrow2" class="tabs2">
  81. <ul class="tablist">
  82. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  83. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  84. </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div id="side-nav" class="ui-resizable side-nav-resizable">
  88. <div id="nav-tree">
  89. <div id="nav-tree-contents">
  90. <div id="nav-sync" class="sync"></div>
  91. </div>
  92. </div>
  93. <div id="splitbar" style="-moz-user-select:none;"
  94. class="ui-resizable-handle">
  95. </div>
  96. </div>
  97. <script type="text/javascript">
  98. $(document).ready(function(){initNavTree('structarm__fir__sparse__instance__q31.html','');});
  99. </script>
  100. <div id="doc-content">
  101. <!-- window showing the filter options -->
  102. <div id="MSearchSelectWindow"
  103. onmouseover="return searchBox.OnSearchSelectShow()"
  104. onmouseout="return searchBox.OnSearchSelectHide()"
  105. onkeydown="return searchBox.OnSearchSelectKey(event)">
  106. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  107. <!-- iframe showing the search results (closed by default) -->
  108. <div id="MSearchResultsWindow">
  109. <iframe src="javascript:void(0)" frameborder="0"
  110. name="MSearchResults" id="MSearchResults">
  111. </iframe>
  112. </div>
  113. <div class="header">
  114. <div class="summary">
  115. <a href="#pub-attribs">Data Fields</a> </div>
  116. <div class="headertitle">
  117. <div class="title">arm_fir_sparse_instance_q31 Struct Reference</div> </div>
  118. </div><!--header-->
  119. <div class="contents">
  120. <p>Instance structure for the Q31 sparse FIR filter.
  121. </p>
  122. <table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  124. Data Fields</h2></td></tr>
  125. <tr class="memitem:a07b6c01e58ec6dde384719130d36b0dc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__sparse__instance__q31.html#a07b6c01e58ec6dde384719130d36b0dc">numTaps</a></td></tr>
  126. <tr class="separator:a07b6c01e58ec6dde384719130d36b0dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a557ed9d477e76e4ad2019344f19f568a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__sparse__instance__q31.html#a557ed9d477e76e4ad2019344f19f568a">stateIndex</a></td></tr>
  128. <tr class="separator:a557ed9d477e76e4ad2019344f19f568a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a830be89daa5a393b225048889aa045d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__sparse__instance__q31.html#a830be89daa5a393b225048889aa045d1">pState</a></td></tr>
  130. <tr class="separator:a830be89daa5a393b225048889aa045d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a093d6227f0d1597982cd083fb126f4e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__sparse__instance__q31.html#a093d6227f0d1597982cd083fb126f4e0">pCoeffs</a></td></tr>
  132. <tr class="separator:a093d6227f0d1597982cd083fb126f4e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:afdd3a1dc72132c854dc379154b68b674"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__sparse__instance__q31.html#afdd3a1dc72132c854dc379154b68b674">maxDelay</a></td></tr>
  134. <tr class="separator:afdd3a1dc72132c854dc379154b68b674"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ab87ae457adec8f727afefaa2599fc983"><td class="memItemLeft" align="right" valign="top">int32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__sparse__instance__q31.html#ab87ae457adec8f727afefaa2599fc983">pTapDelay</a></td></tr>
  136. <tr class="separator:ab87ae457adec8f727afefaa2599fc983"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <h2 class="groupheader">Field Documentation</h2>
  139. <a class="anchor" id="afdd3a1dc72132c854dc379154b68b674"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">uint16_t arm_fir_sparse_instance_q31::maxDelay</td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>maximum offset specified by the pTapDelay array. </p>
  149. <p>Referenced by <a class="el" href="group___f_i_r___sparse.html#ga9a0bb2134bc85d3e55c6be6d946ee634">arm_fir_sparse_init_q31()</a>, and <a class="el" href="group___f_i_r___sparse.html#ga03e9c2f0f35ad67d20bac66be9f920ec">arm_fir_sparse_q31()</a>.</p>
  150. </div>
  151. </div>
  152. <a class="anchor" id="a07b6c01e58ec6dde384719130d36b0dc"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">uint16_t arm_fir_sparse_instance_q31::numTaps</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>number of coefficients in the filter. </p>
  162. <p>Referenced by <a class="el" href="group___f_i_r___sparse.html#ga9a0bb2134bc85d3e55c6be6d946ee634">arm_fir_sparse_init_q31()</a>, and <a class="el" href="group___f_i_r___sparse.html#ga03e9c2f0f35ad67d20bac66be9f920ec">arm_fir_sparse_q31()</a>.</p>
  163. </div>
  164. </div>
  165. <a class="anchor" id="a093d6227f0d1597982cd083fb126f4e0"></a>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* arm_fir_sparse_instance_q31::pCoeffs</td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>points to the coefficient array. The array is of length numTaps. </p>
  175. <p>Referenced by <a class="el" href="group___f_i_r___sparse.html#ga9a0bb2134bc85d3e55c6be6d946ee634">arm_fir_sparse_init_q31()</a>, and <a class="el" href="group___f_i_r___sparse.html#ga03e9c2f0f35ad67d20bac66be9f920ec">arm_fir_sparse_q31()</a>.</p>
  176. </div>
  177. </div>
  178. <a class="anchor" id="a830be89daa5a393b225048889aa045d1"></a>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* arm_fir_sparse_instance_q31::pState</td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>points to the state buffer array. The array is of length maxDelay+blockSize-1. </p>
  188. <p>Referenced by <a class="el" href="group___f_i_r___sparse.html#ga9a0bb2134bc85d3e55c6be6d946ee634">arm_fir_sparse_init_q31()</a>, and <a class="el" href="group___f_i_r___sparse.html#ga03e9c2f0f35ad67d20bac66be9f920ec">arm_fir_sparse_q31()</a>.</p>
  189. </div>
  190. </div>
  191. <a class="anchor" id="ab87ae457adec8f727afefaa2599fc983"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">int32_t* arm_fir_sparse_instance_q31::pTapDelay</td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <p>points to the array of delay values. The array is of length numTaps. </p>
  201. <p>Referenced by <a class="el" href="group___f_i_r___sparse.html#ga9a0bb2134bc85d3e55c6be6d946ee634">arm_fir_sparse_init_q31()</a>, and <a class="el" href="group___f_i_r___sparse.html#ga03e9c2f0f35ad67d20bac66be9f920ec">arm_fir_sparse_q31()</a>.</p>
  202. </div>
  203. </div>
  204. <a class="anchor" id="a557ed9d477e76e4ad2019344f19f568a"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">uint16_t arm_fir_sparse_instance_q31::stateIndex</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>state buffer index. Points to the oldest sample in the state buffer. </p>
  214. <p>Referenced by <a class="el" href="group___f_i_r___sparse.html#ga9a0bb2134bc85d3e55c6be6d946ee634">arm_fir_sparse_init_q31()</a>, and <a class="el" href="group___f_i_r___sparse.html#ga03e9c2f0f35ad67d20bac66be9f920ec">arm_fir_sparse_q31()</a>.</p>
  215. </div>
  216. </div>
  217. </div><!-- contents -->
  218. </div><!-- doc-content -->
  219. <!-- start footer part -->
  220. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  221. <ul>
  222. <li class="navelem"><a class="el" href="structarm__fir__sparse__instance__q31.html">arm_fir_sparse_instance_q31</a></li>
  223. <li class="footer">Generated on Tue Sep 23 2014 18:52:44 for CMSIS-DSP by ARM Ltd. All rights reserved.
  224. <!--
  225. <a href="http://www.doxygen.org/index.html">
  226. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2
  227. -->
  228. </li>
  229. </ul>
  230. </div>
  231. </body>
  232. </html>