git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group___min.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: Minimum</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><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>
  43 <div class="header">
  44   <div class="summary">
  45 <a href="#func-members">Functions</a>  </div>
  46   <div class="headertitle">
  47 <h1>Minimum<br/>
  48 <small>
  49 [<a class="el" href="group__group_stats.html">Statistics Functions</a>]</small>
  50 </h1>  </div>
  51 </div>
  52 <div class="contents">
  53 <table class="memberdecls">
  54 <tr><td colspan="2"><h2><a name="func-members"></a>
  55 Functions</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___min.html#gaf62b1673740fc516ea64daf777b7d74a">arm_min_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pResult, uint32_t *pIndex)</td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___min.html#gab20faeceb5ff5d2d9dd628c2ecf41303">arm_min_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pResult, uint32_t *pIndex)</td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___min.html#gad065e37535ebb726750ac1545cb3fa6f">arm_min_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pResult, uint32_t *pIndex)</td></tr>
  59 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___min.html#ga3631d38ac8d715fc14f6f1b343f4c4ed">arm_min_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pResult, uint32_t *pIndex)</td></tr>
  60 </table>
  61 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  62 <p>Computes the minimum value of an array of data. The function returns both the minimum value and its position within the array. There are separate functions for floating-point, Q31, Q15, and Q7 data types. </p>
  63 <hr/><h2>Function Documentation</h2>
  64 <a class="anchor" id="gaf62b1673740fc516ea64daf777b7d74a"></a><!-- doxytag: member="arm_min_f32.c::arm_min_f32" ref="gaf62b1673740fc516ea64daf777b7d74a" args="(float32_t *pSrc, uint32_t blockSize, float32_t *pResult, uint32_t *pIndex)" -->
  65 <div class="memitem">
  66 <div class="memproto">
  67       <table class="memname">
  68         <tr>
  69           <td class="memname">void arm_min_f32 </td>
  70           <td>(</td>
  71           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  72           <td class="paramname"> <em>pSrc</em>, </td>
  73         </tr>
  74         <tr>
  75           <td class="paramkey"></td>
  76           <td></td>
  77           <td class="paramtype">uint32_t&#160;</td>
  78           <td class="paramname"> <em>blockSize</em>, </td>
  79         </tr>
  80         <tr>
  81           <td class="paramkey"></td>
  82           <td></td>
  83           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  84           <td class="paramname"> <em>pResult</em>, </td>
  85         </tr>
  86         <tr>
  87           <td class="paramkey"></td>
  88           <td></td>
  89           <td class="paramtype">uint32_t *&#160;</td>
  90           <td class="paramname"> <em>pIndex</em>&#160;</td>
  91         </tr>
  92         <tr>
  93           <td></td>
  94           <td>)</td>
  95           <td></td><td></td>
  96         </tr>
  97       </table>
  98 </div>
  99 <div class="memdoc">
 100
 101 <p>Minimum value of a floating-point vector. </p>
 102 <dl><dt><b>Parameters:</b></dt><dd>
 103   <table class="params">
 104     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 105     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
 106     <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>minimum value returned here </td></tr>
 107     <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of minimum value returned here </td></tr>
 108   </table>
 109   </dd>
 110 </dl>
 111 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 112 <dl><dt><b>Examples: </b></dt><dd><a class="el" href="arm_class_marks_example_f32_8c-example.html#a19">arm_class_marks_example_f32.c</a>, and <a class="el" href="arm_signal_converge_example_f32_8c-example.html#a33">arm_signal_converge_example_f32.c</a>.</dd>
 113 </dl>
 114 <p>Definition at line <a class="el" href="arm__min__f32_8c_source.html#l00060">60</a> of file <a class="el" href="arm__min__f32_8c_source.html">arm_min_f32.c</a>.</p>
 115
 116 </div>
 117 </div>
 118 <a class="anchor" id="gab20faeceb5ff5d2d9dd628c2ecf41303"></a><!-- doxytag: member="arm_min_q31.c::arm_min_q31" ref="gab20faeceb5ff5d2d9dd628c2ecf41303" args="(q31_t *pSrc, uint32_t blockSize, q31_t *pResult, uint32_t *pIndex)" -->
 119 <div class="memitem">
 120 <div class="memproto">
 121       <table class="memname">
 122         <tr>
 123           <td class="memname">void arm_min_q31 </td>
 124           <td>(</td>
 125           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 126           <td class="paramname"> <em>pSrc</em>, </td>
 127         </tr>
 128         <tr>
 129           <td class="paramkey"></td>
 130           <td></td>
 131           <td class="paramtype">uint32_t&#160;</td>
 132           <td class="paramname"> <em>blockSize</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
 138           <td class="paramname"> <em>pResult</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype">uint32_t *&#160;</td>
 144           <td class="paramname"> <em>pIndex</em>&#160;</td>
 145         </tr>
 146         <tr>
 147           <td></td>
 148           <td>)</td>
 149           <td></td><td></td>
 150         </tr>
 151       </table>
 152 </div>
 153 <div class="memdoc">
 154
 155 <p>Minimum value of a Q31 vector. </p>
 156 <dl><dt><b>Parameters:</b></dt><dd>
 157   <table class="params">
 158     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 159     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
 160     <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>minimum value returned here </td></tr>
 161     <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of minimum value returned here </td></tr>
 162   </table>
 163   </dd>
 164 </dl>
 165 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 166
 167 <p>Definition at line <a class="el" href="arm__min__q31_8c_source.html#l00053">53</a> of file <a class="el" href="arm__min__q31_8c_source.html">arm_min_q31.c</a>.</p>
 168
 169 </div>
 170 </div>
 171 <a class="anchor" id="gad065e37535ebb726750ac1545cb3fa6f"></a><!-- doxytag: member="arm_min_q15.c::arm_min_q15" ref="gad065e37535ebb726750ac1545cb3fa6f" args="(q15_t *pSrc, uint32_t blockSize, q15_t *pResult, uint32_t *pIndex)" -->
 172 <div class="memitem">
 173 <div class="memproto">
 174       <table class="memname">
 175         <tr>
 176           <td class="memname">void arm_min_q15 </td>
 177           <td>(</td>
 178           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 179           <td class="paramname"> <em>pSrc</em>, </td>
 180         </tr>
 181         <tr>
 182           <td class="paramkey"></td>
 183           <td></td>
 184           <td class="paramtype">uint32_t&#160;</td>
 185           <td class="paramname"> <em>blockSize</em>, </td>
 186         </tr>
 187         <tr>
 188           <td class="paramkey"></td>
 189           <td></td>
 190           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
 191           <td class="paramname"> <em>pResult</em>, </td>
 192         </tr>
 193         <tr>
 194           <td class="paramkey"></td>
 195           <td></td>
 196           <td class="paramtype">uint32_t *&#160;</td>
 197           <td class="paramname"> <em>pIndex</em>&#160;</td>
 198         </tr>
 199         <tr>
 200           <td></td>
 201           <td>)</td>
 202           <td></td><td></td>
 203         </tr>
 204       </table>
 205 </div>
 206 <div class="memdoc">
 207
 208 <p>Minimum value of a Q15 vector. </p>
 209 <dl><dt><b>Parameters:</b></dt><dd>
 210   <table class="params">
 211     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 212     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
 213     <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>minimum value returned here </td></tr>
 214     <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of minimum value returned here </td></tr>
 215   </table>
 216   </dd>
 217 </dl>
 218 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 219
 220 <p>Definition at line <a class="el" href="arm__min__q15_8c_source.html#l00053">53</a> of file <a class="el" href="arm__min__q15_8c_source.html">arm_min_q15.c</a>.</p>
 221
 222 </div>
 223 </div>
 224 <a class="anchor" id="ga3631d38ac8d715fc14f6f1b343f4c4ed"></a><!-- doxytag: member="arm_min_q7.c::arm_min_q7" ref="ga3631d38ac8d715fc14f6f1b343f4c4ed" args="(q7_t *pSrc, uint32_t blockSize, q7_t *pResult, uint32_t *pIndex)" -->
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname">void arm_min_q7 </td>
 230           <td>(</td>
 231           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 232           <td class="paramname"> <em>pSrc</em>, </td>
 233         </tr>
 234         <tr>
 235           <td class="paramkey"></td>
 236           <td></td>
 237           <td class="paramtype">uint32_t&#160;</td>
 238           <td class="paramname"> <em>blockSize</em>, </td>
 239         </tr>
 240         <tr>
 241           <td class="paramkey"></td>
 242           <td></td>
 243           <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *&#160;</td>
 244           <td class="paramname"> <em>pResult</em>, </td>
 245         </tr>
 246         <tr>
 247           <td class="paramkey"></td>
 248           <td></td>
 249           <td class="paramtype">uint32_t *&#160;</td>
 250           <td class="paramname"> <em>pIndex</em>&#160;</td>
 251         </tr>
 252         <tr>
 253           <td></td>
 254           <td>)</td>
 255           <td></td><td></td>
 256         </tr>
 257       </table>
 258 </div>
 259 <div class="memdoc">
 260
 261 <p>Minimum value of a Q7 vector. </p>
 262 <dl><dt><b>Parameters:</b></dt><dd>
 263   <table class="params">
 264     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr>
 265     <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr>
 266     <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>minimum value returned here </td></tr>
 267     <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of minimum value returned here </td></tr>
 268   </table>
 269   </dd>
 270 </dl>
 271 <dl class="return"><dt><b>Returns:</b></dt><dd>none. </dd></dl>
 272
 273 <p>Definition at line <a class="el" href="arm__min__q7_8c_source.html#l00052">52</a> of file <a class="el" href="arm__min__q7_8c_source.html">arm_min_q7.c</a>.</p>
 274
 275 </div>
 276 </div>
 277 </div>
 278 <!--- window showing the filter options -->
 279 <div id="MSearchSelectWindow"
 280      onmouseover="return searchBox.OnSearchSelectShow()"
 281      onmouseout="return searchBox.OnSearchSelectHide()"
 282      onkeydown="return searchBox.OnSearchSelectKey(event)">
 283 <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>
 284
 285 <!-- iframe showing the search results (closed by default) -->
 286 <div id="MSearchResultsWindow">
 287 <iframe src="" frameborder="0"
 288         name="MSearchResults" id="MSearchResults">
 289 </iframe>
 290 </div>
 291
 292 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:21 for CMSIS DSP Software Library by&#160;
 293 <a href="http://www.doxygen.org/index.html">
 294 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 295 </body>
 296 </html>