diff options
Diffstat (limited to 'docs/DSP/html/group__inv__park.html')
| -rw-r--r-- | docs/DSP/html/group__inv__park.html | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/DSP/html/group__inv__park.html b/docs/DSP/html/group__inv__park.html index 1fe1a5e..8bde987 100644 --- a/docs/DSP/html/group__inv__park.html +++ b/docs/DSP/html/group__inv__park.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__park.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:ga7ca3a87a0954ed8c9ed5a2e6f1c64f30"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__park.html#ga7ca3a87a0954ed8c9ed5a2e6f1c64f30">arm_inv_park_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Id, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Iq, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIbeta, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> sinVal, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> cosVal)</td></tr> -<tr class="memdesc:ga7ca3a87a0954ed8c9ed5a2e6f1c64f30"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point Inverse Park transform. <a href="#ga7ca3a87a0954ed8c9ed5a2e6f1c64f30">More...</a><br/></td></tr> -<tr class="separator:ga7ca3a87a0954ed8c9ed5a2e6f1c64f30"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6e00d7320aa4a85686716af8b763e08a"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__park.html#ga6e00d7320aa4a85686716af8b763e08a">arm_inv_park_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Id, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Iq, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIbeta, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> sinVal, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> cosVal)</td></tr> -<tr class="memdesc:ga6e00d7320aa4a85686716af8b763e08a"><td class="mdescLeft"> </td><td class="mdescRight">Inverse Park transform for Q31 version. <a href="#ga6e00d7320aa4a85686716af8b763e08a">More...</a><br/></td></tr> -<tr class="separator:ga6e00d7320aa4a85686716af8b763e08a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga896b639ecd52c33d427bc7cdc8d303b2"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__park.html#ga896b639ecd52c33d427bc7cdc8d303b2">arm_inv_park_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Id, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Iq, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIbeta, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> sinVal, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> cosVal)</td></tr> +<tr class="memdesc:ga896b639ecd52c33d427bc7cdc8d303b2"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point Inverse Park transform. <a href="#ga896b639ecd52c33d427bc7cdc8d303b2">More...</a><br/></td></tr> +<tr class="separator:ga896b639ecd52c33d427bc7cdc8d303b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae7165779ef72e1f797d0c601d6d619b2"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__inv__park.html#gae7165779ef72e1f797d0c601d6d619b2">arm_inv_park_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Id, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Iq, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIbeta, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> sinVal, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> cosVal)</td></tr> +<tr class="memdesc:gae7165779ef72e1f797d0c601d6d619b2"><td class="mdescLeft"> </td><td class="mdescRight">Inverse Park transform for Q31 version. <a href="#gae7165779ef72e1f797d0c601d6d619b2">More...</a><br/></td></tr> +<tr class="separator:gae7165779ef72e1f797d0c601d6d619b2"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<p>end of park group</p> <p>Inverse Park transform converts the input flux and torque components to two-coordinate vector.</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>pIalpha</code> and <code>pIbeta</code> are the stator vector components, <code>Id</code> and <code>Iq</code> are rotor vector components and <code>cosVal</code> and <code>sinVal</code> are the cosine and sine values of theta (rotor flux position). </dd></dl> <dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Care must be taken when using the Q31 version of the Park 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="ga7ca3a87a0954ed8c9ed5a2e6f1c64f30"></a> +<a class="anchor" id="ga896b639ecd52c33d427bc7cdc8d303b2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_inv_park_f32 </td> + <td class="memname">__STATIC_FORCEINLINE void arm_inv_park_f32 </td> <td>(</td> <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> </td> <td class="paramname"><em>Id</em>, </td> @@ -190,15 +191,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="ga6e00d7320aa4a85686716af8b763e08a"></a> +<a class="anchor" id="gae7165779ef72e1f797d0c601d6d619b2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_inv_park_q31 </td> + <td class="memname">__STATIC_FORCEINLINE void arm_inv_park_q31 </td> <td>(</td> <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> </td> <td class="paramname"><em>Id</em>, </td> @@ -247,14 +249,12 @@ Functions</h2></td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pIalpha</td><td>points to output two-phase orthogonal vector axis alpha </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pIbeta</td><td>points to output two-phase orthogonal vector axis beta </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">sinVal</td><td>sine value of rotation angle theta </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">cosVal</td><td>cosine value of rotation angle theta</td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">cosVal</td><td>cosine value of rotation angle theta </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 addition, hence there is no risk of overflow. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#ab9f3cfbfb0f12975ab91ddb179160dcb">__QADD()</a>, and <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 addition, hence there is no risk of overflow. </dd></dl> </div> </div> @@ -263,7 +263,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 |