diff options
Diffstat (limited to 'docs/NN/html/arm__nnsupportfunctions_8h.html')
| -rw-r--r-- | docs/NN/html/arm__nnsupportfunctions_8h.html | 159 |
1 files changed, 156 insertions, 3 deletions
diff --git a/docs/NN/html/arm__nnsupportfunctions_8h.html b/docs/NN/html/arm__nnsupportfunctions_8h.html index 6d4f025..6513b78 100644 --- a/docs/NN/html/arm__nnsupportfunctions_8h.html +++ b/docs/NN/html/arm__nnsupportfunctions_8h.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-NN -  <span id="projectnumber">Version 1.1.0</span> +  <span id="projectnumber">Version 1.2.0</span> </div> <div id="projectbrief">CMSIS NN Software Library</div> </td> @@ -125,8 +125,16 @@ Data Structures</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> +<tr class="memitem:a2953f124ae444ebdd2b2a0873ac36b7e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#a2953f124ae444ebdd2b2a0873ac36b7e">LEFT_SHIFT</a>(_shift)</td></tr> +<tr class="separator:a2953f124ae444ebdd2b2a0873ac36b7e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a26af54489c1401b91595bf0c92ef87c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#a26af54489c1401b91595bf0c92ef87c4">RIGHT_SHIFT</a>(_shift)</td></tr> +<tr class="separator:a26af54489c1401b91595bf0c92ef87c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1eb725c94dbb052aa24b62321be0445b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#a1eb725c94dbb052aa24b62321be0445b">Q31_MIN</a></td></tr> +<tr class="separator:a1eb725c94dbb052aa24b62321be0445b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a468734b237f1c95a31715aa2b60a576e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#a468734b237f1c95a31715aa2b60a576e">Q31_MAX</a></td></tr> +<tr class="separator:a468734b237f1c95a31715aa2b60a576e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4cbd428a2b4a4f6b2a6e4219520c7ce0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#a4cbd428a2b4a4f6b2a6e4219520c7ce0">NN_ROUND</a>(out_shift)</td></tr> -<tr class="memdesc:a4cbd428a2b4a4f6b2a6e4219520c7ce0"><td class="mdescLeft"> </td><td class="mdescRight">defition to adding rouding offset <a href="#a4cbd428a2b4a4f6b2a6e4219520c7ce0">More...</a><br/></td></tr> +<tr class="memdesc:a4cbd428a2b4a4f6b2a6e4219520c7ce0"><td class="mdescLeft"> </td><td class="mdescRight">macro for adding rounding offset <a href="#a4cbd428a2b4a4f6b2a6e4219520c7ce0">More...</a><br/></td></tr> <tr class="separator:a4cbd428a2b4a4f6b2a6e4219520c7ce0"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> @@ -149,8 +157,32 @@ Functions</h2></td></tr> <tr class="memitem:gad46c9ab012cceda8ce6681c687a58c70"><td class="memItemLeft" align="right" valign="top">void </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> <tr class="memdesc:gad46c9ab012cceda8ce6681c687a58c70"><td class="mdescLeft"> </td><td class="mdescRight">Q7 vector multiplication with variable output shifts. <a href="group__NNBasicMath.html#gad46c9ab012cceda8ce6681c687a58c70">More...</a><br/></td></tr> <tr class="separator:gad46c9ab012cceda8ce6681c687a58c70"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a51721c10f116c9f5b8d9908367989d44"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE q31_t </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#a51721c10f116c9f5b8d9908367989d44">arm_nn_sat_doubling_high_mult</a> (const q31_t m1, const q31_t m2)</td></tr> +<tr class="memdesc:a51721c10f116c9f5b8d9908367989d44"><td class="mdescLeft"> </td><td class="mdescRight">Saturating doubling high multiply. Result matches NEON instruction VQRDMULH. <a href="#a51721c10f116c9f5b8d9908367989d44">More...</a><br/></td></tr> +<tr class="separator:a51721c10f116c9f5b8d9908367989d44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab6dbc2fd53fae3ccdd1d0d70c8d3b491"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE q31_t </td><td class="memItemRight" valign="bottom"><a class="el" href="arm__nnsupportfunctions_8h.html#ab6dbc2fd53fae3ccdd1d0d70c8d3b491">arm_nn_divide_by_power_of_two</a> (const q31_t dividend, const q31_t exponent)</td></tr> +<tr class="memdesc:ab6dbc2fd53fae3ccdd1d0d70c8d3b491"><td class="mdescLeft"> </td><td class="mdescRight">Rounding divide by power of two. <a href="#ab6dbc2fd53fae3ccdd1d0d70c8d3b491">More...</a><br/></td></tr> +<tr class="separator:ab6dbc2fd53fae3ccdd1d0d70c8d3b491"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="a2953f124ae444ebdd2b2a0873ac36b7e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define LEFT_SHIFT</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">_shift</td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="group__NNConv.html#ga02a296cb4f6361a70c3ecf1ef1238292">arm_depthwise_conv_u8_basic_ver1()</a>.</p> + +</div> +</div> <a class="anchor" id="a4cbd428a2b4a4f6b2a6e4219520c7ce0"></a> <div class="memitem"> <div class="memproto"> @@ -169,6 +201,52 @@ Functions</h2></td></tr> </div> </div> +<a class="anchor" id="a468734b237f1c95a31715aa2b60a576e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define Q31_MAX</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="arm__nnsupportfunctions_8h.html#a51721c10f116c9f5b8d9908367989d44">arm_nn_sat_doubling_high_mult()</a>.</p> + +</div> +</div> +<a class="anchor" id="a1eb725c94dbb052aa24b62321be0445b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define Q31_MIN</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="arm__nnsupportfunctions_8h.html#a51721c10f116c9f5b8d9908367989d44">arm_nn_sat_doubling_high_mult()</a>.</p> + +</div> +</div> +<a class="anchor" id="a26af54489c1401b91595bf0c92ef87c4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define RIGHT_SHIFT</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">_shift</td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="group__NNConv.html#ga02a296cb4f6361a70c3ecf1ef1238292">arm_depthwise_conv_u8_basic_ver1()</a>.</p> + +</div> +</div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="a7f41aa78cd9a0552fae9b348ee4831a0"></a> <div class="memitem"> @@ -190,13 +268,88 @@ Functions</h2></td></tr> </div> </div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ab6dbc2fd53fae3ccdd1d0d70c8d3b491"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">__STATIC_FORCEINLINE q31_t arm_nn_divide_by_power_of_two </td> + <td>(</td> + <td class="paramtype">const q31_t </td> + <td class="paramname"><em>dividend</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const q31_t </td> + <td class="paramname"><em>exponent</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">dividend</td><td>- Dividend </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">exponent</td><td>- Divisor = power(2, exponent) Range: [0, 31] </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Rounded result of division. Midpoint is rounded away from zero. </dd></dl> + +<p>Referenced by <a class="el" href="group__NNConv.html#ga02a296cb4f6361a70c3ecf1ef1238292">arm_depthwise_conv_u8_basic_ver1()</a>.</p> + +</div> +</div> +<a class="anchor" id="a51721c10f116c9f5b8d9908367989d44"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">__STATIC_FORCEINLINE q31_t arm_nn_sat_doubling_high_mult </td> + <td>(</td> + <td class="paramtype">const q31_t </td> + <td class="paramname"><em>m1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const q31_t </td> + <td class="paramname"><em>m2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">m1</td><td>Multiplicand </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">m2</td><td>Multiplier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of multiplication. </dd></dl> + +<p>References <a class="el" href="arm__nnsupportfunctions_8h.html#a468734b237f1c95a31715aa2b60a576e">Q31_MAX</a>, and <a class="el" href="arm__nnsupportfunctions_8h.html#a1eb725c94dbb052aa24b62321be0445b">Q31_MIN</a>.</p> + +<p>Referenced by <a class="el" href="group__NNConv.html#ga02a296cb4f6361a70c3ecf1ef1238292">arm_depthwise_conv_u8_basic_ver1()</a>.</p> + +</div> +</div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_06560e3359c5da94845158f0031c08e8.html">NN</a></li><li class="navelem"><a class="el" href="dir_17aeddf785065efc95337b880bac512b.html">Include</a></li><li class="navelem"><a class="el" href="arm__nnsupportfunctions_8h.html">arm_nnsupportfunctions.h</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:32 for CMSIS-NN by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:20:50 for CMSIS-NN Version 1.2.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 |