group__Sorting.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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>Vector sorting algorithms</title>
  7. <title>CMSIS-DSP: Vector sorting algorithms</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-DSP
  35. &#160;<span id="projectnumber">Version 1.8.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS DSP Software Library</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  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><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('group__Sorting.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Vector sorting algorithms<div class="ingroups"><a class="el" href="group__groupSupport.html">Support Functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  116. Functions</h2></td></tr>
  117. <tr class="memitem:gaaf7f4a37e178f324a43a3b0257217c50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Sorting.html#gaaf7f4a37e178f324a43a3b0257217c50">arm_merge_sort_f32</a> (const <a class="el" href="structarm__merge__sort__instance__f32.html">arm_merge_sort_instance_f32</a> *<a class="el" href="arm__bayes__example__f32_8c.html#ad5af783c9e1eb1514dec0a59dac35eb7">S</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  118. <tr class="separator:gaaf7f4a37e178f324a43a3b0257217c50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ga8132fc5cd4ff0d49a18d8620b7b994ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Sorting.html#ga8132fc5cd4ff0d49a18d8620b7b994ab">arm_merge_sort_init_f32</a> (<a class="el" href="structarm__merge__sort__instance__f32.html">arm_merge_sort_instance_f32</a> *<a class="el" href="arm__bayes__example__f32_8c.html#ad5af783c9e1eb1514dec0a59dac35eb7">S</a>, <a class="el" href="arm__math_8h.html#a171bff70e8bc15590ef1df0457093d78">arm_sort_dir</a> dir, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *buffer)</td></tr>
  120. <tr class="separator:ga8132fc5cd4ff0d49a18d8620b7b994ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ga2297c149f0974e0f5510907725addd4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Sorting.html#ga2297c149f0974e0f5510907725addd4b">arm_sort_f32</a> (const <a class="el" href="structarm__sort__instance__f32.html">arm_sort_instance_f32</a> *<a class="el" href="arm__bayes__example__f32_8c.html#ad5af783c9e1eb1514dec0a59dac35eb7">S</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pDst, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  122. <tr class="memdesc:ga2297c149f0974e0f5510907725addd4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic sorting function. <a href="#ga2297c149f0974e0f5510907725addd4b">More...</a><br/></td></tr>
  123. <tr class="separator:ga2297c149f0974e0f5510907725addd4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:gac268276b8facce924812fe0e57fa4043"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Sorting.html#gac268276b8facce924812fe0e57fa4043">arm_sort_init_f32</a> (<a class="el" href="structarm__sort__instance__f32.html">arm_sort_instance_f32</a> *<a class="el" href="arm__bayes__example__f32_8c.html#ad5af783c9e1eb1514dec0a59dac35eb7">S</a>, <a class="el" href="arm__math_8h.html#a39c7478f2a29c3ac0a8008ca916c811e">arm_sort_alg</a> alg, <a class="el" href="arm__math_8h.html#a171bff70e8bc15590ef1df0457093d78">arm_sort_dir</a> dir)</td></tr>
  125. <tr class="separator:gac268276b8facce924812fe0e57fa4043"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  128. <p>Sort the elements of a vector</p>
  129. <p>There are separate functions for floating-point, Q31, Q15, and Q7 data types. </p>
  130. <h2 class="groupheader">Function Documentation</h2>
  131. <a class="anchor" id="gaaf7f4a37e178f324a43a3b0257217c50"></a>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">void arm_merge_sort_f32 </td>
  137. <td>(</td>
  138. <td class="paramtype">const <a class="el" href="structarm__merge__sort__instance__f32.html">arm_merge_sort_instance_f32</a> *&#160;</td>
  139. <td class="paramname"><em>S</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  145. <td class="paramname"><em>pSrc</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  151. <td class="paramname"><em>pDst</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">uint32_t&#160;</td>
  157. <td class="paramname"><em>blockSize</em>&#160;</td>
  158. </tr>
  159. <tr>
  160. <td></td>
  161. <td>)</td>
  162. <td></td><td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <dl class="params"><dt>Parameters</dt><dd>
  167. <table class="params">
  168. <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the sorting structure. </td></tr>
  169. <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the block of input data. </td></tr>
  170. <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the block of output data </td></tr>
  171. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process.</td></tr>
  172. </table>
  173. </dd>
  174. </dl>
  175. <dl class="section user"><dt>Algorithm</dt><dd>The merge sort algorithm is a comparison algorithm that divide the input array in sublists and merge them to produce longer sorted sublists until there is only one list remaining.</dd></dl>
  176. <dl class="section user"><dt>A work array is always needed. It must be allocated by the user </dt><dd>linked to the instance at initialization time.</dd></dl>
  177. <dl class="section user"><dt>It's an in-place algorithm. In order to obtain an out-of-place</dt><dd>function, a memcpy of the source vector is performed </dd></dl>
  178. </div>
  179. </div>
  180. <a class="anchor" id="ga8132fc5cd4ff0d49a18d8620b7b994ab"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">void arm_merge_sort_init_f32 </td>
  186. <td>(</td>
  187. <td class="paramtype"><a class="el" href="structarm__merge__sort__instance__f32.html">arm_merge_sort_instance_f32</a> *&#160;</td>
  188. <td class="paramname"><em>S</em>, </td>
  189. </tr>
  190. <tr>
  191. <td class="paramkey"></td>
  192. <td></td>
  193. <td class="paramtype"><a class="el" href="arm__math_8h.html#a171bff70e8bc15590ef1df0457093d78">arm_sort_dir</a>&#160;</td>
  194. <td class="paramname"><em>dir</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  200. <td class="paramname"><em>buffer</em>&#160;</td>
  201. </tr>
  202. <tr>
  203. <td></td>
  204. <td>)</td>
  205. <td></td><td></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <dl class="params"><dt>Parameters</dt><dd>
  210. <table class="params">
  211. <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the sorting structure. </td></tr>
  212. <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>Sorting order. </td></tr>
  213. <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Working buffer. </td></tr>
  214. </table>
  215. </dd>
  216. </dl>
  217. </div>
  218. </div>
  219. <a class="anchor" id="ga2297c149f0974e0f5510907725addd4b"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">void arm_sort_f32 </td>
  225. <td>(</td>
  226. <td class="paramtype">const <a class="el" href="structarm__sort__instance__f32.html">arm_sort_instance_f32</a> *&#160;</td>
  227. <td class="paramname"><em>S</em>, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  233. <td class="paramname"><em>pSrc</em>, </td>
  234. </tr>
  235. <tr>
  236. <td class="paramkey"></td>
  237. <td></td>
  238. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  239. <td class="paramname"><em>pDst</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">uint32_t&#160;</td>
  245. <td class="paramname"><em>blockSize</em>&#160;</td>
  246. </tr>
  247. <tr>
  248. <td></td>
  249. <td>)</td>
  250. <td></td><td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <dl class="params"><dt>Parameters</dt><dd>
  255. <table class="params">
  256. <tr><td class="paramdir">[in]</td><td class="paramname">S</td><td>points to an instance of the sorting structure. </td></tr>
  257. <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the block of input data. </td></tr>
  258. <tr><td class="paramdir">[out]</td><td class="paramname">pDst</td><td>points to the block of output data. </td></tr>
  259. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples to process. </td></tr>
  260. </table>
  261. </dd>
  262. </dl>
  263. </div>
  264. </div>
  265. <a class="anchor" id="gac268276b8facce924812fe0e57fa4043"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">void arm_sort_init_f32 </td>
  271. <td>(</td>
  272. <td class="paramtype"><a class="el" href="structarm__sort__instance__f32.html">arm_sort_instance_f32</a> *&#160;</td>
  273. <td class="paramname"><em>S</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype"><a class="el" href="arm__math_8h.html#a39c7478f2a29c3ac0a8008ca916c811e">arm_sort_alg</a>&#160;</td>
  279. <td class="paramname"><em>alg</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype"><a class="el" href="arm__math_8h.html#a171bff70e8bc15590ef1df0457093d78">arm_sort_dir</a>&#160;</td>
  285. <td class="paramname"><em>dir</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <dl class="params"><dt>Parameters</dt><dd>
  295. <table class="params">
  296. <tr><td class="paramdir">[in,out]</td><td class="paramname">S</td><td>points to an instance of the sorting structure. </td></tr>
  297. <tr><td class="paramdir">[in]</td><td class="paramname">alg</td><td>Selected algorithm. </td></tr>
  298. <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>Sorting order. </td></tr>
  299. </table>
  300. </dd>
  301. </dl>
  302. </div>
  303. </div>
  304. </div><!-- contents -->
  305. </div><!-- doc-content -->
  306. <!-- start footer part -->
  307. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  308. <ul>
  309. <li class="footer">Generated on Thu Apr 9 2020 15:49:23 for CMSIS-DSP Version 1.8.0 by Arm Ltd. All rights reserved.
  310. <!--
  311. <a href="http://www.doxygen.org/index.html">
  312. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  313. -->
  314. </li>
  315. </ul>
  316. </div>
  317. </body>
  318. </html>