git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/structarm__lms__norm__instance__q31.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>CMSIS DSP Software Library: arm_lms_norm_instance_q31 Struct Reference</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javaScript" src="search/search.js"></script>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 </head>
  11 <body onload='searchBox.OnSelectItem(0);'>
  12 <!-- Generated by Doxygen 1.7.2 -->
  13 <script type="text/javascript"><!--
  14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15 --></script>
  16 <div class="navigation" id="top">
  17   <div class="tabs">
  18     <ul class="tablist">
  19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20       <li><a href="modules.html"><span>Modules</span></a></li>
  21       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li><a href="examples.html"><span>Examples</span></a></li>
  24       <li id="searchli">
  25         <div id="MSearchBox" class="MSearchBoxInactive">
  26         <span class="left">
  27           <img id="MSearchSelect" src="search/mag_sel.png"
  28                onmouseover="return searchBox.OnSearchSelectShow()"
  29                onmouseout="return searchBox.OnSearchSelectHide()"
  30                alt=""/>
  31           <input type="text" id="MSearchField" value="Search" accesskey="S"
  32                onfocus="searchBox.OnSearchFieldFocus(true)"
  33                onblur="searchBox.OnSearchFieldFocus(false)"
  34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  35           </span><span class="right">
  36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  37           </span>
  38         </div>
  39       </li>
  40     </ul>
  41   </div>
  42   <div class="tabs2">
  43     <ul class="tablist">
  44       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  46     </ul>
  47   </div>
  48 </div>
  49 <div class="header">
  50   <div class="summary">
  51 <a href="#pub-attribs">Data Fields</a>  </div>
  52   <div class="headertitle">
  53 <h1>arm_lms_norm_instance_q31 Struct Reference</h1>  </div>
  54 </div>
  55 <div class="contents">
  56 <!-- doxytag: class="arm_lms_norm_instance_q31" -->
  57 <p>Instance structure for the Q31 normalized LMS filter.
  58 <a href="#_details">More...</a></p>
  59
  60 <p><code>#include &lt;<a class="el" href="arm__math_8h_source.html">arm_math.h</a>&gt;</code></p>
  61 <table class="memberdecls">
  62 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
  63 Data Fields</h2></td></tr>
  64 <tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a28e4c085af69c9c3e2e95dacf8004c3e">numTaps</a></td></tr>
  65 <tr><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__lms__norm__instance__q31.html#a6b25c96cf048b77078d62f4252a01ec4">pState</a></td></tr>
  66 <tr><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__lms__norm__instance__q31.html#a57a64c1ff102d033c1bd05043f1d9955">pCoeffs</a></td></tr>
  67 <tr><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__lms__norm__instance__q31.html#ad3dd2a2406e02fdaa7782ba6c3940a64">mu</a></td></tr>
  68 <tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__lms__norm__instance__q31.html#a28d7b9e437817f83397e081967e90f3c">postShift</a></td></tr>
  69 <tr><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__lms__norm__instance__q31.html#a85836d0907077b9ac660f7bbbaa9d694">recipTable</a></td></tr>
  70 <tr><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__lms__norm__instance__q31.html#a3c0ae42869afec8555dc8e3a7ef9b386">energy</a></td></tr>
  71 <tr><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__lms__norm__instance__q31.html#a47c4466d644e0d8ba407995adfa9b917">x0</a></td></tr>
  72 </table>
  73 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  74 <p>Instance structure for the Q31 normalized LMS filter. </p>
  75
  76 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04105">4105</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
  77 <hr/><h2>Field Documentation</h2>
  78 <a class="anchor" id="a28e4c085af69c9c3e2e95dacf8004c3e"></a><!-- doxytag: member="arm_lms_norm_instance_q31::numTaps" ref="a28e4c085af69c9c3e2e95dacf8004c3e" args="" -->
  79 <div class="memitem">
  80 <div class="memproto">
  81       <table class="memname">
  82         <tr>
  83           <td class="memname">uint16_t <a class="el" href="structarm__lms__norm__instance__q31.html#a28e4c085af69c9c3e2e95dacf8004c3e">arm_lms_norm_instance_q31::numTaps</a></td>
  84         </tr>
  85       </table>
  86 </div>
  87 <div class="memdoc">
  88 <p>number of coefficients in the filter. </p>
  89
  90 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04107">4107</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
  91
  92 </div>
  93 </div>
  94 <a class="anchor" id="a6b25c96cf048b77078d62f4252a01ec4"></a><!-- doxytag: member="arm_lms_norm_instance_q31::pState" ref="a6b25c96cf048b77078d62f4252a01ec4" args="" -->
  95 <div class="memitem">
  96 <div class="memproto">
  97       <table class="memname">
  98         <tr>
  99           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* <a class="el" href="structarm__lms__norm__instance__q31.html#a6b25c96cf048b77078d62f4252a01ec4">arm_lms_norm_instance_q31::pState</a></td>
 100         </tr>
 101       </table>
 102 </div>
 103 <div class="memdoc">
 104 <p>points to the state variable array. The array is of length numTaps+blockSize-1. </p>
 105
 106 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04108">4108</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 107
 108 </div>
 109 </div>
 110 <a class="anchor" id="a57a64c1ff102d033c1bd05043f1d9955"></a><!-- doxytag: member="arm_lms_norm_instance_q31::pCoeffs" ref="a57a64c1ff102d033c1bd05043f1d9955" args="" -->
 111 <div class="memitem">
 112 <div class="memproto">
 113       <table class="memname">
 114         <tr>
 115           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* <a class="el" href="structarm__lms__norm__instance__q31.html#a57a64c1ff102d033c1bd05043f1d9955">arm_lms_norm_instance_q31::pCoeffs</a></td>
 116         </tr>
 117       </table>
 118 </div>
 119 <div class="memdoc">
 120 <p>points to the coefficient array. The array is of length numTaps. </p>
 121
 122 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04109">4109</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 123
 124 </div>
 125 </div>
 126 <a class="anchor" id="ad3dd2a2406e02fdaa7782ba6c3940a64"></a><!-- doxytag: member="arm_lms_norm_instance_q31::mu" ref="ad3dd2a2406e02fdaa7782ba6c3940a64" args="" -->
 127 <div class="memitem">
 128 <div class="memproto">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> <a class="el" href="structarm__lms__norm__instance__q31.html#ad3dd2a2406e02fdaa7782ba6c3940a64">arm_lms_norm_instance_q31::mu</a></td>
 132         </tr>
 133       </table>
 134 </div>
 135 <div class="memdoc">
 136 <p>step size that controls filter coefficient updates. </p>
 137
 138 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04110">4110</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 139
 140 </div>
 141 </div>
 142 <a class="anchor" id="a28d7b9e437817f83397e081967e90f3c"></a><!-- doxytag: member="arm_lms_norm_instance_q31::postShift" ref="a28d7b9e437817f83397e081967e90f3c" args="" -->
 143 <div class="memitem">
 144 <div class="memproto">
 145       <table class="memname">
 146         <tr>
 147           <td class="memname">uint8_t <a class="el" href="structarm__lms__norm__instance__q31.html#a28d7b9e437817f83397e081967e90f3c">arm_lms_norm_instance_q31::postShift</a></td>
 148         </tr>
 149       </table>
 150 </div>
 151 <div class="memdoc">
 152 <p>bit shift applied to coefficients. </p>
 153
 154 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04111">4111</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 155
 156 </div>
 157 </div>
 158 <a class="anchor" id="a85836d0907077b9ac660f7bbbaa9d694"></a><!-- doxytag: member="arm_lms_norm_instance_q31::recipTable" ref="a85836d0907077b9ac660f7bbbaa9d694" args="" -->
 159 <div class="memitem">
 160 <div class="memproto">
 161       <table class="memname">
 162         <tr>
 163           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* <a class="el" href="structarm__lms__norm__instance__q31.html#a85836d0907077b9ac660f7bbbaa9d694">arm_lms_norm_instance_q31::recipTable</a></td>
 164         </tr>
 165       </table>
 166 </div>
 167 <div class="memdoc">
 168 <p>points to the reciprocal initial value table. </p>
 169
 170 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04112">4112</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 171
 172 </div>
 173 </div>
 174 <a class="anchor" id="a3c0ae42869afec8555dc8e3a7ef9b386"></a><!-- doxytag: member="arm_lms_norm_instance_q31::energy" ref="a3c0ae42869afec8555dc8e3a7ef9b386" args="" -->
 175 <div class="memitem">
 176 <div class="memproto">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> <a class="el" href="structarm__lms__norm__instance__q31.html#a3c0ae42869afec8555dc8e3a7ef9b386">arm_lms_norm_instance_q31::energy</a></td>
 180         </tr>
 181       </table>
 182 </div>
 183 <div class="memdoc">
 184 <p>saves previous frame energy. </p>
 185
 186 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04113">4113</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 187
 188 </div>
 189 </div>
 190 <a class="anchor" id="a47c4466d644e0d8ba407995adfa9b917"></a><!-- doxytag: member="arm_lms_norm_instance_q31::x0" ref="a47c4466d644e0d8ba407995adfa9b917" args="" -->
 191 <div class="memitem">
 192 <div class="memproto">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> <a class="el" href="structarm__lms__norm__instance__q31.html#a47c4466d644e0d8ba407995adfa9b917">arm_lms_norm_instance_q31::x0</a></td>
 196         </tr>
 197       </table>
 198 </div>
 199 <div class="memdoc">
 200 <p>saves previous input sample. </p>
 201
 202 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l04114">4114</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
 203
 204 </div>
 205 </div>
 206 <hr/>The documentation for this struct was generated from the following file:<ul>
 207 <li><a class="el" href="arm__math_8h_source.html">arm_math.h</a></li>
 208 </ul>
 209 </div>
 210 <!--- window showing the filter options -->
 211 <div id="MSearchSelectWindow"
 212      onmouseover="return searchBox.OnSearchSelectShow()"
 213      onmouseout="return searchBox.OnSearchSelectHide()"
 214      onkeydown="return searchBox.OnSearchSelectKey(event)">
 215 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
 216
 217 <!-- iframe showing the search results (closed by default) -->
 218 <div id="MSearchResultsWindow">
 219 <iframe src="" frameborder="0"
 220         name="MSearchResults" id="MSearchResults">
 221 </iframe>
 222 </div>
 223
 224 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:23 for CMSIS DSP Software Library by&#160;
 225 <a href="http://www.doxygen.org/index.html">
 226 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 227 </body>
 228 </html>