diff options
Diffstat (limited to 'docs/DSP/html/group__Max.html')
| -rw-r--r-- | docs/DSP/html/group__Max.html | 86 |
1 files changed, 42 insertions, 44 deletions
diff --git a/docs/DSP/html/group__Max.html b/docs/DSP/html/group__Max.html index 2a15c32..c80955c 100644 --- a/docs/DSP/html/group__Max.html +++ b/docs/DSP/html/group__Max.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-DSP -  <span id="projectnumber">Version 1.5.2</span> +  <span id="projectnumber">Version 1.7.0</span> </div> <div id="projectbrief">CMSIS DSP Software Library</div> </td> @@ -116,30 +116,30 @@ $(document).ready(function(){initNavTree('group__Max.html','');}); <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga5b89d1b04575aeec494f678695fb87d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#ga5b89d1b04575aeec494f678695fb87d8">arm_max_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pResult, uint32_t *pIndex)</td></tr> -<tr class="memdesc:ga5b89d1b04575aeec494f678695fb87d8"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a floating-point vector. <a href="#ga5b89d1b04575aeec494f678695fb87d8">More...</a><br/></td></tr> -<tr class="separator:ga5b89d1b04575aeec494f678695fb87d8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac132856c68f4bf2a056eaad5921c7880"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#gac132856c68f4bf2a056eaad5921c7880">arm_max_q15</a> (<a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pResult, uint32_t *pIndex)</td></tr> -<tr class="memdesc:gac132856c68f4bf2a056eaad5921c7880"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a Q15 vector. <a href="#gac132856c68f4bf2a056eaad5921c7880">More...</a><br/></td></tr> -<tr class="separator:gac132856c68f4bf2a056eaad5921c7880"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaff7cbd4e955382def06724cc4cc85795"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#gaff7cbd4e955382def06724cc4cc85795">arm_max_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pResult, uint32_t *pIndex)</td></tr> -<tr class="memdesc:gaff7cbd4e955382def06724cc4cc85795"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a Q31 vector. <a href="#gaff7cbd4e955382def06724cc4cc85795">More...</a><br/></td></tr> -<tr class="separator:gaff7cbd4e955382def06724cc4cc85795"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6afd64d381b5c232de59163ebfe71e35"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#ga6afd64d381b5c232de59163ebfe71e35">arm_max_q7</a> (<a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pResult, uint32_t *pIndex)</td></tr> -<tr class="memdesc:ga6afd64d381b5c232de59163ebfe71e35"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a Q7 vector. <a href="#ga6afd64d381b5c232de59163ebfe71e35">More...</a><br/></td></tr> -<tr class="separator:ga6afd64d381b5c232de59163ebfe71e35"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad1eabd31544fe59c414d9ce5bd0cc151"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#gad1eabd31544fe59c414d9ce5bd0cc151">arm_max_f32</a> (const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pResult, uint32_t *pIndex)</td></tr> +<tr class="memdesc:gad1eabd31544fe59c414d9ce5bd0cc151"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a floating-point vector. <a href="#gad1eabd31544fe59c414d9ce5bd0cc151">More...</a><br/></td></tr> +<tr class="separator:gad1eabd31544fe59c414d9ce5bd0cc151"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaea9ba2039faeca04b034989a2a2a9e36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#gaea9ba2039faeca04b034989a2a2a9e36">arm_max_q15</a> (const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> *pResult, uint32_t *pIndex)</td></tr> +<tr class="memdesc:gaea9ba2039faeca04b034989a2a2a9e36"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a Q15 vector. <a href="#gaea9ba2039faeca04b034989a2a2a9e36">More...</a><br/></td></tr> +<tr class="separator:gaea9ba2039faeca04b034989a2a2a9e36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga74015f9e9852c710a981c5b488417298"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#ga74015f9e9852c710a981c5b488417298">arm_max_q31</a> (const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pResult, uint32_t *pIndex)</td></tr> +<tr class="memdesc:ga74015f9e9852c710a981c5b488417298"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a Q31 vector. <a href="#ga74015f9e9852c710a981c5b488417298">More...</a><br/></td></tr> +<tr class="separator:ga74015f9e9852c710a981c5b488417298"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga504abf036854dc0c4a43bd9a27827863"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Max.html#ga504abf036854dc0c4a43bd9a27827863">arm_max_q7</a> (const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pSrc, uint32_t <a class="el" href="arm__variance__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>, <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> *pResult, uint32_t *pIndex)</td></tr> +<tr class="memdesc:ga504abf036854dc0c4a43bd9a27827863"><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of a Q7 vector. <a href="#ga504abf036854dc0c4a43bd9a27827863">More...</a><br/></td></tr> +<tr class="separator:ga504abf036854dc0c4a43bd9a27827863"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Computes the maximum value of an array of data. The function returns both the maximum value and its position within the array. There are separate functions for floating-point, Q31, Q15, and Q7 data types. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga5b89d1b04575aeec494f678695fb87d8"></a> +<a class="anchor" id="gad1eabd31544fe59c414d9ce5bd0cc151"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_max_f32 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -169,27 +169,25 @@ Functions</h2></td></tr> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>maximum value returned here </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of maximum value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>maximum value returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pIndex</td><td>index of maximum value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> - -<p>Referenced by <a class="el" href="arm__class__marks__example__f32_8c.html#a196718f834091385d38586a0ce4009dc">main()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="gac132856c68f4bf2a056eaad5921c7880"></a> +<a class="anchor" id="gaea9ba2039faeca04b034989a2a2a9e36"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_max_q15 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -219,25 +217,25 @@ Functions</h2></td></tr> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>maximum value returned here </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of maximum value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>maximum value returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pIndex</td><td>index of maximum value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="gaff7cbd4e955382def06724cc4cc85795"></a> +<a class="anchor" id="ga74015f9e9852c710a981c5b488417298"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_max_q31 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -267,25 +265,25 @@ Functions</h2></td></tr> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>maximum value returned here </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of maximum value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>maximum value returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pIndex</td><td>index of maximum value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="ga6afd64d381b5c232de59163ebfe71e35"></a> +<a class="anchor" id="ga504abf036854dc0c4a43bd9a27827863"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void arm_max_q7 </td> <td>(</td> - <td class="paramtype"><a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> + <td class="paramtype">const <a class="el" href="arm__math_8h.html#ae541b6f232c305361e9b416fc9eed263">q7_t</a> * </td> <td class="paramname"><em>pSrc</em>, </td> </tr> <tr> @@ -315,14 +313,14 @@ Functions</h2></td></tr> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to the input vector </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>length of the input vector </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pResult</td><td>maximum value returned here </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">*pIndex</td><td>index of maximum value returned here </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">pSrc</td><td>points to the input vector </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">blockSize</td><td>number of samples in input vector </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pResult</td><td>maximum value returned here </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pIndex</td><td>index of maximum value returned here </td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> @@ -331,7 +329,7 @@ Functions</h2></td></tr> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:22 for CMSIS-DSP by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:20:40 for CMSIS-DSP Version 1.7.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 |