Почетна Преглед Помоћ
Пријавите се
ARM-software
/
CMSIS_5
огледало од https://github-proxy.rt-thread.io/ARM-software/CMSIS_5.git
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: 5.7.0
Гране Ознаке
CMSIS_5
/
docs
/
DSP
/
html
/
group__SQRT.html

group__SQRT.html 20 KB
Пермалинк Историја Датотека

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Square Root</title>
    7. 

  7. <title>CMSIS-DSP: Square Root</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="printComponentTabs.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="resize.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript">
    17. 

  17.   $(document).ready(initResizable);
    18. 

  18.   $(window).load(resizeHeight);
    19. 

  19. </script>
    20. 

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    21. 

  21. <script type="text/javascript" src="search/search.js"></script>
    22. 

  22. <script type="text/javascript">
    23. 

  23.   $(document).ready(function() { searchBox.OnSelectItem(0); });
    24. 

  24. </script>
    25. 

  25. </head>
    26. 

  26. <body>
    27. 

  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    28. 

  28. <div id="titlearea">
    29. 

  29. <table cellspacing="0" cellpadding="0">
    30. 

  30.  <tbody>
    31. 

  31.  <tr style="height: 46px;">
    32. 

  32.   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
    33. 

  33.   <td style="padding-left: 0.5em;">
    34. 

  34.    <div id="projectname">CMSIS-DSP
    35. 

  35.    &#160;<span id="projectnumber">Version 1.8.0</span>
    36. 

  36.    </div>
    37. 

  37.    <div id="projectbrief">CMSIS DSP Software Library</div>
    38. 

  38.   </td>
    39. 

  39.  </tr>
    40. 

  40.  </tbody>
    41. 

  41. </table>
    42. 

  42. </div>
    43. 

  43. <!-- end header part -->
    44. 

  44. <div id="CMSISnav" class="tabs1">
    45. 

  45.     <ul class="tablist">
    46. 

  46.       <script type="text/javascript">
    47. 

  47. 		<!--
    48. 

  48. 		writeComponentTabs.call(this);
    49. 

  49. 		//-->
    50. 

  50.       </script>
    51. 

  51. 	  </ul>
    52. 

  52. </div>
    53. 

  53. <!-- Generated by Doxygen 1.8.6 -->
    54. 

  54. <script type="text/javascript">
    55. 

  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    56. 

  56. </script>
    57. 

  57.   <div id="navrow1" class="tabs">
    58. 

  58.     <ul class="tablist">
    59. 

  59.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    60. 

  60.       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
    61. 

  61.       <li><a href="modules.html"><span>Reference</span></a></li>
    62. 

  62.       <li>
    63. 

  63.         <div id="MSearchBox" class="MSearchBoxInactive">
    64. 

  64.         <span class="left">
    65. 

  65.           <img id="MSearchSelect" src="search/mag_sel.png"
    66. 

  66.                onmouseover="return searchBox.OnSearchSelectShow()"
    67. 

  67.                onmouseout="return searchBox.OnSearchSelectHide()"
    68. 

  68.                alt=""/>
    69. 

  69.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    70. 

  70.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    71. 

  71.                onblur="searchBox.OnSearchFieldFocus(false)" 
    72. 

  72.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    73. 

  73.           </span><span class="right">
    74. 

  74.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    75. 

  75.           </span>
    76. 

  76.         </div>
    77. 

  77.       </li>
    78. 

  78.     </ul>
    79. 

  79.   </div>
    80. 

  80. </div><!-- top -->
    81. 

  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
    82. 

  82.   <div id="nav-tree">
    83. 

  83.     <div id="nav-tree-contents">
    84. 

  84.       <div id="nav-sync" class="sync"></div>
    85. 

  85.     </div>
    86. 

  86.   </div>
    87. 

  87.   <div id="splitbar" style="-moz-user-select:none;" 
    88. 

  88.        class="ui-resizable-handle">
    89. 

  89.   </div>
    90. 

  90. </div>
    91. 

  91. <script type="text/javascript">
    92. 

  92. $(document).ready(function(){initNavTree('group__SQRT.html','');});
    93. 

  93. </script>
    94. 

  94. <div id="doc-content">
    95. 

  95. <!-- window showing the filter options -->
    96. 

  96. <div id="MSearchSelectWindow"
    97. 

  97.      onmouseover="return searchBox.OnSearchSelectShow()"
    98. 

  98.      onmouseout="return searchBox.OnSearchSelectHide()"
    99. 

  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    100. 

  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. 

  101. 

  102. <!-- iframe showing the search results (closed by default) -->
    103. 

  103. <div id="MSearchResultsWindow">
    104. 

  104. <iframe src="javascript:void(0)" frameborder="0" 
    105. 

  105.         name="MSearchResults" id="MSearchResults">
    106. 

  106. </iframe>
    107. 

  107. </div>
    108. 

  108. 

  109. <div class="header">
    110. 

  110.   <div class="summary">
    111. 

  111. <a href="#func-members">Functions</a>  </div>
    112. 

  112.   <div class="headertitle">
    113. 

  113. <div class="title">Square Root<div class="ingroups"><a class="el" href="group__groupFastMath.html">Fast Math Functions</a></div></div>  </div>
    114. 

  114. </div><!--header-->
    115. 

  115. <div class="contents">
    116. 

  116. <table class="memberdecls">
    117. 

  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    118. 

  118. Functions</h2></td></tr>
    119. 

  119. <tr class="memitem:ga5f37f479666ee8ff9711b334286c60ed"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SQRT.html#ga5f37f479666ee8ff9711b334286c60ed">arm_sqrt_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> in, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pOut)</td></tr>
    120. 

  120. <tr class="memdesc:ga5f37f479666ee8ff9711b334286c60ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point square root function.  <a href="#ga5f37f479666ee8ff9711b334286c60ed">More...</a><br/></td></tr>
    121. 

  121. <tr class="separator:ga5f37f479666ee8ff9711b334286c60ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
    122. 

  122. <tr class="memitem:ga119e25831e141d734d7ef10636670058"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SQRT.html#ga119e25831e141d734d7ef10636670058">arm_sqrt_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> in, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut)</td></tr>
    123. 

  123. <tr class="memdesc:ga119e25831e141d734d7ef10636670058"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q31 square root function.  <a href="#ga119e25831e141d734d7ef10636670058">More...</a><br/></td></tr>
    124. 

  124. <tr class="separator:ga119e25831e141d734d7ef10636670058"><td class="memSeparator" colspan="2">&#160;</td></tr>
    125. 

  125. <tr class="memitem:ga5abe5ca724f3e15849662b03752c1238"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SQRT.html#ga5abe5ca724f3e15849662b03752c1238">arm_sqrt_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> in, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut)</td></tr>
    126. 

  126. <tr class="memdesc:ga5abe5ca724f3e15849662b03752c1238"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q15 square root function.  <a href="#ga5abe5ca724f3e15849662b03752c1238">More...</a><br/></td></tr>
    127. 

  127. <tr class="separator:ga5abe5ca724f3e15849662b03752c1238"><td class="memSeparator" colspan="2">&#160;</td></tr>
    128. 

  128. <tr class="memitem:gaa9b8a2bea8a22489bfd968eb4687a7bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SQRT.html#gaa9b8a2bea8a22489bfd968eb4687a7bd">arm_vsqrt_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIn, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pOut, uint16_t len)</td></tr>
    129. 

  129. <tr class="memdesc:gaa9b8a2bea8a22489bfd968eb4687a7bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector Floating-point square root function.  <a href="#gaa9b8a2bea8a22489bfd968eb4687a7bd">More...</a><br/></td></tr>
    130. 

  130. <tr class="separator:gaa9b8a2bea8a22489bfd968eb4687a7bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    131. 

  131. <tr class="memitem:ga5955b76f2a60c1636ff507182000193d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SQRT.html#ga5955b76f2a60c1636ff507182000193d">arm_vsqrt_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIn, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pOut, uint16_t len)</td></tr>
    132. 

  132. <tr class="separator:ga5955b76f2a60c1636ff507182000193d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    133. 

  133. <tr class="memitem:ga793f913a2b3a8f45577db36136954cdc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__SQRT.html#ga793f913a2b3a8f45577db36136954cdc">arm_vsqrt_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pIn, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pOut, uint16_t len)</td></tr>
    134. 

  134. <tr class="separator:ga793f913a2b3a8f45577db36136954cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    135. 

  135. </table>
    136. 

  136. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
    137. 

  137. <p>Computes the square root of a number. There are separate functions for Q15, Q31, and floating-point data types. The square root function is computed using the Newton-Raphson algorithm. This is an iterative algorithm of the form: </p>
    138. 

  138. <pre>
    139. 

  139.      x1 = x0 - f(x0)/f'(x0)
    140. 

  140. </pre><p> where <code>x1</code> is the current estimate, <code>x0</code> is the previous estimate, and <code>f'(x0)</code> is the derivative of <code>f()</code> evaluated at <code>x0</code>. For the square root function, the algorithm reduces to: </p>
    141. 

  141. <pre>
    142. 

  142.     x0 = in/2                         [initial guess]
    143. 

  143.     x1 = 1/2 * ( x0 + in / x0)        [each iteration]
    144. 

  144. </pre> <h2 class="groupheader">Function Documentation</h2>
    145. 

  145. <a class="anchor" id="ga5f37f479666ee8ff9711b334286c60ed"></a>
    146. 

  146. <div class="memitem">
    147. 

  147. <div class="memproto">
    148. 

  148.       <table class="memname">
    149. 

  149.         <tr>
    150. 

  150.           <td class="memname">__STATIC_FORCEINLINE <a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_sqrt_f32 </td>
    151. 

  151.           <td>(</td>
    152. 

  152.           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
    153. 

  153.           <td class="paramname"><em>in</em>, </td>
    154. 

  154.         </tr>
    155. 

  155.         <tr>
    156. 

  156.           <td class="paramkey"></td>
    157. 

  157.           <td></td>
    158. 

  158.           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
    159. 

  159.           <td class="paramname"><em>pOut</em>&#160;</td>
    160. 

  160.         </tr>
    161. 

  161.         <tr>
    162. 

  162.           <td></td>
    163. 

  163.           <td>)</td>
    164. 

  164.           <td></td><td></td>
    165. 

  165.         </tr>
    166. 

  166.       </table>
    167. 

  167. </div><div class="memdoc">
    168. 

  168. <dl class="params"><dt>Parameters</dt><dd>
    169. 

  169.   <table class="params">
    170. 

  170.     <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>input value </td></tr>
    171. 

  171.     <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>square root of input value </td></tr>
    172. 

  172.   </table>
    173. 

  173.   </dd>
    174. 

  174. </dl>
    175. 

  175. <dl class="section return"><dt>Returns</dt><dd>execution status<ul>
    176. 

  176. <li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : input value is positive</li>
    177. 

  177. <li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : input value is negative; *pOut is set to 0 </li>
    178. 

  178. </ul>
    179. 

  179. </dd></dl>
    180. 

  180. 

  181. </div>
    182. 

  182. </div>
    183. 

  183. <a class="anchor" id="ga5abe5ca724f3e15849662b03752c1238"></a>
    184. 

  184. <div class="memitem">
    185. 

  185. <div class="memproto">
    186. 

  186.       <table class="memname">
    187. 

  187.         <tr>
    188. 

  188.           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_sqrt_q15 </td>
    189. 

  189.           <td>(</td>
    190. 

  190.           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td>
    191. 

  191.           <td class="paramname"><em>in</em>, </td>
    192. 

  192.         </tr>
    193. 

  193.         <tr>
    194. 

  194.           <td class="paramkey"></td>
    195. 

  195.           <td></td>
    196. 

  196.           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
    197. 

  197.           <td class="paramname"><em>pOut</em>&#160;</td>
    198. 

  198.         </tr>
    199. 

  199.         <tr>
    200. 

  200.           <td></td>
    201. 

  201.           <td>)</td>
    202. 

  202.           <td></td><td></td>
    203. 

  203.         </tr>
    204. 

  204.       </table>
    205. 

  205. </div><div class="memdoc">
    206. 

  206. <dl class="params"><dt>Parameters</dt><dd>
    207. 

  207.   <table class="params">
    208. 

  208.     <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>input value. The range of the input value is [0 +1) or 0x0000 to 0x7FFF </td></tr>
    209. 

  209.     <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>points to square root of input value </td></tr>
    210. 

  210.   </table>
    211. 

  211.   </dd>
    212. 

  212. </dl>
    213. 

  213. <dl class="section return"><dt>Returns</dt><dd>execution status<ul>
    214. 

  214. <li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : input value is positive</li>
    215. 

  215. <li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : input value is negative; *pOut is set to 0 </li>
    216. 

  216. </ul>
    217. 

  217. </dd></dl>
    218. 

  218. 

  219. </div>
    220. 

  220. </div>
    221. 

  221. <a class="anchor" id="ga119e25831e141d734d7ef10636670058"></a>
    222. 

  222. <div class="memitem">
    223. 

  223. <div class="memproto">
    224. 

  224.       <table class="memname">
    225. 

  225.         <tr>
    226. 

  226.           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_sqrt_q31 </td>
    227. 

  227.           <td>(</td>
    228. 

  228.           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
    229. 

  229.           <td class="paramname"><em>in</em>, </td>
    230. 

  230.         </tr>
    231. 

  231.         <tr>
    232. 

  232.           <td class="paramkey"></td>
    233. 

  233.           <td></td>
    234. 

  234.           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
    235. 

  235.           <td class="paramname"><em>pOut</em>&#160;</td>
    236. 

  236.         </tr>
    237. 

  237.         <tr>
    238. 

  238.           <td></td>
    239. 

  239.           <td>)</td>
    240. 

  240.           <td></td><td></td>
    241. 

  241.         </tr>
    242. 

  242.       </table>
    243. 

  243. </div><div class="memdoc">
    244. 

  244. <dl class="params"><dt>Parameters</dt><dd>
    245. 

  245.   <table class="params">
    246. 

  246.     <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>input value. The range of the input value is [0 +1) or 0x00000000 to 0x7FFFFFFF </td></tr>
    247. 

  247.     <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>points to square root of input value </td></tr>
    248. 

  248.   </table>
    249. 

  249.   </dd>
    250. 

  250. </dl>
    251. 

  251. <dl class="section return"><dt>Returns</dt><dd>execution status<ul>
    252. 

  252. <li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a> : input value is positive</li>
    253. 

  253. <li><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a74897e18d4b8f62b12a7d8a01dd2bb35">ARM_MATH_ARGUMENT_ERROR</a> : input value is negative; *pOut is set to 0 </li>
    254. 

  254. </ul>
    255. 

  255. </dd></dl>
    256. 

  256. 

  257. </div>
    258. 

  258. </div>
    259. 

  259. <a class="anchor" id="gaa9b8a2bea8a22489bfd968eb4687a7bd"></a>
    260. 

  260. <div class="memitem">
    261. 

  261. <div class="memproto">
    262. 

  262.       <table class="memname">
    263. 

  263.         <tr>
    264. 

  264.           <td class="memname">void arm_vsqrt_f32 </td>
    265. 

  265.           <td>(</td>
    266. 

  266.           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
    267. 

  267.           <td class="paramname"><em>pIn</em>, </td>
    268. 

  268.         </tr>
    269. 

  269.         <tr>
    270. 

  270.           <td class="paramkey"></td>
    271. 

  271.           <td></td>
    272. 

  272.           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *&#160;</td>
    273. 

  273.           <td class="paramname"><em>pOut</em>, </td>
    274. 

  274.         </tr>
    275. 

  275.         <tr>
    276. 

  276.           <td class="paramkey"></td>
    277. 

  277.           <td></td>
    278. 

  278.           <td class="paramtype">uint16_t&#160;</td>
    279. 

  279.           <td class="paramname"><em>len</em>&#160;</td>
    280. 

  280.         </tr>
    281. 

  281.         <tr>
    282. 

  282.           <td></td>
    283. 

  283.           <td>)</td>
    284. 

  284.           <td></td><td></td>
    285. 

  285.         </tr>
    286. 

  286.       </table>
    287. 

  287. </div><div class="memdoc">
    288. 

  288. <dl class="params"><dt>Parameters</dt><dd>
    289. 

  289.   <table class="params">
    290. 

  290.     <tr><td class="paramdir">[in]</td><td class="paramname">pIn</td><td>input vector. </td></tr>
    291. 

  291.     <tr><td class="paramdir">[out]</td><td class="paramname">pOut</td><td>vector of square roots of input elements. </td></tr>
    292. 

  292.     <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of input vector. </td></tr>
    293. 

  293.   </table>
    294. 

  294.   </dd>
    295. 

  295. </dl>
    296. 

  296. <dl class="section return"><dt>Returns</dt><dd>The function returns ARM_MATH_SUCCESS if input value is positive value or ARM_MATH_ARGUMENT_ERROR if <code>in</code> is negative value and returns zero output for negative values. </dd></dl>
    297. 

  297. 

  298. </div>
    299. 

  299. </div>
    300. 

  300. <a class="anchor" id="ga793f913a2b3a8f45577db36136954cdc"></a>
    301. 

  301. <div class="memitem">
    302. 

  302. <div class="memproto">
    303. 

  303.       <table class="memname">
    304. 

  304.         <tr>
    305. 

  305.           <td class="memname">void arm_vsqrt_q15 </td>
    306. 

  306.           <td>(</td>
    307. 

  307.           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
    308. 

  308.           <td class="paramname"><em>pIn</em>, </td>
    309. 

  309.         </tr>
    310. 

  310.         <tr>
    311. 

  311.           <td class="paramkey"></td>
    312. 

  312.           <td></td>
    313. 

  313.           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *&#160;</td>
    314. 

  314.           <td class="paramname"><em>pOut</em>, </td>
    315. 

  315.         </tr>
    316. 

  316.         <tr>
    317. 

  317.           <td class="paramkey"></td>
    318. 

  318.           <td></td>
    319. 

  319.           <td class="paramtype">uint16_t&#160;</td>
    320. 

  320.           <td class="paramname"><em>len</em>&#160;</td>
    321. 

  321.         </tr>
    322. 

  322.         <tr>
    323. 

  323.           <td></td>
    324. 

  324.           <td>)</td>
    325. 

  325.           <td></td><td></td>
    326. 

  326.         </tr>
    327. 

  327.       </table>
    328. 

  328. </div><div class="memdoc">
    329. 

  329. 

  330. </div>
    331. 

  331. </div>
    332. 

  332. <a class="anchor" id="ga5955b76f2a60c1636ff507182000193d"></a>
    333. 

  333. <div class="memitem">
    334. 

  334. <div class="memproto">
    335. 

  335.       <table class="memname">
    336. 

  336.         <tr>
    337. 

  337.           <td class="memname">void arm_vsqrt_q31 </td>
    338. 

  338.           <td>(</td>
    339. 

  339.           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
    340. 

  340.           <td class="paramname"><em>pIn</em>, </td>
    341. 

  341.         </tr>
    342. 

  342.         <tr>
    343. 

  343.           <td class="paramkey"></td>
    344. 

  344.           <td></td>
    345. 

  345.           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *&#160;</td>
    346. 

  346.           <td class="paramname"><em>pOut</em>, </td>
    347. 

  347.         </tr>
    348. 

  348.         <tr>
    349. 

  349.           <td class="paramkey"></td>
    350. 

  350.           <td></td>
    351. 

  351.           <td class="paramtype">uint16_t&#160;</td>
    352. 

  352.           <td class="paramname"><em>len</em>&#160;</td>
    353. 

  353.         </tr>
    354. 

  354.         <tr>
    355. 

  355.           <td></td>
    356. 

  356.           <td>)</td>
    357. 

  357.           <td></td><td></td>
    358. 

  358.         </tr>
    359. 

  359.       </table>
    360. 

  360. </div><div class="memdoc">
    361. 

  361. 

  362. </div>
    363. 

  363. </div>
    364. 

  364. </div><!-- contents -->
    365. 

  365. </div><!-- doc-content -->
    366. 

  366. <!-- start footer part -->
    367. 

  367. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    368. 

  368.   <ul>
    369. 

  369.     <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.
    370. 

  370. 	<!--
    371. 

  371.     <a href="http://www.doxygen.org/index.html">
    372. 

  372.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
    373. 

  373. 	-->
    374. 

  374. 	</li>
    375. 

  375.   </ul>
    376. 

  376. </div>
    377. 

  377. </body>
    378. 

  378. </html>
    379.