diff options
Diffstat (limited to 'docs/DSP/html/group__inv__clarke.html')
| -rw-r--r-- | docs/DSP/html/group__inv__clarke.html | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/DSP/html/group__inv__clarke.html b/docs/DSP/html/group__inv__clarke.html index 3c79799..eb4bce9 100644 --- a/docs/DSP/html/group__inv__clarke.html +++ b/docs/DSP/html/group__inv__clarke.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,14 +116,15 @@ $(document).ready(function(){initNavTree('group__inv__clarke.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:ga945eb24e625a57c7c3be8a6e655646e3"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__clarke.html#ga945eb24e625a57c7c3be8a6e655646e3">arm_inv_clarke_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ialpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ibeta, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIa, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIb)</td></tr> -<tr class="memdesc:ga945eb24e625a57c7c3be8a6e655646e3"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point Inverse Clarke transform. <a href="#ga945eb24e625a57c7c3be8a6e655646e3">More...</a><br/></td></tr> -<tr class="separator:ga945eb24e625a57c7c3be8a6e655646e3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga50768ebd8b71e8988dbb804cc03a742d"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__clarke.html#ga50768ebd8b71e8988dbb804cc03a742d">arm_inv_clarke_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ialpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ibeta, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIa, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIb)</td></tr> -<tr class="memdesc:ga50768ebd8b71e8988dbb804cc03a742d"><td class="mdescLeft"> </td><td class="mdescRight">Inverse Clarke transform for Q31 version. <a href="#ga50768ebd8b71e8988dbb804cc03a742d">More...</a><br/></td></tr> -<tr class="separator:ga50768ebd8b71e8988dbb804cc03a742d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1a73ce96f94b2124d02426690e587197"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__clarke.html#ga1a73ce96f94b2124d02426690e587197">arm_inv_clarke_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ialpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ibeta, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIa, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIb)</td></tr> +<tr class="memdesc:ga1a73ce96f94b2124d02426690e587197"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point Inverse Clarke transform. <a href="#ga1a73ce96f94b2124d02426690e587197">More...</a><br/></td></tr> +<tr class="separator:ga1a73ce96f94b2124d02426690e587197"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3bab178431f22d13332a0dfae4390172"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__clarke.html#ga3bab178431f22d13332a0dfae4390172">arm_inv_clarke_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ialpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ibeta, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIa, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIb)</td></tr> +<tr class="memdesc:ga3bab178431f22d13332a0dfae4390172"><td class="mdescLeft"> </td><td class="mdescRight">Inverse Clarke transform for Q31 version. <a href="#ga3bab178431f22d13332a0dfae4390172">More...</a><br/></td></tr> +<tr class="separator:ga3bab178431f22d13332a0dfae4390172"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<p>end of clarke group</p> <p>Inverse Clarke transform converts the two-coordinate time invariant vector into instantaneous stator phases.</p> <p>The function operates on a single sample of data and each call to the function returns the processed output. The library provides separate functions for Q31 and floating-point data types. </p> <dl class="section user"><dt>Algorithm</dt><dd><div class="image"> @@ -132,12 +133,12 @@ Functions</h2></td></tr> where <code>pIa</code> and <code>pIb</code> are the instantaneous stator phases and <code>Ialpha</code> and <code>Ibeta</code> are the two coordinates of time invariant vector. </dd></dl> <dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Care must be taken when using the Q31 version of the Clarke transform. In particular, the overflow and saturation behavior of the accumulator used must be considered. Refer to the function specific documentation below for usage guidelines. </dd></dl> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga945eb24e625a57c7c3be8a6e655646e3"></a> +<a class="anchor" id="ga1a73ce96f94b2124d02426690e587197"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_inv_clarke_f32 </td> + <td class="memname">__STATIC_FORCEINLINE void arm_inv_clarke_f32 </td> <td>(</td> <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> </td> <td class="paramname"><em>Ialpha</em>, </td> @@ -176,15 +177,16 @@ Functions</h2></td></tr> </table> </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="ga50768ebd8b71e8988dbb804cc03a742d"></a> +<a class="anchor" id="ga3bab178431f22d13332a0dfae4390172"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_inv_clarke_q31 </td> + <td class="memname">__STATIC_FORCEINLINE void arm_inv_clarke_q31 </td> <td>(</td> <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> </td> <td class="paramname"><em>Ialpha</em>, </td> @@ -219,14 +221,12 @@ Functions</h2></td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">Ialpha</td><td>input two-phase orthogonal vector axis alpha </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">Ibeta</td><td>input two-phase orthogonal vector axis beta </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pIa</td><td>points to output three-phase coordinate <code>a</code> </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">pIb</td><td>points to output three-phase coordinate <code>b</code></td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pIb</td><td>points to output three-phase coordinate <code>b</code> </td></tr> </table> </dd> </dl> -<p><b>Scaling and Overflow Behavior:</b> </p> -<dl class="section user"><dt></dt><dd>The function is implemented using an internal 32-bit accumulator. The accumulator maintains 1.31 format by truncating lower 31 bits of the intermediate multiplication in 2.62 format. There is saturation on the subtraction, hence there is no risk of overflow. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#a15e896d0146c280e600d00f609832350">__QSUB()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 32-bit accumulator. The accumulator maintains 1.31 format by truncating lower 31 bits of the intermediate multiplication in 2.62 format. There is saturation on the subtraction, hence there is no risk of overflow. </dd></dl> </div> </div> @@ -235,7 +235,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:21 for CMSIS-DSP by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:20:39 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 |