group__NNBasicMath.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970
  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>Basic Math Functions for Neural Network Computation</title>
  7. <title>CMSIS-NN: Basic Math Functions for Neural Network Computation</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-NN
  35. &#160;<span id="projectnumber">Version 1.3.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS NN 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__NNBasicMath.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>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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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">Basic Math Functions for Neural Network Computation</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:ga379c39e614f1468e1fdb524f51fb6061"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#ga379c39e614f1468e1fdb524f51fb6061">arm_nn_accumulate_q7_to_q15</a> (q15_t *pDst, const q7_t *pSrc, uint32_t length)</td></tr>
  118. <tr class="memdesc:ga379c39e614f1468e1fdb524f51fb6061"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements from a q7 vector and accumulate to a q15 vector. <a href="#ga379c39e614f1468e1fdb524f51fb6061">More...</a><br/></td></tr>
  119. <tr class="separator:ga379c39e614f1468e1fdb524f51fb6061"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gae65bde3218210820d789659179e14ce3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#gae65bde3218210820d789659179e14ce3">arm_nn_add_q7</a> (const q7_t *input, q31_t *output, uint32_t block_size)</td></tr>
  121. <tr class="memdesc:gae65bde3218210820d789659179e14ce3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-saturating addition of elements of a q7 vector. <a href="#gae65bde3218210820d789659179e14ce3">More...</a><br/></td></tr>
  122. <tr class="separator:gae65bde3218210820d789659179e14ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:gaf7e914e84c2fa6bcf9b0727b8c46c250"><td class="memItemLeft" align="right" valign="top">q7_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#gaf7e914e84c2fa6bcf9b0727b8c46c250">arm_nn_depthwise_conv_nt_t_padded_s8</a> (const q7_t *lhs, const q7_t *rhs, const int32_t input_offset, const uint16_t num_ch, const int32_t *out_shift, const int32_t *out_mult, const int32_t out_offset, const int32_t activation_min, const int32_t activation_max, const uint16_t row_x_col, const int32_t *const output_bias, q7_t *out)</td></tr>
  124. <tr class="memdesc:gaf7e914e84c2fa6bcf9b0727b8c46c250"><td class="mdescLeft">&#160;</td><td class="mdescRight">Depthwise convolution of transposed rhs matrix with 4 lhs matrices. To be used in padded cases where the padding is -lhs_offset(Range: int8). Dimensions are the same for lhs and rhs. <a href="#gaf7e914e84c2fa6bcf9b0727b8c46c250">More...</a><br/></td></tr>
  125. <tr class="separator:gaf7e914e84c2fa6bcf9b0727b8c46c250"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ga7f74841dd08196377cc29ce98deb2c12"><td class="memItemLeft" align="right" valign="top">q7_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#ga7f74841dd08196377cc29ce98deb2c12">arm_nn_depthwise_conv_nt_t_s8</a> (const q7_t *lhs, const q7_t *rhs, const int32_t input_offset, const uint16_t num_ch, const int32_t *out_shift, const int32_t *out_mult, const int32_t out_offset, const int32_t activation_min, const int32_t activation_max, const uint16_t row_x_col, const int32_t *const output_bias, q7_t *out)</td></tr>
  127. <tr class="memdesc:ga7f74841dd08196377cc29ce98deb2c12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Depthwise convolution of transposed rhs matrix with 4 lhs matrices. To be used in non-padded cases. Dimensions are the same for lhs and rhs. <a href="#ga7f74841dd08196377cc29ce98deb2c12">More...</a><br/></td></tr>
  128. <tr class="separator:ga7f74841dd08196377cc29ce98deb2c12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ga5224f2f155a59498c97f4d62ae726ea5"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#ga5224f2f155a59498c97f4d62ae726ea5">arm_nn_mat_mul_core_1x_s8</a> (int32_t row_elements, const int8_t *row_base, const int8_t *col_base, int32_t *const sum_col, int32_t *const output)</td></tr>
  130. <tr class="memdesc:ga5224f2f155a59498c97f4d62ae726ea5"><td class="mdescLeft">&#160;</td><td class="mdescRight">General Matrix-multiplication without requantization for one row &amp; one column. <a href="#ga5224f2f155a59498c97f4d62ae726ea5">More...</a><br/></td></tr>
  131. <tr class="separator:ga5224f2f155a59498c97f4d62ae726ea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:gae893fd2b0fadf44bcd2870ca2c2c3634"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#gae893fd2b0fadf44bcd2870ca2c2c3634">arm_nn_mat_mul_core_4x_s8</a> (const int32_t row_elements, const int32_t offset, const int8_t *row_base, const int8_t *col_base, int32_t *const sum_col, int32_t *const output)</td></tr>
  133. <tr class="memdesc:gae893fd2b0fadf44bcd2870ca2c2c3634"><td class="mdescLeft">&#160;</td><td class="mdescRight">General Matrix-multiplication without requantization for four rows and one column. <a href="#gae893fd2b0fadf44bcd2870ca2c2c3634">More...</a><br/></td></tr>
  134. <tr class="separator:gae893fd2b0fadf44bcd2870ca2c2c3634"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ga360cdaa16c399e3bfbeaaa7296c326e1"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#ga360cdaa16c399e3bfbeaaa7296c326e1">arm_nn_mat_mult_nt_t_s8</a> (const q7_t *lhs, const q7_t *rhs, const q31_t *bias, q7_t *dst, const int32_t *dst_multipliers, const int32_t *dst_shifts, const int32_t lhs_rows, const int32_t rhs_rows, const int32_t rhs_cols, const int32_t lhs_offset, const int32_t dst_offset, const int32_t activation_min, const int32_t activation_max)</td></tr>
  136. <tr class="memdesc:ga360cdaa16c399e3bfbeaaa7296c326e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">General Matrix-multiplication function with per-channel requantization. This function assumes: <a href="#ga360cdaa16c399e3bfbeaaa7296c326e1">More...</a><br/></td></tr>
  137. <tr class="separator:ga360cdaa16c399e3bfbeaaa7296c326e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:ga08f8340aa6533271b3aa6d211614fe22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#ga08f8340aa6533271b3aa6d211614fe22">arm_nn_mult_q15</a> (q15_t *pSrcA, q15_t *pSrcB, q15_t *pDst, const uint16_t out_shift, uint32_t blockSize)</td></tr>
  139. <tr class="memdesc:ga08f8340aa6533271b3aa6d211614fe22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 vector multiplication with variable output shifts. <a href="#ga08f8340aa6533271b3aa6d211614fe22">More...</a><br/></td></tr>
  140. <tr class="separator:ga08f8340aa6533271b3aa6d211614fe22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:gad46c9ab012cceda8ce6681c687a58c70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#gad46c9ab012cceda8ce6681c687a58c70">arm_nn_mult_q7</a> (q7_t *pSrcA, q7_t *pSrcB, q7_t *pDst, const uint16_t out_shift, uint32_t blockSize)</td></tr>
  142. <tr class="memdesc:gad46c9ab012cceda8ce6681c687a58c70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 vector multiplication with variable output shifts. <a href="#gad46c9ab012cceda8ce6681c687a58c70">More...</a><br/></td></tr>
  143. <tr class="separator:gad46c9ab012cceda8ce6681c687a58c70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:gacbc28cf23c7549bcf89d1e8f1481c389"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__NNBasicMath.html#gacbc28cf23c7549bcf89d1e8f1481c389">arm_nn_vec_mat_mult_t_s8</a> (const q7_t *lhs, const q7_t *rhs, const q31_t *bias, q7_t *dst, const int32_t lhs_offset, const int32_t rhs_offset, const int32_t dst_offset, const int32_t dst_multiplier, const int32_t dst_shift, const int32_t rhs_cols, const int32_t rhs_rows, const int32_t activation_min, const int32_t activation_max)</td></tr>
  145. <tr class="memdesc:gacbc28cf23c7549bcf89d1e8f1481c389"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 Vector by Matrix (transposed) multiplication <a href="#gacbc28cf23c7549bcf89d1e8f1481c389">More...</a><br/></td></tr>
  146. <tr class="separator:gacbc28cf23c7549bcf89d1e8f1481c389"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table>
  148. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  149. <p>Basic Math Functions for Neural Network Computation </p>
  150. <h2 class="groupheader">Function Documentation</h2>
  151. <a class="anchor" id="ga379c39e614f1468e1fdb524f51fb6061"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">void arm_nn_accumulate_q7_to_q15 </td>
  157. <td>(</td>
  158. <td class="paramtype">q15_t *&#160;</td>
  159. <td class="paramname"><em>dst</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">const q7_t *&#160;</td>
  165. <td class="paramname"><em>src</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">uint32_t&#160;</td>
  171. <td class="paramname"><em>block_size</em>&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramdir">[in]</td><td class="paramname">*src</td><td>points to the q7 input vector </td></tr>
  183. <tr><td class="paramdir">[out]</td><td class="paramname">*dst</td><td>points to the q15 output vector </td></tr>
  184. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>length of the input vector</td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. <dl class="section user"><dt>Description:</dt><dd></dd></dl>
  189. <p>The equation used for the conversion process is:</p>
  190. <pre>
  191. dst[n] += (q15_t) src[n] ; 0 &lt;= n &lt; block_size.
  192. </pre>
  193. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a9d505dfe68f4486c2327df8a857a89ad">arm_nn_read_q15x2()</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>.</p>
  194. </div>
  195. </div>
  196. <a class="anchor" id="gae65bde3218210820d789659179e14ce3"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">void arm_nn_add_q7 </td>
  202. <td>(</td>
  203. <td class="paramtype">const q7_t *&#160;</td>
  204. <td class="paramname"><em>input</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">q31_t *&#160;</td>
  210. <td class="paramname"><em>output</em>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype">uint32_t&#160;</td>
  216. <td class="paramname"><em>block_size</em>&#160;</td>
  217. </tr>
  218. <tr>
  219. <td></td>
  220. <td>)</td>
  221. <td></td><td></td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <dl class="params"><dt>Parameters</dt><dd>
  226. <table class="params">
  227. <tr><td class="paramdir">[in]</td><td class="paramname">*input</td><td>Pointer to the q7 input vector </td></tr>
  228. <tr><td class="paramdir">[out]</td><td class="paramname">*output</td><td>Pointer to the q31 output variable. </td></tr>
  229. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>length of the input vector </td></tr>
  230. </table>
  231. </dd>
  232. </dl>
  233. <dl class="section user"><dt>Description:</dt><dd></dd></dl>
  234. <p>2^24 samples can be added without saturating the result.</p>
  235. <p>The equation used for the conversion process is:</p>
  236. <pre>
  237. sum = input[0] + input[1] + .. + input[block_size -1]
  238. </pre>
  239. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>.</p>
  240. </div>
  241. </div>
  242. <a class="anchor" id="gaf7e914e84c2fa6bcf9b0727b8c46c250"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">q7_t* arm_nn_depthwise_conv_nt_t_padded_s8 </td>
  248. <td>(</td>
  249. <td class="paramtype">const q7_t *&#160;</td>
  250. <td class="paramname"><em>lhs</em>, </td>
  251. </tr>
  252. <tr>
  253. <td class="paramkey"></td>
  254. <td></td>
  255. <td class="paramtype">const q7_t *&#160;</td>
  256. <td class="paramname"><em>rhs</em>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype">const int32_t&#160;</td>
  262. <td class="paramname"><em>lhs_offset</em>, </td>
  263. </tr>
  264. <tr>
  265. <td class="paramkey"></td>
  266. <td></td>
  267. <td class="paramtype">const uint16_t&#160;</td>
  268. <td class="paramname"><em>num_ch</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">const int32_t *&#160;</td>
  274. <td class="paramname"><em>out_shift</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype">const int32_t *&#160;</td>
  280. <td class="paramname"><em>out_mult</em>, </td>
  281. </tr>
  282. <tr>
  283. <td class="paramkey"></td>
  284. <td></td>
  285. <td class="paramtype">const int32_t&#160;</td>
  286. <td class="paramname"><em>out_offset</em>, </td>
  287. </tr>
  288. <tr>
  289. <td class="paramkey"></td>
  290. <td></td>
  291. <td class="paramtype">const int32_t&#160;</td>
  292. <td class="paramname"><em>activation_min</em>, </td>
  293. </tr>
  294. <tr>
  295. <td class="paramkey"></td>
  296. <td></td>
  297. <td class="paramtype">const int32_t&#160;</td>
  298. <td class="paramname"><em>activation_max</em>, </td>
  299. </tr>
  300. <tr>
  301. <td class="paramkey"></td>
  302. <td></td>
  303. <td class="paramtype">const uint16_t&#160;</td>
  304. <td class="paramname"><em>row_x_col</em>, </td>
  305. </tr>
  306. <tr>
  307. <td class="paramkey"></td>
  308. <td></td>
  309. <td class="paramtype">const int32_t *const&#160;</td>
  310. <td class="paramname"><em>output_bias</em>, </td>
  311. </tr>
  312. <tr>
  313. <td class="paramkey"></td>
  314. <td></td>
  315. <td class="paramtype">q7_t *&#160;</td>
  316. <td class="paramname"><em>out</em>&#160;</td>
  317. </tr>
  318. <tr>
  319. <td></td>
  320. <td>)</td>
  321. <td></td><td></td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <dl class="params"><dt>Parameters</dt><dd>
  326. <table class="params">
  327. <tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>Input left-hand side matrix </td></tr>
  328. <tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>Input right-hand side matrix (transposed) </td></tr>
  329. <tr><td class="paramdir">[in]</td><td class="paramname">lhs_offset</td><td>LHS matrix offset(input offset). Range: -127 to 128 </td></tr>
  330. <tr><td class="paramdir">[in]</td><td class="paramname">num_ch</td><td>Number of channels in LHS/RHS </td></tr>
  331. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>Per channel output shift. Length of vector is equal to number of channels </td></tr>
  332. <tr><td class="paramdir">[in]</td><td class="paramname">out_mult</td><td>Per channel output multiplier. Length of vector is equal to number of channels </td></tr>
  333. <tr><td class="paramdir">[in]</td><td class="paramname">out_offset</td><td>Offset to be added to the output values. Range: -127 to 128 </td></tr>
  334. <tr><td class="paramdir">[in]</td><td class="paramname">activation_min</td><td>Minimum value to clamp the output to. Range: int8 </td></tr>
  335. <tr><td class="paramdir">[in]</td><td class="paramname">activation_max</td><td>Maximum value to clamp the output to. Range: int8 </td></tr>
  336. <tr><td class="paramdir">[in]</td><td class="paramname">row_x_col</td><td>(row_dimension * col_dimension) of LHS/RHS matrix </td></tr>
  337. <tr><td class="paramdir">[in]</td><td class="paramname">output_bias</td><td>Per channel output bias. Length of vector is equal to number of channels </td></tr>
  338. <tr><td class="paramdir">[in]</td><td class="paramname">out</td><td>Output pointer</td></tr>
  339. </table>
  340. </dd>
  341. </dl>
  342. <dl class="section return"><dt>Returns</dt><dd>The function returns one of the two<ul>
  343. <li>Updated output pointer if an implementaiton is available</li>
  344. <li>NULL if no implementation is available.</li>
  345. </ul>
  346. </dd></dl>
  347. <dl class="section note"><dt>Note</dt><dd>If number of channels is not a multiple of 4, upto 3 elements outside the boundary will be read out for the following.<ul>
  348. <li>Output shift</li>
  349. <li>Output multiplier</li>
  350. <li>Output bias</li>
  351. <li>rhs </li>
  352. </ul>
  353. </dd></dl>
  354. <p>Referenced by <a class="el" href="group__NNConv.html#ga3acc8b0cd5bd5d975fdf5a615261f0b1">arm_depthwise_conv_s8_opt()</a>.</p>
  355. </div>
  356. </div>
  357. <a class="anchor" id="ga7f74841dd08196377cc29ce98deb2c12"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname">q7_t* arm_nn_depthwise_conv_nt_t_s8 </td>
  363. <td>(</td>
  364. <td class="paramtype">const q7_t *&#160;</td>
  365. <td class="paramname"><em>lhs</em>, </td>
  366. </tr>
  367. <tr>
  368. <td class="paramkey"></td>
  369. <td></td>
  370. <td class="paramtype">const q7_t *&#160;</td>
  371. <td class="paramname"><em>rhs</em>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype">const int32_t&#160;</td>
  377. <td class="paramname"><em>lhs_offset</em>, </td>
  378. </tr>
  379. <tr>
  380. <td class="paramkey"></td>
  381. <td></td>
  382. <td class="paramtype">const uint16_t&#160;</td>
  383. <td class="paramname"><em>num_ch</em>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype">const int32_t *&#160;</td>
  389. <td class="paramname"><em>out_shift</em>, </td>
  390. </tr>
  391. <tr>
  392. <td class="paramkey"></td>
  393. <td></td>
  394. <td class="paramtype">const int32_t *&#160;</td>
  395. <td class="paramname"><em>out_mult</em>, </td>
  396. </tr>
  397. <tr>
  398. <td class="paramkey"></td>
  399. <td></td>
  400. <td class="paramtype">const int32_t&#160;</td>
  401. <td class="paramname"><em>out_offset</em>, </td>
  402. </tr>
  403. <tr>
  404. <td class="paramkey"></td>
  405. <td></td>
  406. <td class="paramtype">const int32_t&#160;</td>
  407. <td class="paramname"><em>activation_min</em>, </td>
  408. </tr>
  409. <tr>
  410. <td class="paramkey"></td>
  411. <td></td>
  412. <td class="paramtype">const int32_t&#160;</td>
  413. <td class="paramname"><em>activation_max</em>, </td>
  414. </tr>
  415. <tr>
  416. <td class="paramkey"></td>
  417. <td></td>
  418. <td class="paramtype">const uint16_t&#160;</td>
  419. <td class="paramname"><em>row_x_col</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype">const int32_t *const&#160;</td>
  425. <td class="paramname"><em>output_bias</em>, </td>
  426. </tr>
  427. <tr>
  428. <td class="paramkey"></td>
  429. <td></td>
  430. <td class="paramtype">q7_t *&#160;</td>
  431. <td class="paramname"><em>out</em>&#160;</td>
  432. </tr>
  433. <tr>
  434. <td></td>
  435. <td>)</td>
  436. <td></td><td></td>
  437. </tr>
  438. </table>
  439. </div><div class="memdoc">
  440. <dl class="params"><dt>Parameters</dt><dd>
  441. <table class="params">
  442. <tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>Input left-hand side matrix </td></tr>
  443. <tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>Input right-hand side matrix (transposed) </td></tr>
  444. <tr><td class="paramdir">[in]</td><td class="paramname">lhs_offset</td><td>LHS matrix offset(input offset). Range: -127 to 128 </td></tr>
  445. <tr><td class="paramdir">[in]</td><td class="paramname">num_ch</td><td>Number of channels in LHS/RHS </td></tr>
  446. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>Per channel output shift. Length of vector is equal to number of channels. </td></tr>
  447. <tr><td class="paramdir">[in]</td><td class="paramname">out_mult</td><td>Per channel output multiplier. Length of vector is equal to number of channels. </td></tr>
  448. <tr><td class="paramdir">[in]</td><td class="paramname">out_offset</td><td>Offset to be added to the output values. Range: -127 to 128 </td></tr>
  449. <tr><td class="paramdir">[in]</td><td class="paramname">activation_min</td><td>Minimum value to clamp the output to. Range: int8 </td></tr>
  450. <tr><td class="paramdir">[in]</td><td class="paramname">activation_max</td><td>Maximum value to clamp the output to. Range: int8 </td></tr>
  451. <tr><td class="paramdir">[in]</td><td class="paramname">row_x_col</td><td>(row_dimension * col_dimension) of LHS/RHS matrix </td></tr>
  452. <tr><td class="paramdir">[in]</td><td class="paramname">output_bias</td><td>Per channel output bias. Length of vector is equal to number of channels. </td></tr>
  453. <tr><td class="paramdir">[in]</td><td class="paramname">out</td><td>Output pointer</td></tr>
  454. </table>
  455. </dd>
  456. </dl>
  457. <dl class="section return"><dt>Returns</dt><dd>The function returns one of the two<ul>
  458. <li>Updated output pointer if an implementaiton is available</li>
  459. <li>NULL if no implementation is available.</li>
  460. </ul>
  461. </dd></dl>
  462. <dl class="section note"><dt>Note</dt><dd>If number of channels is not a multiple of 4, upto 3 elements outside the boundary will be read out for the following.<ul>
  463. <li>Output shift</li>
  464. <li>Output multiplier</li>
  465. <li>Output bias</li>
  466. <li>rhs </li>
  467. </ul>
  468. </dd></dl>
  469. <p>Referenced by <a class="el" href="group__NNConv.html#ga3acc8b0cd5bd5d975fdf5a615261f0b1">arm_depthwise_conv_s8_opt()</a>.</p>
  470. </div>
  471. </div>
  472. <a class="anchor" id="ga5224f2f155a59498c97f4d62ae726ea5"></a>
  473. <div class="memitem">
  474. <div class="memproto">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">arm_status arm_nn_mat_mul_core_1x_s8 </td>
  478. <td>(</td>
  479. <td class="paramtype">int32_t&#160;</td>
  480. <td class="paramname"><em>row_elements</em>, </td>
  481. </tr>
  482. <tr>
  483. <td class="paramkey"></td>
  484. <td></td>
  485. <td class="paramtype">const int8_t *&#160;</td>
  486. <td class="paramname"><em>row_base</em>, </td>
  487. </tr>
  488. <tr>
  489. <td class="paramkey"></td>
  490. <td></td>
  491. <td class="paramtype">const int8_t *&#160;</td>
  492. <td class="paramname"><em>col_base</em>, </td>
  493. </tr>
  494. <tr>
  495. <td class="paramkey"></td>
  496. <td></td>
  497. <td class="paramtype">int32_t *const&#160;</td>
  498. <td class="paramname"><em>sum_col</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype">int32_t *const&#160;</td>
  504. <td class="paramname"><em>output</em>&#160;</td>
  505. </tr>
  506. <tr>
  507. <td></td>
  508. <td>)</td>
  509. <td></td><td></td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <dl class="params"><dt>Parameters</dt><dd>
  514. <table class="params">
  515. <tr><td class="paramdir">[in]</td><td class="paramname">row_elements</td><td>number of row elements </td></tr>
  516. <tr><td class="paramdir">[in]</td><td class="paramname">row_base</td><td>pointer to row operand </td></tr>
  517. <tr><td class="paramdir">[in]</td><td class="paramname">col_base</td><td>pointer to col operand </td></tr>
  518. <tr><td class="paramdir">[out]</td><td class="paramname">sum_col</td><td>pointer to store sum of column elements </td></tr>
  519. <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>pointer to store result of multiply-accumulate </td></tr>
  520. </table>
  521. </dd>
  522. </dl>
  523. <dl class="section return"><dt>Returns</dt><dd>The function returns the multiply-accumulated result of the row by column.</dd></dl>
  524. <p>Pseudo-code *output = 0 sum_col = 0 for (i = 0; i &lt; row_elements; i++) *output += row_base[i] * col_base[i] sum_col += col_base[i] </p>
  525. <p>Referenced by <a class="el" href="group__NNConv.html#ga2d9c129189832572cf0bc97ff9e73e54">arm_convolve_1_x_n_s8()</a>, and <a class="el" href="group__NNConv.html#gadfcad0bae34328dc806dc88cde173faa">arm_convolve_1x1_s8_fast()</a>.</p>
  526. </div>
  527. </div>
  528. <a class="anchor" id="gae893fd2b0fadf44bcd2870ca2c2c3634"></a>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname">arm_status arm_nn_mat_mul_core_4x_s8 </td>
  534. <td>(</td>
  535. <td class="paramtype">const int32_t&#160;</td>
  536. <td class="paramname"><em>row_elements</em>, </td>
  537. </tr>
  538. <tr>
  539. <td class="paramkey"></td>
  540. <td></td>
  541. <td class="paramtype">const int32_t&#160;</td>
  542. <td class="paramname"><em>offset</em>, </td>
  543. </tr>
  544. <tr>
  545. <td class="paramkey"></td>
  546. <td></td>
  547. <td class="paramtype">const int8_t *&#160;</td>
  548. <td class="paramname"><em>row_base</em>, </td>
  549. </tr>
  550. <tr>
  551. <td class="paramkey"></td>
  552. <td></td>
  553. <td class="paramtype">const int8_t *&#160;</td>
  554. <td class="paramname"><em>col_base</em>, </td>
  555. </tr>
  556. <tr>
  557. <td class="paramkey"></td>
  558. <td></td>
  559. <td class="paramtype">int32_t *const&#160;</td>
  560. <td class="paramname"><em>sum_col</em>, </td>
  561. </tr>
  562. <tr>
  563. <td class="paramkey"></td>
  564. <td></td>
  565. <td class="paramtype">int32_t *const&#160;</td>
  566. <td class="paramname"><em>output</em>&#160;</td>
  567. </tr>
  568. <tr>
  569. <td></td>
  570. <td>)</td>
  571. <td></td><td></td>
  572. </tr>
  573. </table>
  574. </div><div class="memdoc">
  575. <dl class="params"><dt>Parameters</dt><dd>
  576. <table class="params">
  577. <tr><td class="paramdir">[in]</td><td class="paramname">row_elements</td><td>number of row elements </td></tr>
  578. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset between rows. Can be the same as row_elements. For e.g, in a 1x1 conv scenario with stride as 1. </td></tr>
  579. <tr><td class="paramdir">[in]</td><td class="paramname">row_base</td><td>pointer to row operand </td></tr>
  580. <tr><td class="paramdir">[in]</td><td class="paramname">col_base</td><td>pointer to col operand </td></tr>
  581. <tr><td class="paramdir">[out]</td><td class="paramname">sum_col</td><td>pointer to store sum of column elements </td></tr>
  582. <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>pointer to store result(4 int32's) of multiply-accumulate </td></tr>
  583. </table>
  584. </dd>
  585. </dl>
  586. <dl class="section return"><dt>Returns</dt><dd>The function returns the multiply-accumulated result of the row by column</dd></dl>
  587. <p>Pseudo-code output[0] = 0 .. output[3] = 0 sum_col = 0 for (i = 0; i &lt; row_elements; i++) output[0] += row_base[i] * col_base[i] .. output[3] += row_base[i + (row_elements * 3)] * col_base[i] sum_col += col_base[i] </p>
  588. <p>Referenced by <a class="el" href="group__NNConv.html#ga2d9c129189832572cf0bc97ff9e73e54">arm_convolve_1_x_n_s8()</a>, <a class="el" href="group__NNConv.html#gadfcad0bae34328dc806dc88cde173faa">arm_convolve_1x1_s8_fast()</a>, and <a class="el" href="group__NNConv.html#ga6a0b2161ece62078228ead2d85bbcf28">arm_convolve_s8()</a>.</p>
  589. </div>
  590. </div>
  591. <a class="anchor" id="ga360cdaa16c399e3bfbeaaa7296c326e1"></a>
  592. <div class="memitem">
  593. <div class="memproto">
  594. <table class="memname">
  595. <tr>
  596. <td class="memname">arm_status arm_nn_mat_mult_nt_t_s8 </td>
  597. <td>(</td>
  598. <td class="paramtype">const q7_t *&#160;</td>
  599. <td class="paramname"><em>lhs</em>, </td>
  600. </tr>
  601. <tr>
  602. <td class="paramkey"></td>
  603. <td></td>
  604. <td class="paramtype">const q7_t *&#160;</td>
  605. <td class="paramname"><em>rhs</em>, </td>
  606. </tr>
  607. <tr>
  608. <td class="paramkey"></td>
  609. <td></td>
  610. <td class="paramtype">const q31_t *&#160;</td>
  611. <td class="paramname"><em>bias</em>, </td>
  612. </tr>
  613. <tr>
  614. <td class="paramkey"></td>
  615. <td></td>
  616. <td class="paramtype">q7_t *&#160;</td>
  617. <td class="paramname"><em>dst</em>, </td>
  618. </tr>
  619. <tr>
  620. <td class="paramkey"></td>
  621. <td></td>
  622. <td class="paramtype">const int32_t *&#160;</td>
  623. <td class="paramname"><em>dst_multipliers</em>, </td>
  624. </tr>
  625. <tr>
  626. <td class="paramkey"></td>
  627. <td></td>
  628. <td class="paramtype">const int32_t *&#160;</td>
  629. <td class="paramname"><em>dst_shifts</em>, </td>
  630. </tr>
  631. <tr>
  632. <td class="paramkey"></td>
  633. <td></td>
  634. <td class="paramtype">const int32_t&#160;</td>
  635. <td class="paramname"><em>lhs_rows</em>, </td>
  636. </tr>
  637. <tr>
  638. <td class="paramkey"></td>
  639. <td></td>
  640. <td class="paramtype">const int32_t&#160;</td>
  641. <td class="paramname"><em>rhs_rows</em>, </td>
  642. </tr>
  643. <tr>
  644. <td class="paramkey"></td>
  645. <td></td>
  646. <td class="paramtype">const int32_t&#160;</td>
  647. <td class="paramname"><em>rhs_cols</em>, </td>
  648. </tr>
  649. <tr>
  650. <td class="paramkey"></td>
  651. <td></td>
  652. <td class="paramtype">const int32_t&#160;</td>
  653. <td class="paramname"><em>lhs_offset</em>, </td>
  654. </tr>
  655. <tr>
  656. <td class="paramkey"></td>
  657. <td></td>
  658. <td class="paramtype">const int32_t&#160;</td>
  659. <td class="paramname"><em>dst_offset</em>, </td>
  660. </tr>
  661. <tr>
  662. <td class="paramkey"></td>
  663. <td></td>
  664. <td class="paramtype">const int32_t&#160;</td>
  665. <td class="paramname"><em>activation_min</em>, </td>
  666. </tr>
  667. <tr>
  668. <td class="paramkey"></td>
  669. <td></td>
  670. <td class="paramtype">const int32_t&#160;</td>
  671. <td class="paramname"><em>activation_max</em>&#160;</td>
  672. </tr>
  673. <tr>
  674. <td></td>
  675. <td>)</td>
  676. <td></td><td></td>
  677. </tr>
  678. </table>
  679. </div><div class="memdoc">
  680. <ul>
  681. <li>LHS input matrix NOT transposed (nt)</li>
  682. <li>RHS input matrix transposed (t)</li>
  683. </ul>
  684. <dl class="section note"><dt>Note</dt><dd>This operation also performs the broadcast bias addition before the requantization</dd></dl>
  685. <dl class="params"><dt>Parameters</dt><dd>
  686. <table class="params">
  687. <tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>Pointer to the LHS input matrix </td></tr>
  688. <tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>Pointer to the RHS input matrix </td></tr>
  689. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>Pointer to the bias vector. The length of this vector is equal to the number of output columns (or RHS input rows) </td></tr>
  690. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the output matrix with "m" rows and "n" columns </td></tr>
  691. <tr><td class="paramdir">[in]</td><td class="paramname">dst_multipliers</td><td>Pointer to the multipliers vector needed for the per-channel requantization. The length of this vector is equal to the number of output columns (or RHS input rows) </td></tr>
  692. <tr><td class="paramdir">[in]</td><td class="paramname">dst_shifts</td><td>Pointer to the shifts vector needed for the per-channel requantization. The length of this vector is equal to the number of output columns (or RHS input rows) </td></tr>
  693. <tr><td class="paramdir">[in]</td><td class="paramname">lhs_rows</td><td>Number of LHS input rows </td></tr>
  694. <tr><td class="paramdir">[in]</td><td class="paramname">rhs_rows</td><td>Number of RHS input rows </td></tr>
  695. <tr><td class="paramdir">[in]</td><td class="paramname">rhs_cols</td><td>Number of LHS/RHS input columns </td></tr>
  696. <tr><td class="paramdir">[in]</td><td class="paramname">lhs_offset</td><td>Offset to be applied to the LHS input value </td></tr>
  697. <tr><td class="paramdir">[in]</td><td class="paramname">dst_offset</td><td>Offset to be applied the output result </td></tr>
  698. <tr><td class="paramdir">[in]</td><td class="paramname">activation_min</td><td>Minimum value to clamp down the output. Range : int8 </td></tr>
  699. <tr><td class="paramdir">[in]</td><td class="paramname">activation_max</td><td>Maximum value to clamp up the output. Range : int8</td></tr>
  700. </table>
  701. </dd>
  702. </dl>
  703. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code> </dd></dl>
  704. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a31fa46f17212fbcb65d2cdae06fc08f5">arm_nn_read_q7x4()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a6a13b7a567485da5fc7f0d311318886d">arm_nn_requantize()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
  705. <p>Referenced by <a class="el" href="group__NNConv.html#gadfcad0bae34328dc806dc88cde173faa">arm_convolve_1x1_s8_fast()</a>.</p>
  706. </div>
  707. </div>
  708. <a class="anchor" id="ga08f8340aa6533271b3aa6d211614fe22"></a>
  709. <div class="memitem">
  710. <div class="memproto">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname">void arm_nn_mult_q15 </td>
  714. <td>(</td>
  715. <td class="paramtype">q15_t *&#160;</td>
  716. <td class="paramname"><em>pSrcA</em>, </td>
  717. </tr>
  718. <tr>
  719. <td class="paramkey"></td>
  720. <td></td>
  721. <td class="paramtype">q15_t *&#160;</td>
  722. <td class="paramname"><em>pSrcB</em>, </td>
  723. </tr>
  724. <tr>
  725. <td class="paramkey"></td>
  726. <td></td>
  727. <td class="paramtype">q15_t *&#160;</td>
  728. <td class="paramname"><em>pDst</em>, </td>
  729. </tr>
  730. <tr>
  731. <td class="paramkey"></td>
  732. <td></td>
  733. <td class="paramtype">const uint16_t&#160;</td>
  734. <td class="paramname"><em>out_shift</em>, </td>
  735. </tr>
  736. <tr>
  737. <td class="paramkey"></td>
  738. <td></td>
  739. <td class="paramtype">uint32_t&#160;</td>
  740. <td class="paramname"><em>blockSize</em>&#160;</td>
  741. </tr>
  742. <tr>
  743. <td></td>
  744. <td>)</td>
  745. <td></td><td></td>
  746. </tr>
  747. </table>
  748. </div><div class="memdoc">
  749. <p>q7 vector multiplication with variable output shifts</p>
  750. <dl class="params"><dt>Parameters</dt><dd>
  751. <table class="params">
  752. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>pointer to the first input vector </td></tr>
  753. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>pointer to the second input vector </td></tr>
  754. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>pointer to the output vector </td></tr>
  755. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  756. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector</td></tr>
  757. </table>
  758. </dd>
  759. </dl>
  760. <p><b>Scaling and Overflow Behavior:</b> </p>
  761. <dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] will be saturated. </dd></dl>
  762. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#afdda94a339b76615d3161e9fc63f4d21">arm_nn_read_q15x2_ia()</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  763. </div>
  764. </div>
  765. <a class="anchor" id="gad46c9ab012cceda8ce6681c687a58c70"></a>
  766. <div class="memitem">
  767. <div class="memproto">
  768. <table class="memname">
  769. <tr>
  770. <td class="memname">void arm_nn_mult_q7 </td>
  771. <td>(</td>
  772. <td class="paramtype">q7_t *&#160;</td>
  773. <td class="paramname"><em>pSrcA</em>, </td>
  774. </tr>
  775. <tr>
  776. <td class="paramkey"></td>
  777. <td></td>
  778. <td class="paramtype">q7_t *&#160;</td>
  779. <td class="paramname"><em>pSrcB</em>, </td>
  780. </tr>
  781. <tr>
  782. <td class="paramkey"></td>
  783. <td></td>
  784. <td class="paramtype">q7_t *&#160;</td>
  785. <td class="paramname"><em>pDst</em>, </td>
  786. </tr>
  787. <tr>
  788. <td class="paramkey"></td>
  789. <td></td>
  790. <td class="paramtype">const uint16_t&#160;</td>
  791. <td class="paramname"><em>out_shift</em>, </td>
  792. </tr>
  793. <tr>
  794. <td class="paramkey"></td>
  795. <td></td>
  796. <td class="paramtype">uint32_t&#160;</td>
  797. <td class="paramname"><em>blockSize</em>&#160;</td>
  798. </tr>
  799. <tr>
  800. <td></td>
  801. <td>)</td>
  802. <td></td><td></td>
  803. </tr>
  804. </table>
  805. </div><div class="memdoc">
  806. <p>q7 vector multiplication with variable output shifts</p>
  807. <dl class="params"><dt>Parameters</dt><dd>
  808. <table class="params">
  809. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>pointer to the first input vector </td></tr>
  810. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>pointer to the second input vector </td></tr>
  811. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>pointer to the output vector </td></tr>
  812. <tr><td class="paramdir">[in]</td><td class="paramname">out_shift</td><td>amount of right-shift for output </td></tr>
  813. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in each vector</td></tr>
  814. </table>
  815. </dd>
  816. </dl>
  817. <p><b>Scaling and Overflow Behavior:</b> </p>
  818. <dl class="section user"><dt></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] will be saturated. </dd></dl>
  819. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>.</p>
  820. </div>
  821. </div>
  822. <a class="anchor" id="gacbc28cf23c7549bcf89d1e8f1481c389"></a>
  823. <div class="memitem">
  824. <div class="memproto">
  825. <table class="memname">
  826. <tr>
  827. <td class="memname">arm_status arm_nn_vec_mat_mult_t_s8 </td>
  828. <td>(</td>
  829. <td class="paramtype">const q7_t *&#160;</td>
  830. <td class="paramname"><em>lhs</em>, </td>
  831. </tr>
  832. <tr>
  833. <td class="paramkey"></td>
  834. <td></td>
  835. <td class="paramtype">const q7_t *&#160;</td>
  836. <td class="paramname"><em>rhs</em>, </td>
  837. </tr>
  838. <tr>
  839. <td class="paramkey"></td>
  840. <td></td>
  841. <td class="paramtype">const q31_t *&#160;</td>
  842. <td class="paramname"><em>bias</em>, </td>
  843. </tr>
  844. <tr>
  845. <td class="paramkey"></td>
  846. <td></td>
  847. <td class="paramtype">q7_t *&#160;</td>
  848. <td class="paramname"><em>dst</em>, </td>
  849. </tr>
  850. <tr>
  851. <td class="paramkey"></td>
  852. <td></td>
  853. <td class="paramtype">const int32_t&#160;</td>
  854. <td class="paramname"><em>lhs_offset</em>, </td>
  855. </tr>
  856. <tr>
  857. <td class="paramkey"></td>
  858. <td></td>
  859. <td class="paramtype">const int32_t&#160;</td>
  860. <td class="paramname"><em>rhs_offset</em>, </td>
  861. </tr>
  862. <tr>
  863. <td class="paramkey"></td>
  864. <td></td>
  865. <td class="paramtype">const int32_t&#160;</td>
  866. <td class="paramname"><em>dst_offset</em>, </td>
  867. </tr>
  868. <tr>
  869. <td class="paramkey"></td>
  870. <td></td>
  871. <td class="paramtype">const int32_t&#160;</td>
  872. <td class="paramname"><em>dst_multiplier</em>, </td>
  873. </tr>
  874. <tr>
  875. <td class="paramkey"></td>
  876. <td></td>
  877. <td class="paramtype">const int32_t&#160;</td>
  878. <td class="paramname"><em>dst_shift</em>, </td>
  879. </tr>
  880. <tr>
  881. <td class="paramkey"></td>
  882. <td></td>
  883. <td class="paramtype">const int32_t&#160;</td>
  884. <td class="paramname"><em>rhs_cols</em>, </td>
  885. </tr>
  886. <tr>
  887. <td class="paramkey"></td>
  888. <td></td>
  889. <td class="paramtype">const int32_t&#160;</td>
  890. <td class="paramname"><em>rhs_rows</em>, </td>
  891. </tr>
  892. <tr>
  893. <td class="paramkey"></td>
  894. <td></td>
  895. <td class="paramtype">const int32_t&#160;</td>
  896. <td class="paramname"><em>activation_min</em>, </td>
  897. </tr>
  898. <tr>
  899. <td class="paramkey"></td>
  900. <td></td>
  901. <td class="paramtype">const int32_t&#160;</td>
  902. <td class="paramname"><em>activation_max</em>&#160;</td>
  903. </tr>
  904. <tr>
  905. <td></td>
  906. <td>)</td>
  907. <td></td><td></td>
  908. </tr>
  909. </table>
  910. </div><div class="memdoc">
  911. <dl class="params"><dt>Parameters</dt><dd>
  912. <table class="params">
  913. <tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>Input left-hand side vector </td></tr>
  914. <tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>Input right-hand side matrix (transposed) </td></tr>
  915. <tr><td class="paramdir">[in]</td><td class="paramname">bias</td><td>Input bias </td></tr>
  916. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Output vector </td></tr>
  917. <tr><td class="paramdir">[in]</td><td class="paramname">lhs_offset</td><td>Offset to be added to the input values of the left-hand side vector. Range: -127 to 128 </td></tr>
  918. <tr><td class="paramdir">[in]</td><td class="paramname">rhs_offset</td><td>Offset to be added to the input values of the right-hand side matrix. Range: -127 to 128 </td></tr>
  919. <tr><td class="paramdir">[in]</td><td class="paramname">dst_offset</td><td>Offset to be added to the output values. Range: -127 to 128 </td></tr>
  920. <tr><td class="paramdir">[in]</td><td class="paramname">dst_multiplier</td><td>Output multiplier </td></tr>
  921. <tr><td class="paramdir">[in]</td><td class="paramname">dst_shift</td><td>Output shift </td></tr>
  922. <tr><td class="paramdir">[in]</td><td class="paramname">rhs_cols</td><td>Number of columns in the right-hand side input matrix </td></tr>
  923. <tr><td class="paramdir">[in]</td><td class="paramname">rhs_rows</td><td>Number of rows in the right-hand side input matrix </td></tr>
  924. <tr><td class="paramdir">[in]</td><td class="paramname">activation_min</td><td>Minimum value to clamp the output to. Range: int8 </td></tr>
  925. <tr><td class="paramdir">[in]</td><td class="paramname">activation_max</td><td>Maximum value to clamp the output to. Range: int8</td></tr>
  926. </table>
  927. </dd>
  928. </dl>
  929. <dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code> </dd></dl>
  930. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a31fa46f17212fbcb65d2cdae06fc08f5">arm_nn_read_q7x4()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a6a13b7a567485da5fc7f0d311318886d">arm_nn_requantize()</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>.</p>
  931. <p>Referenced by <a class="el" href="group__FC.html#ga2e580c510d9dc26a2e8e422f805b9bc0">arm_fully_connected_s8()</a>.</p>
  932. </div>
  933. </div>
  934. </div><!-- contents -->
  935. </div><!-- doc-content -->
  936. <!-- start footer part -->
  937. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  938. <ul>
  939. <li class="footer">Generated on Thu Apr 9 2020 15:49:35 for CMSIS-NN Version 1.3.0 by Arm Ltd. All rights reserved.
  940. <!--
  941. <a href="http://www.doxygen.org/index.html">
  942. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  943. -->
  944. </li>
  945. </ul>
  946. </div>
  947. </body>
  948. </html>