Added all the F4 libraries to the project
[fw/stlink] / exampleF4 / CMSIS / Documentation / DSP_Lib / html / structarm__fir__decimate__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_fir_decimate_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_fir_decimate_instance_q31 Struct Reference</h1>  </div>
54 </div>
55 <div class="contents">
56 <!-- doxytag: class="arm_fir_decimate_instance_q31" -->
57 <p>Instance structure for the Q31 FIR decimator.  
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">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__decimate__instance__q31.html#ad3d6936c36303b30dd38f1eddf248ae5">M</a></td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__fir__decimate__instance__q31.html#a37915d42b0dc5e3057ebe83110798482">numTaps</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__fir__decimate__instance__q31.html#a030d0391538c2481c5b348fd09a952ff">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__fir__decimate__instance__q31.html#a0ef0ef9e265f7ab873cfc6daa7593fdb">pState</a></td></tr>
68 </table>
69 <hr/><a name="_details"></a><h2>Detailed Description</h2>
70 <p>Instance structure for the Q31 FIR decimator. </p>
71
72 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l03226">3226</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
73 <hr/><h2>Field Documentation</h2>
74 <a class="anchor" id="ad3d6936c36303b30dd38f1eddf248ae5"></a><!-- doxytag: member="arm_fir_decimate_instance_q31::M" ref="ad3d6936c36303b30dd38f1eddf248ae5" args="" -->
75 <div class="memitem">
76 <div class="memproto">
77       <table class="memname">
78         <tr>
79           <td class="memname">uint8_t <a class="el" href="structarm__fir__decimate__instance__q31.html#ad3d6936c36303b30dd38f1eddf248ae5">arm_fir_decimate_instance_q31::M</a></td>
80         </tr>
81       </table>
82 </div>
83 <div class="memdoc">
84 <p>decimation factor. </p>
85
86 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l03228">3228</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
87
88 </div>
89 </div>
90 <a class="anchor" id="a37915d42b0dc5e3057ebe83110798482"></a><!-- doxytag: member="arm_fir_decimate_instance_q31::numTaps" ref="a37915d42b0dc5e3057ebe83110798482" args="" -->
91 <div class="memitem">
92 <div class="memproto">
93       <table class="memname">
94         <tr>
95           <td class="memname">uint16_t <a class="el" href="structarm__fir__decimate__instance__q31.html#a37915d42b0dc5e3057ebe83110798482">arm_fir_decimate_instance_q31::numTaps</a></td>
96         </tr>
97       </table>
98 </div>
99 <div class="memdoc">
100 <p>number of coefficients in the filter. </p>
101
102 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l03229">3229</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
103
104 </div>
105 </div>
106 <a class="anchor" id="a030d0391538c2481c5b348fd09a952ff"></a><!-- doxytag: member="arm_fir_decimate_instance_q31::pCoeffs" ref="a030d0391538c2481c5b348fd09a952ff" args="" -->
107 <div class="memitem">
108 <div class="memproto">
109       <table class="memname">
110         <tr>
111           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* <a class="el" href="structarm__fir__decimate__instance__q31.html#a030d0391538c2481c5b348fd09a952ff">arm_fir_decimate_instance_q31::pCoeffs</a></td>
112         </tr>
113       </table>
114 </div>
115 <div class="memdoc">
116 <p>points to the coefficient array. The array is of length numTaps. </p>
117
118 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l03230">3230</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
119
120 </div>
121 </div>
122 <a class="anchor" id="a0ef0ef9e265f7ab873cfc6daa7593fdb"></a><!-- doxytag: member="arm_fir_decimate_instance_q31::pState" ref="a0ef0ef9e265f7ab873cfc6daa7593fdb" args="" -->
123 <div class="memitem">
124 <div class="memproto">
125       <table class="memname">
126         <tr>
127           <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>* <a class="el" href="structarm__fir__decimate__instance__q31.html#a0ef0ef9e265f7ab873cfc6daa7593fdb">arm_fir_decimate_instance_q31::pState</a></td>
128         </tr>
129       </table>
130 </div>
131 <div class="memdoc">
132 <p>points to the state variable array. The array is of length numTaps+blockSize-1. </p>
133
134 <p>Definition at line <a class="el" href="arm__math_8h_source.html#l03231">3231</a> of file <a class="el" href="arm__math_8h_source.html">arm_math.h</a>.</p>
135
136 </div>
137 </div>
138 <hr/>The documentation for this struct was generated from the following file:<ul>
139 <li><a class="el" href="arm__math_8h_source.html">arm_math.h</a></li>
140 </ul>
141 </div>
142 <!--- window showing the filter options -->
143 <div id="MSearchSelectWindow"
144      onmouseover="return searchBox.OnSearchSelectShow()"
145      onmouseout="return searchBox.OnSearchSelectHide()"
146      onkeydown="return searchBox.OnSearchSelectKey(event)">
147 <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>
148
149 <!-- iframe showing the search results (closed by default) -->
150 <div id="MSearchResultsWindow">
151 <iframe src="" frameborder="0" 
152         name="MSearchResults" id="MSearchResults">
153 </iframe>
154 </div>
155
156 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:23 for CMSIS DSP Software Library by&#160;
157 <a href="http://www.doxygen.org/index.html">
158 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
159 </body>
160 </html>