group__nndata__convert.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  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>Neural Network Data Conversion Functions</title>
  7. <title>CMSIS-NN: Neural Network Data Conversion Functions</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__nndata__convert.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">Neural Network Data Conversion Functions</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:gae349de4dba8d253c89d45794ccf05680"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nndata__convert.html#gae349de4dba8d253c89d45794ccf05680">arm_q7_to_q15_no_shift</a> (const q7_t *pSrc, q15_t *pDst, uint32_t blockSize)</td></tr>
  118. <tr class="memdesc:gae349de4dba8d253c89d45794ccf05680"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q7 vector to Q15 vector without left-shift. <a href="#gae349de4dba8d253c89d45794ccf05680">More...</a><br/></td></tr>
  119. <tr class="separator:gae349de4dba8d253c89d45794ccf05680"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gaba8fd446d5f54760b406ee63b25d1aee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nndata__convert.html#gaba8fd446d5f54760b406ee63b25d1aee">arm_q7_to_q15_reordered_no_shift</a> (const q7_t *pSrc, q15_t *pDst, uint32_t blockSize)</td></tr>
  121. <tr class="memdesc:gaba8fd446d5f54760b406ee63b25d1aee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q7 vector to reordered Q15 vector without left-shift. <a href="#gaba8fd446d5f54760b406ee63b25d1aee">More...</a><br/></td></tr>
  122. <tr class="separator:gaba8fd446d5f54760b406ee63b25d1aee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga18e161730cf13bb5ed73de2d3a7cb224"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nndata__convert.html#ga18e161730cf13bb5ed73de2d3a7cb224">arm_q7_to_q15_reordered_with_offset</a> (const q7_t *src, q15_t *dst, uint32_t block_size, q15_t offset)</td></tr>
  124. <tr class="memdesc:ga18e161730cf13bb5ed73de2d3a7cb224"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements of the Q7 vector to a reordered Q15 vector with an added offset. <a href="#ga18e161730cf13bb5ed73de2d3a7cb224">More...</a><br/></td></tr>
  125. <tr class="separator:ga18e161730cf13bb5ed73de2d3a7cb224"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:gab2d48529ae05b350a015f8f1e6596a31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nndata__convert.html#gab2d48529ae05b350a015f8f1e6596a31">arm_q7_to_q15_with_offset</a> (const q7_t *src, q15_t *dst, uint32_t block_size, q15_t offset)</td></tr>
  127. <tr class="memdesc:gab2d48529ae05b350a015f8f1e6596a31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the elements from a q7 vector to a q15 vector with an added offset. <a href="#gab2d48529ae05b350a015f8f1e6596a31">More...</a><br/></td></tr>
  128. <tr class="separator:gab2d48529ae05b350a015f8f1e6596a31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table>
  130. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  131. <p>Perform data type conversion in-between neural network operations </p>
  132. <h2 class="groupheader">Function Documentation</h2>
  133. <a class="anchor" id="gae349de4dba8d253c89d45794ccf05680"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">void arm_q7_to_q15_no_shift </td>
  139. <td>(</td>
  140. <td class="paramtype">const q7_t *&#160;</td>
  141. <td class="paramname"><em>pSrc</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">q15_t *&#160;</td>
  147. <td class="paramname"><em>pDst</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">uint32_t&#160;</td>
  153. <td class="paramname"><em>blockSize</em>&#160;</td>
  154. </tr>
  155. <tr>
  156. <td></td>
  157. <td>)</td>
  158. <td></td><td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Converts the elements of the q7 vector to q15 vector without left-shift.</p>
  163. <dl class="params"><dt>Parameters</dt><dd>
  164. <table class="params">
  165. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the Q7 input vector </td></tr>
  166. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q15 output vector </td></tr>
  167. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector</td></tr>
  168. </table>
  169. </dd>
  170. </dl>
  171. <dl class="section user"><dt>Description:</dt><dd></dd></dl>
  172. <p>The equation used for the conversion process is:</p>
  173. <pre>
  174. pDst[n] = (q15_t) pSrc[n]; 0 &lt;= n &lt; blockSize.
  175. </pre>
  176. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>.</p>
  177. <p>Referenced by <a class="el" href="group__Pooling.html#gae4a7b07f97ec4313524c9fb9fbcb1f6a">arm_avepool_q7_HWC()</a>, <a class="el" href="group__NNConv.html#ga210ae8d8fc1d12ee15b41f1fa6947681">arm_convolve_HWC_q7_basic()</a>, and <a class="el" href="group__NNConv.html#ga4501fa22c0836002aa47ccc313dce252">arm_convolve_HWC_q7_basic_nonsquare()</a>.</p>
  178. </div>
  179. </div>
  180. <a class="anchor" id="gaba8fd446d5f54760b406ee63b25d1aee"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">void arm_q7_to_q15_reordered_no_shift </td>
  186. <td>(</td>
  187. <td class="paramtype">const q7_t *&#160;</td>
  188. <td class="paramname"><em>pSrc</em>, </td>
  189. </tr>
  190. <tr>
  191. <td class="paramkey"></td>
  192. <td></td>
  193. <td class="paramtype">q15_t *&#160;</td>
  194. <td class="paramname"><em>pDst</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">uint32_t&#160;</td>
  200. <td class="paramname"><em>blockSize</em>&#160;</td>
  201. </tr>
  202. <tr>
  203. <td></td>
  204. <td>)</td>
  205. <td></td><td></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Converts the elements of the q7 vector to reordered q15 vector without left-shift.</p>
  210. <dl class="params"><dt>Parameters</dt><dd>
  211. <table class="params">
  212. <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the Q7 input vector </td></tr>
  213. <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to the Q15 output vector </td></tr>
  214. <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector</td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218. <p>This function does the q7 to q15 expansion with re-ordering</p>
  219. <pre>
  220. | A1 | A2 | A3 | A4 |</pre><pre> 0 7 8 15 16 23 24 31
  221. </pre><p>is converted into:</p>
  222. <pre>
  223. | A1 | A3 | and | A2 | A4 |</pre><pre> 0 15 16 31 0 15 16 31
  224. </pre><p>This looks strange but is natural considering how sign-extension is done at assembly level.</p>
  225. <p>The expansion of other other oprand will follow the same rule so that the end results are the same.</p>
  226. <p>The tail (i.e., last (N % 4) elements) will still be in original order. </p>
  227. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>.</p>
  228. <p>Referenced by <a class="el" href="group__NNConv.html#ga110adcfdaab356c750c6270aa5e05f29">arm_convolve_1x1_HWC_q7_fast_nonsquare()</a>, <a class="el" href="group__NNConv.html#gae00d3c1285907d59657369fc98bcc83f">arm_convolve_HWC_q7_fast()</a>, <a class="el" href="group__NNConv.html#gabc6d6b991024e9e5c5cdbd7489de88ef">arm_convolve_HWC_q7_fast_nonsquare()</a>, <a class="el" href="group__FC.html#ga8b7e0c2e989e8c75f0dc789f3115323d">arm_fully_connected_q7()</a>, and <a class="el" href="group__FC.html#gaf82b71ef472a38f8fc9ac414d9d07e67">arm_fully_connected_q7_opt()</a>.</p>
  229. </div>
  230. </div>
  231. <a class="anchor" id="ga18e161730cf13bb5ed73de2d3a7cb224"></a>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">void arm_q7_to_q15_reordered_with_offset </td>
  237. <td>(</td>
  238. <td class="paramtype">const q7_t *&#160;</td>
  239. <td class="paramname"><em>src</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">q15_t *&#160;</td>
  245. <td class="paramname"><em>dst</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>block_size</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype">q15_t&#160;</td>
  257. <td class="paramname"><em>offset</em>&#160;</td>
  258. </tr>
  259. <tr>
  260. <td></td>
  261. <td>)</td>
  262. <td></td><td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Converts the elements of the q7 vector to reordered q15 vector with an added offset.</p>
  267. <dl class="section note"><dt>Note</dt><dd>Refer header file for details. </dd></dl>
  268. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>.</p>
  269. </div>
  270. </div>
  271. <a class="anchor" id="gab2d48529ae05b350a015f8f1e6596a31"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void arm_q7_to_q15_with_offset </td>
  277. <td>(</td>
  278. <td class="paramtype">const q7_t *&#160;</td>
  279. <td class="paramname"><em>src</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">q15_t *&#160;</td>
  285. <td class="paramname"><em>dst</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>block_size</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">q15_t&#160;</td>
  297. <td class="paramname"><em>offset</em>&#160;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <dl class="params"><dt>Parameters</dt><dd>
  307. <table class="params">
  308. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>pointer to the q7 input vector </td></tr>
  309. <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>pointer to the q15 output vector </td></tr>
  310. <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>length of the input vector </td></tr>
  311. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>q7 offset to be added to each input vector element.</td></tr>
  312. </table>
  313. </dd>
  314. </dl>
  315. <dl class="section user"><dt>Description:</dt><dd></dd></dl>
  316. <p>The equation used for the conversion process is:</p>
  317. <pre>
  318. dst[n] = (q15_t) src[n] + offset; 0 &lt;= n &lt; block_size.
  319. </pre>
  320. <p>References <a class="el" href="arm__nnsupportfunctions_8h.html#ac9f7be20432a6926ac07c1f44b1b02fe">arm_nn_read_q7x4_ia()</a>.</p>
  321. <p>Referenced by <a class="el" href="group__NNConv.html#ga6a0b2161ece62078228ead2d85bbcf28">arm_convolve_s8()</a>, and <a class="el" href="group__NNConv.html#ga3acc8b0cd5bd5d975fdf5a615261f0b1">arm_depthwise_conv_s8_opt()</a>.</p>
  322. </div>
  323. </div>
  324. </div><!-- contents -->
  325. </div><!-- doc-content -->
  326. <!-- start footer part -->
  327. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  328. <ul>
  329. <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.
  330. <!--
  331. <a href="http://www.doxygen.org/index.html">
  332. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  333. -->
  334. </li>
  335. </ul>
  336. </div>
  337. </body>
  338. </html>