group__FloatDist.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572
  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>Float Distances</title>
  7. <title>CMSIS-DSP: Float Distances</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__FloatDist.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">Float Distances<div class="ingroups"><a class="el" href="group__groupDistance.html">Distance 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:ga4cb969f4c0c64a9afda98b2ed13e95fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga4cb969f4c0c64a9afda98b2ed13e95fa">arm_canberra_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  118. <tr class="memdesc:ga4cb969f4c0c64a9afda98b2ed13e95fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Canberra distance between two vectors. <a href="#ga4cb969f4c0c64a9afda98b2ed13e95fa">More...</a><br/></td></tr>
  119. <tr class="separator:ga4cb969f4c0c64a9afda98b2ed13e95fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gaeac7e25faa01178ba6de05be8e1a31e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#gaeac7e25faa01178ba6de05be8e1a31e9">arm_chebyshev_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  121. <tr class="memdesc:gaeac7e25faa01178ba6de05be8e1a31e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chebyshev distance between two vectors. <a href="#gaeac7e25faa01178ba6de05be8e1a31e9">More...</a><br/></td></tr>
  122. <tr class="separator:gaeac7e25faa01178ba6de05be8e1a31e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga0a7194c6d56ce679a6ba1d5ebc814d5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga0a7194c6d56ce679a6ba1d5ebc814d5c">arm_cityblock_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  124. <tr class="memdesc:ga0a7194c6d56ce679a6ba1d5ebc814d5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cityblock (Manhattan) distance between two vectors. <a href="#ga0a7194c6d56ce679a6ba1d5ebc814d5c">More...</a><br/></td></tr>
  125. <tr class="separator:ga0a7194c6d56ce679a6ba1d5ebc814d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:gaf51cef11ade667912bb004cb24dc4e39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#gaf51cef11ade667912bb004cb24dc4e39">arm_correlation_distance_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  127. <tr class="memdesc:gaf51cef11ade667912bb004cb24dc4e39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Correlation distance between two vectors. <a href="#gaf51cef11ade667912bb004cb24dc4e39">More...</a><br/></td></tr>
  128. <tr class="separator:gaf51cef11ade667912bb004cb24dc4e39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ga376f5fccfe6ddba6ed7121bc1cec7f70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga376f5fccfe6ddba6ed7121bc1cec7f70">arm_cosine_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  130. <tr class="memdesc:ga376f5fccfe6ddba6ed7121bc1cec7f70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cosine distance between two vectors. <a href="#ga376f5fccfe6ddba6ed7121bc1cec7f70">More...</a><br/></td></tr>
  131. <tr class="separator:ga376f5fccfe6ddba6ed7121bc1cec7f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ga838f0a157454dfd95996691309c3828e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga838f0a157454dfd95996691309c3828e">arm_euclidean_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  133. <tr class="memdesc:ga838f0a157454dfd95996691309c3828e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Euclidean distance between two vectors. <a href="#ga838f0a157454dfd95996691309c3828e">More...</a><br/></td></tr>
  134. <tr class="separator:ga838f0a157454dfd95996691309c3828e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ga9fa028dcb0439f9b00522a514a39f478"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga9fa028dcb0439f9b00522a514a39f478">rel_entr</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> x, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> y)</td></tr>
  136. <tr class="separator:ga9fa028dcb0439f9b00522a514a39f478"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ga6965b12ce3ee265d3759dfec38b77524"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga6965b12ce3ee265d3759dfec38b77524">arm_jensenshannon_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  138. <tr class="memdesc:ga6965b12ce3ee265d3759dfec38b77524"><td class="mdescLeft">&#160;</td><td class="mdescRight">Jensen-Shannon distance between two vectors. <a href="#ga6965b12ce3ee265d3759dfec38b77524">More...</a><br/></td></tr>
  139. <tr class="separator:ga6965b12ce3ee265d3759dfec38b77524"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:gadee2e217acf8a2e28f6cc0d1668e4902"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#gadee2e217acf8a2e28f6cc0d1668e4902">arm_minkowski_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, int32_t order, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  141. <tr class="memdesc:gadee2e217acf8a2e28f6cc0d1668e4902"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minkowski distance between two vectors. <a href="#gadee2e217acf8a2e28f6cc0d1668e4902">More...</a><br/></td></tr>
  142. <tr class="separator:gadee2e217acf8a2e28f6cc0d1668e4902"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ga6e3bec4b346efa100c4f2ca26ed7a142"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FloatDist.html#ga6e3bec4b346efa100c4f2ca26ed7a142">arm_braycurtis_distance_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pA, const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pB, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)</td></tr>
  144. <tr class="memdesc:ga6e3bec4b346efa100c4f2ca26ed7a142"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bray-Curtis distance between two vectors. <a href="#ga6e3bec4b346efa100c4f2ca26ed7a142">More...</a><br/></td></tr>
  145. <tr class="separator:ga6e3bec4b346efa100c4f2ca26ed7a142"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  148. <p>Distances between two vectors of float values. </p>
  149. <h2 class="groupheader">Function Documentation</h2>
  150. <a class="anchor" id="ga6e3bec4b346efa100c4f2ca26ed7a142"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_braycurtis_distance_f32 </td>
  156. <td>(</td>
  157. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  158. <td class="paramname"><em>pA</em>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  164. <td class="paramname"><em>pB</em>, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype">uint32_t&#160;</td>
  170. <td class="paramname"><em>blockSize</em>&#160;</td>
  171. </tr>
  172. <tr>
  173. <td></td>
  174. <td>)</td>
  175. <td></td><td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <dl class="params"><dt>Parameters</dt><dd>
  180. <table class="params">
  181. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  182. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  183. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  184. </table>
  185. </dd>
  186. </dl>
  187. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  188. </div>
  189. </div>
  190. <a class="anchor" id="ga4cb969f4c0c64a9afda98b2ed13e95fa"></a>
  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#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_canberra_distance_f32 </td>
  196. <td>(</td>
  197. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  198. <td class="paramname"><em>pA</em>, </td>
  199. </tr>
  200. <tr>
  201. <td class="paramkey"></td>
  202. <td></td>
  203. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  204. <td class="paramname"><em>pB</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">uint32_t&#160;</td>
  210. <td class="paramname"><em>blockSize</em>&#160;</td>
  211. </tr>
  212. <tr>
  213. <td></td>
  214. <td>)</td>
  215. <td></td><td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>This function may divide by zero when samples pA[i] and pB[i] are both zero. The result of the computation will be correct. So the division per zero may be ignored.</p>
  220. <dl class="params"><dt>Parameters</dt><dd>
  221. <table class="params">
  222. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  223. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  224. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  229. </div>
  230. </div>
  231. <a class="anchor" id="gaeac7e25faa01178ba6de05be8e1a31e9"></a>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_chebyshev_distance_f32 </td>
  237. <td>(</td>
  238. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  239. <td class="paramname"><em>pA</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  245. <td class="paramname"><em>pB</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">uint32_t&#160;</td>
  251. <td class="paramname"><em>blockSize</em>&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td></td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <dl class="params"><dt>Parameters</dt><dd>
  261. <table class="params">
  262. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  263. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  264. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  265. </table>
  266. </dd>
  267. </dl>
  268. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  269. </div>
  270. </div>
  271. <a class="anchor" id="ga0a7194c6d56ce679a6ba1d5ebc814d5c"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_cityblock_distance_f32 </td>
  277. <td>(</td>
  278. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  279. <td class="paramname"><em>pA</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  285. <td class="paramname"><em>pB</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">uint32_t&#160;</td>
  291. <td class="paramname"><em>blockSize</em>&#160;</td>
  292. </tr>
  293. <tr>
  294. <td></td>
  295. <td>)</td>
  296. <td></td><td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <dl class="params"><dt>Parameters</dt><dd>
  301. <table class="params">
  302. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  303. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  304. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  305. </table>
  306. </dd>
  307. </dl>
  308. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  309. </div>
  310. </div>
  311. <a class="anchor" id="gaf51cef11ade667912bb004cb24dc4e39"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_correlation_distance_f32 </td>
  317. <td>(</td>
  318. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  319. <td class="paramname"><em>pA</em>, </td>
  320. </tr>
  321. <tr>
  322. <td class="paramkey"></td>
  323. <td></td>
  324. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  325. <td class="paramname"><em>pB</em>, </td>
  326. </tr>
  327. <tr>
  328. <td class="paramkey"></td>
  329. <td></td>
  330. <td class="paramtype">uint32_t&#160;</td>
  331. <td class="paramname"><em>blockSize</em>&#160;</td>
  332. </tr>
  333. <tr>
  334. <td></td>
  335. <td>)</td>
  336. <td></td><td></td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>The input vectors are modified in place !</p>
  341. <dl class="params"><dt>Parameters</dt><dd>
  342. <table class="params">
  343. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  344. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  345. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  346. </table>
  347. </dd>
  348. </dl>
  349. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  350. </div>
  351. </div>
  352. <a class="anchor" id="ga376f5fccfe6ddba6ed7121bc1cec7f70"></a>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_cosine_distance_f32 </td>
  358. <td>(</td>
  359. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  360. <td class="paramname"><em>pA</em>, </td>
  361. </tr>
  362. <tr>
  363. <td class="paramkey"></td>
  364. <td></td>
  365. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  366. <td class="paramname"><em>pB</em>, </td>
  367. </tr>
  368. <tr>
  369. <td class="paramkey"></td>
  370. <td></td>
  371. <td class="paramtype">uint32_t&#160;</td>
  372. <td class="paramname"><em>blockSize</em>&#160;</td>
  373. </tr>
  374. <tr>
  375. <td></td>
  376. <td>)</td>
  377. <td></td><td></td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <dl class="params"><dt>Parameters</dt><dd>
  382. <table class="params">
  383. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  384. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  385. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  386. </table>
  387. </dd>
  388. </dl>
  389. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  390. </div>
  391. </div>
  392. <a class="anchor" id="ga838f0a157454dfd95996691309c3828e"></a>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_euclidean_distance_f32 </td>
  398. <td>(</td>
  399. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  400. <td class="paramname"><em>pA</em>, </td>
  401. </tr>
  402. <tr>
  403. <td class="paramkey"></td>
  404. <td></td>
  405. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  406. <td class="paramname"><em>pB</em>, </td>
  407. </tr>
  408. <tr>
  409. <td class="paramkey"></td>
  410. <td></td>
  411. <td class="paramtype">uint32_t&#160;</td>
  412. <td class="paramname"><em>blockSize</em>&#160;</td>
  413. </tr>
  414. <tr>
  415. <td></td>
  416. <td>)</td>
  417. <td></td><td></td>
  418. </tr>
  419. </table>
  420. </div><div class="memdoc">
  421. <dl class="params"><dt>Parameters</dt><dd>
  422. <table class="params">
  423. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  424. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  425. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  426. </table>
  427. </dd>
  428. </dl>
  429. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  430. </div>
  431. </div>
  432. <a class="anchor" id="ga6965b12ce3ee265d3759dfec38b77524"></a>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="memname">
  436. <tr>
  437. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_jensenshannon_distance_f32 </td>
  438. <td>(</td>
  439. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  440. <td class="paramname"><em>pA</em>, </td>
  441. </tr>
  442. <tr>
  443. <td class="paramkey"></td>
  444. <td></td>
  445. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  446. <td class="paramname"><em>pB</em>, </td>
  447. </tr>
  448. <tr>
  449. <td class="paramkey"></td>
  450. <td></td>
  451. <td class="paramtype">uint32_t&#160;</td>
  452. <td class="paramname"><em>blockSize</em>&#160;</td>
  453. </tr>
  454. <tr>
  455. <td></td>
  456. <td>)</td>
  457. <td></td><td></td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>This function is assuming that elements of second vector are &gt; 0 and 0 only when the corresponding element of first vector is 0. Otherwise the result of the computation does not make sense and for speed reasons, the cases returning NaN or Infinity are not managed.</p>
  462. <p>When the function is computing x log (x / y) with x == 0 and y == 0, it will compute the right result (0) but a division by zero will occur and should be ignored in client code.</p>
  463. <dl class="params"><dt>Parameters</dt><dd>
  464. <table class="params">
  465. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  466. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  467. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>vector length </td></tr>
  468. </table>
  469. </dd>
  470. </dl>
  471. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  472. </div>
  473. </div>
  474. <a class="anchor" id="gadee2e217acf8a2e28f6cc0d1668e4902"></a>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_minkowski_distance_f32 </td>
  480. <td>(</td>
  481. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  482. <td class="paramname"><em>pA</em>, </td>
  483. </tr>
  484. <tr>
  485. <td class="paramkey"></td>
  486. <td></td>
  487. <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
  488. <td class="paramname"><em>pB</em>, </td>
  489. </tr>
  490. <tr>
  491. <td class="paramkey"></td>
  492. <td></td>
  493. <td class="paramtype">int32_t&#160;</td>
  494. <td class="paramname"><em>order</em>, </td>
  495. </tr>
  496. <tr>
  497. <td class="paramkey"></td>
  498. <td></td>
  499. <td class="paramtype">uint32_t&#160;</td>
  500. <td class="paramname"><em>blockSize</em>&#160;</td>
  501. </tr>
  502. <tr>
  503. <td></td>
  504. <td>)</td>
  505. <td></td><td></td>
  506. </tr>
  507. </table>
  508. </div><div class="memdoc">
  509. <dl class="params"><dt>Parameters</dt><dd>
  510. <table class="params">
  511. <tr><td class="paramdir">[in]</td><td class="paramname">pA</td><td>First vector </td></tr>
  512. <tr><td class="paramdir">[in]</td><td class="paramname">pB</td><td>Second vector </td></tr>
  513. <tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Distance order </td></tr>
  514. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>Number of samples </td></tr>
  515. </table>
  516. </dd>
  517. </dl>
  518. <dl class="section return"><dt>Returns</dt><dd>distance </dd></dl>
  519. </div>
  520. </div>
  521. <a class="anchor" id="ga9fa028dcb0439f9b00522a514a39f478"></a>
  522. <div class="memitem">
  523. <div class="memproto">
  524. <table class="memname">
  525. <tr>
  526. <td class="memname">__STATIC_INLINE <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> rel_entr </td>
  527. <td>(</td>
  528. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  529. <td class="paramname"><em>x</em>, </td>
  530. </tr>
  531. <tr>
  532. <td class="paramkey"></td>
  533. <td></td>
  534. <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  535. <td class="paramname"><em>y</em>&#160;</td>
  536. </tr>
  537. <tr>
  538. <td></td>
  539. <td>)</td>
  540. <td></td><td></td>
  541. </tr>
  542. </table>
  543. </div><div class="memdoc">
  544. </div>
  545. </div>
  546. </div><!-- contents -->
  547. </div><!-- doc-content -->
  548. <!-- start footer part -->
  549. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  550. <ul>
  551. <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.
  552. <!--
  553. <a href="http://www.doxygen.org/index.html">
  554. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  555. -->
  556. </li>
  557. </ul>
  558. </div>
  559. </body>
  560. </html>